diff --git a/README.rst b/README.rst index 1093cf49cf2965b1a2c6e9d29a7767a85e35a282..83af04039ae393fc7fd15f64f31f79f41aee6a0e 100644 --- a/README.rst +++ b/README.rst @@ -1,22 +1,30 @@ -OpenStack Dashboard plugin for Consortium GARR -============================================== +OpenStack Dashboard Accounting plugin +===================================== -Horizon plugin that provides extra functionality for -the Consortium GARR cloud. +Horizon plugin that provides a tab to display accounting data for projects. Installation ----------------------------------- +------------ - 1. Use pip to install the package on the server running Horizon. - 2. Copy or link the files in `garr_horizon/enabled` to `openstack_dashboard/local/enabled`. +#. Install the package on the server running Horizon:: + + $ pip install git+ssh//git@git.garr.it/cloud/GUI/dashboard.git + +#. Copy or link the files in `garr_horizon/enabled` to `openstack_dashboard/local/enabled`. This step will cause the Horizon service to pick up the garr plugin when it starts. - 3. Add extra settings variables to `local_settings.py`: `DATABASES`, `HASHING_ALGORITHM`, - `KEYSTONE_USER_PASS`. Check *Features* for more details. +#. Add extra settings variables to `local_settings.py`:: + + `DATABASES` + `HASHING_ALGORITHM` + `KEYSTONE_USER_PASS`. + + Check *Features* for more details. Features -------------------------- +--------- -**User CRUD** +User CRUD +......... The plugin brovides CRUD operations on GARR users, using the same UI, as the ones for Keystone users. @@ -41,9 +49,10 @@ The following variables need to be added to `local_settings.py` in order to enab For the `HASHING_ALGORITHM` the following values can be used: `pbkdf2_sha256`, `pbkdf2_sha1`, `sha1`, `md5`. -**Keystone User Creation** +Keystone User Creation +...................... -GARR Users can be automatically created in Keystone by using the +Cloud users can be automatically created in Keystone by using the `Create Keystone User` action or by customizing some of the fields, when using `Create Custom Keystone User` action.