From cd84c20fdbfad620b137e108004f47993cafef7a Mon Sep 17 00:00:00 2001 From: "Jeffrey T. Palmer" Date: Tue, 28 Jul 2020 17:48:31 -0400 Subject: [PATCH] Minor documentation changes --- docs/cloud.md | 54 ++++++++++++++++++-------------------- docs/configuration.md | 12 ++++----- docs/install-rpm.md | 2 +- docs/install-source.md | 2 +- docs/logo-image.md | 2 +- docs/module-assets.md | 1 - docs/modules.md | 14 +++++----- docs/nginx.md | 6 ++--- docs/simpleSAMLphp-ldap.md | 4 +-- 9 files changed, 47 insertions(+), 50 deletions(-) diff --git a/docs/cloud.md b/docs/cloud.md index 8bd32e93e4..98161ce462 100644 --- a/docs/cloud.md +++ b/docs/cloud.md @@ -46,7 +46,6 @@ The Cloud realm in Open XDMoD tracks events that occur in cloud infrastructure s - Submission Venue - The venue that a job or cloud instance was initiated from. - ## Getting cloud metrics data XDMoD provides the ability to read data from a predefined infrastructure-agnostic file format containing cloud system events. The schema for this file can be found in `configuration/etl/etl_schemas.d/cloud/event.schema.json`. For OpenStack based systems we also support data ingest using the OpenStack API and a [patch](https://github.com/ubccr/openstack-api-reporting-patch) to create cloud event logs for direct ingestion into XDMoD. @@ -68,32 +67,32 @@ If you choose to use the generic file format for ingesting event data each event ```json { - "node_controller": "IP address of node controller", - "public_ip": "Publically available IP address", - "account": "Account that user is logged into", - "event_type": "Type of event", - "event_time": "Time that event happened", - "instance_type": { - "name": "Name of VM", - "cpu": "Number of CPU's the instance has", - "memory": "Amount of memory the instance has", - "disk": "Amount of storage space in GB this instance has", - "networkInterfaces": "Number of network interfaces" - }, - "image_type": "Name of the type of image this instance uses", - "instance_id": "ID for the VM instance", - "record_type": "Type of record from list in modw_cloud.record_type table", - "block_devices": [{ - "account": "Account that the storage device belongs to", - "attach_time": "Time that the storage device was attached to this instance", - "backing": "type of storage used for this block device, either ebs or instance-store", - "create_time": "Time the storage device was created", - "user": "User that the storage device was created by", - "id": "ID of the storage volume", - "size": "Size in GB of the storage volume" - }], - "private_ip": "Private IP address used by the instance", - "root_type": "Type of storage initial storage volume is, either ebs or instance-store" + "node_controller": "IP address of node controller", + "public_ip": "Publically available IP address", + "account": "Account that user is logged into", + "event_type": "Type of event", + "event_time": "Time that event happened", + "instance_type": { + "name": "Name of VM", + "cpu": "Number of CPU's the instance has", + "memory": "Amount of memory the instance has", + "disk": "Amount of storage space in GB this instance has", + "networkInterfaces": "Number of network interfaces" + }, + "image_type": "Name of the type of image this instance uses", + "instance_id": "ID for the VM instance", + "record_type": "Type of record from list in modw_cloud.record_type table", + "block_devices": [{ + "account": "Account that the storage device belongs to", + "attach_time": "Time that the storage device was attached to this instance", + "backing": "type of storage used for this block device, either ebs or instance-store", + "create_time": "Time the storage device was created", + "user": "User that the storage device was created by", + "id": "ID of the storage volume", + "size": "Size in GB of the storage volume" + }], + "private_ip": "Private IP address used by the instance", + "root_type": "Type of storage initial storage volume is, either ebs or instance-store" } ``` @@ -191,6 +190,5 @@ Cloud resources are added by using the xdmod-setup command. 6. Run the following command from the command line to load data from resources.json file into the database: `php /usr/share/xdmod/tools/etl/etl_overseer.php -p ingest-resources` - ### Ingesting cloud event data Cloud data is shredded and ingested using the [`xdmod-shredder`](shredder.md) and [`xdmod-ingestor`](ingestor.md) commands. Please see their respective guides for further information. diff --git a/docs/configuration.md b/docs/configuration.md index 86a37955b3..817535bdff 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -46,15 +46,15 @@ XDMoD is installed you must create the databases manually. Likewise, if you don't want to use this process and would prefer to manually create the databases, see the [Database Guide](databases.html). -#### Acl Database Setup / Population +#### ACL Database Setup / Population -This step will run immediately after you have setup the database that XDMoD will +This step will run immediately after you have set up the database that Open XDMoD will be using and does not require any additional input. It is responsible for creating -and populating the tables required by the Acl framework. +and populating the tables required by the ACL framework. -If your XDMoD Installation requires modifications to the acl tables -(etc/etl/etl_tables.d/acls/xdmod/.json) then running this step again or -the `acl-config` bin script is required. +If your Open XDMoD Installation requires modifications to the ACL tables +(`/etc/xdmod/etl/etl_tables.d/acls/
.json`) then running this step +again or the `acl-config` bin script is required. ### Organization Settings diff --git a/docs/install-rpm.md b/docs/install-rpm.md index 15fe34a623..c7bf02b869 100644 --- a/docs/install-rpm.md +++ b/docs/install-rpm.md @@ -67,7 +67,7 @@ See the [Ingestor Guide](ingestor.html) for more details. Reload Apache ------------- - # service httpd reload + # systemctl reload httpd.service Now you should be able to view the Open XDMoD portal at the URL used during the configuration process. diff --git a/docs/install-source.md b/docs/install-source.md index 311d8d62d6..e8a06a32f6 100644 --- a/docs/install-source.md +++ b/docs/install-source.md @@ -126,7 +126,7 @@ See the [Ingestor Guide](ingestor.html) for more details. Restart Apache -------------- - # /etc/init.d/apache2 restart + # systemctl restart httpd.service This command may be different depending on your operating system. diff --git a/docs/logo-image.md b/docs/logo-image.md index 8130fe18de..00c06fa6a9 100644 --- a/docs/logo-image.md +++ b/docs/logo-image.md @@ -3,7 +3,7 @@ title: Logo Image --- You can add an image to the Open XDMoD header. The image will appear to -the left of the "Sign Up" button. The image can be specified during the +the left of the "About" button. The image can be specified during the setup process using the `xdmod-setup` command or manually added to the `portal_settings.ini` configuration file. The image should have a maximum height of 32 pixels. diff --git a/docs/module-assets.md b/docs/module-assets.md index fa6a6c2e2b..6dd17ad429 100644 --- a/docs/module-assets.md +++ b/docs/module-assets.md @@ -48,4 +48,3 @@ And the following files in the internal dashboard: - `html/gui/js/modules/example/ExamplePanel.js` - `html/internal_dashboard/css/example.css` - `html/gui/css/example.css` - diff --git a/docs/modules.md b/docs/modules.md index bc3435a0b7..72f764d119 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -4,12 +4,12 @@ title: Modules Rest End Points --------------- -Module's may specify custom rest end points that provide information and services both for its own use as well as that of other modules, XDMoD and or external services. -XDMoD makes use of [Silex](http://silex.sensiolabs.org/) to provide its REST services. This will need to be taken into consideration by modules wishing to provide custom +Module's may specify custom rest end points that provide information and services both for its own use as well as that of other modules, Open XDMoD and or external services. +Open XDMoD makes use of [Silex](http://silex.sensiolabs.org/) to provide its REST services. This will need to be taken into consideration by modules wishing to provide custom rest end points. ### Getting Started -To get started providing REST end points within XDMoD a module should make sure that they have the following directory / file structure in place: +To get started providing REST end points within Open XDMoD a module should make sure that they have the following directory / file structure in place: - [module_home] - classes/ @@ -22,7 +22,7 @@ To get started providing REST end points within XDMoD a module should make sure Once the directory structure is in place go ahead and create the controller provider php file, we'll start there first. #### [some_controller_provider].php -This file should contain a class that extends `\Rest\Controllers\BaseControllerProvider` ( which in turn implements Silex's `ControllerProviderInterface`), this abstract class provides a number of helpful methods for interacting with XDMoD such as determining if a user is authenticated and / or authorized, retrieving the XDUser object for a logged in user and retrieving typed parameters from a request. This class also provides some default implementations for ControllerProviderInterface's less frequently used methods. Easing the amount of boilerplate that module writers are responsible for. These functions can be over written if you wish to utilize them, but it is not required, in fact the only method that is required is the `setupRoutes` function. +This file should contain a class that extends `\Rest\Controllers\BaseControllerProvider` ( which in turn implements Silex's `ControllerProviderInterface`), this abstract class provides a number of helpful methods for interacting with Open XDMoD such as determining if a user is authenticated and / or authorized, retrieving the Open XDUser object for a logged in user and retrieving typed parameters from a request. This class also provides some default implementations for ControllerProviderInterface's less frequently used methods. Easing the amount of boilerplate that module writers are responsible for. These functions can be over written if you wish to utilize them, but it is not required, in fact the only method that is required is the `setupRoutes` function. A basic implementation that sets up one route might look something like: ```php @@ -63,10 +63,10 @@ There are two things to note in this example implementation: The function signature is important for obvious reasons while the `$app->json` helper method returns a `\Symfony\Component\HttpFoundation\JsonResponse` which is what Silex will expect that all routes return. -With our code in place we now turn our attention to integrating it with the XDMoD REST stack. +With our code in place we now turn our attention to integrating it with the Open XDMoD REST stack. ### Integration -In order to integrate a module's rest end points into XDMoD a configuration file will need to be provided by the module creator. +In order to integrate a module's rest end points into Open XDMoD a configuration file will need to be provided by the module creator. As mentioned in the previous section this file should reside at: @@ -85,6 +85,6 @@ The file should be in the form: - route_prefix: the string fragment which will provide a unique path from which all of this module's end points will be served. - php_controller_provider: The fully qualified PHP class name of the Silex Controller Provider that will handle requests to the route_prefix. -### End Point Loading Order* +### End Point Loading Order Please note that end point configuration files are loaded in the order they are read from the file system. In most cases this means that they are loaded, and read, in alphabetical order. diff --git a/docs/nginx.md b/docs/nginx.md index f82897b770..e32e3d5b5c 100644 --- a/docs/nginx.md +++ b/docs/nginx.md @@ -2,9 +2,9 @@ title: nginx --- -***This web server is not currently supported*** -***While we have some instances running nginx it has not been fully vetted at this time*** -***If you have updates please share, but there will be limited help if you use nginx at this time*** +***This web server is not currently supported.*** +***While we have some instances running nginx it has not been fully vetted at this time.*** +***If you have updates please share, but there will be limited help if you use nginx at this time.*** The following assumes you have a JSON format setup for logging. To do that add the following to your `/etc/nginx.conf`: diff --git a/docs/simpleSAMLphp-ldap.md b/docs/simpleSAMLphp-ldap.md index ad6358f015..97cb5414aa 100644 --- a/docs/simpleSAMLphp-ldap.md +++ b/docs/simpleSAMLphp-ldap.md @@ -4,7 +4,7 @@ title: Setting up XDMoD for LDAP Authentication For XDMoD to authenticate against LDAP XDMoD has to be set up as an IDP. -*Note: For this example we are going to use the [ForumSystems Online LDAP Test Server][forumsys-ldap] You will need to change settings to your ldap as appropriate* +*Note: For this example we are going to use the [ForumSystems Online LDAP Test Server][forumsys-ldap] You will need to change settings to your LDAP as appropriate* Make sure you have read and setup [OpenXDMoD for SimpleSAML](simpleSAMLphp.html). More information on [SimpleSAMLphp LDAP][ssp-ldap]. @@ -30,7 +30,7 @@ $config = array( 40 => array( 'class' => 'core:AttributeMap', /* - * These will need to map to the fields you have in your ldap + * These will need to map to the fields you have in your LDAP */ 'mail' => 'email_address', 'givenName' => 'first_name',