Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation changes #1402

Merged
merged 1 commit into from
Jul 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 26 additions & 28 deletions docs/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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"
}
```

Expand Down Expand Up @@ -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.
12 changes: 6 additions & 6 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<table>.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/<table>.json`) then running this step
again or the `acl-config` bin script is required.

### Organization Settings

Expand Down
2 changes: 1 addition & 1 deletion docs/install-rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/install-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/logo-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion docs/module-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

14 changes: 7 additions & 7 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand All @@ -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
Expand Down Expand Up @@ -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:

Expand All @@ -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.
6 changes: 3 additions & 3 deletions docs/nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down
4 changes: 2 additions & 2 deletions docs/simpleSAMLphp-ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand All @@ -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',
Expand Down