Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

DPOD creates a service wiki on the fly, according to configuration changes and activity data which it collects. The process creates new wiki entries for newly created services, and updates existing entries when existing services are changed. Some of the data in the wiki comes from DataPower configuration, some from activity logs, and the rest is filled out entered by the user. Both WS-Proxy (.WSP) and Multi-Protocol Gateway (.MPGW) services are documented in the wiki.

DPOD updates the wiki by creating a custom JSON request with all the relevant data; a single JSON request contains data for a single service. The same service – With DPOD, a service is identified by the DataPower service name – hosted by . Regardless of whether multiple instances are hosted on different DataPower Gateways or on different domains will appear . As long as the DataPower service name is identical - they will display as a single service on a single wiki page, and will be updated using a single JSON request.

A REST service then receives these JSON requests and updates the wiki accordingly (todo hk: who sets this service up? Does it come with DPOD?). .This REST Service should be implemented by the user . 

There is a reference implementation the demonstrate the REST service and a portal demo - called Service Wiki.

The service wiki is based on a Drupal CMS - This is an open-source (apache license v2).

DPOD provides Reference implementation only, with no maintenance or support.

A series of configuration parameters controls where JSON requests are sent, as well as various default values for JSON fields (link to wiki parameters).

The wiki update services is CMS drupal, open-source apache licenses 2. Reference implementation only, not maintenance or support

I don’t understand how service status or transaction data is update and when, so I didn’t write about it, but we probably should (e.g. “last transaction” field)for JSON fields.

For newly created services, the process is as follows:

  1. A new service is created on a monitored device
  2. The DPOD agent polls for the monitored device at fixed intervals (configurable, see parameter at link), configurable intervals .
  3. At the next polling interval, DPOD gets will receive the new service configuration data and creates create a new JSON request .based on it
  4. This JSON request is sent to the wiki updating service, which creates a new wiki page for the service.

 

For services which were

...

changed, the process is as follows:

  1. A service configuration is changed on a monitored device
  2. At the next polling interval, DPOD gets receives the changed service configuration and compares it with the last configuration. When it notices the change it creates a new JSON request with the entire configuration data.
  3. The JSON request is sent to the wiki updating service. The service then updates the configuration fields which were changed, and skips fields which remained the same.