Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
micafer committed Apr 21, 2021
1 parent c944a30 commit 396cd94
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
13 changes: 11 additions & 2 deletions doc/source/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ The available keys are:
* ``type`` indicates the service that refers the credential. The services
supported are ``InfrastructureManager``, ``VMRC``, ``OpenNebula``, ``EC2``,, ``FogBow``,
``OpenStack``, ``OCCI``, ``LibCloud``, ``Docker``, ``GCE``, ``Azure``, ``AzureClassic``,
``Kubernetes``, ``vSphere``, ``Linode`` and ``Orange``.
``Kubernetes``, ``vSphere``, ``Linode``, ``Orange`` and ``EGI``.

* ``username`` indicates the user name associated to the credential. In EC2
it refers to the *Access Key ID*. In GCE it refers to *Service Account’s Email Address*.
Expand All @@ -220,6 +220,7 @@ The available keys are:
This field is only used in the OpenStack and Orange plugins.

* ``host`` indicates the address of the access point to the cloud provider.
In case of EGI connector it indicates the site name.
This field is not used in IM, GCE, Azure, and EC2 credentials.

* ``proxy`` indicates the content of the proxy file associated to the credential.
Expand Down Expand Up @@ -247,7 +248,10 @@ The available keys are:
plugin check the documentation of the Azure python SDK:
`here <https://docs.microsoft.com/en-us/python/azure/python-sdk-azure-authenticate?view=azure-python>`_

* ``token`` indicates the OpenID token associated to the credential. This field is used in the OCCI plugin (from version 1.6.2).
* ``token`` indicates the OpenID token associated to the credential. This field is used in the EGI and OCCI plugins.

* ``vo`` indicates the VO name associated to the credential. This field is used in the EGI plugin.


OpenStack additional fields
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -341,6 +345,9 @@ So the auth line will be like that::

id = ost; type = OpenStack; host = https://ostserver:5000; username = egi.eu; tenant = openid; password = egi_aai_token_value; auth_version = 3.x_oidc_access_token; domain = project_name

From IM version 1.10.2 the EGI connector is available and you can use this kind of auth line::

id = egi; type = EGI; host = CESGA; vo = vo.access.egi.eu; token = egi_aai_token_value

Open Telekom Cloud
++++++++++++++++++
Expand Down Expand Up @@ -397,6 +404,8 @@ An example of the auth file::
id = linode; type = Linode; username = apikey
# Orange Flexible Cloud auth data
id = orange; type = Orange; username = usern; password = pass; domain = DOMAIN; region = region; tenant = tenant
# EGI auth data
id = egi; type = EGI; host = SITE_NAME; vo = vo_name; token = egi_aai_token_value

IM Server does not store the credentials used in the creation of
infrastructures. Then the user has to provide them in every call of
Expand Down
2 changes: 1 addition & 1 deletion doc/source/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Optional Packages
In newer versions (9.0 and later) the functionality has been moved `the cheroot
library<https://github.com/cherrypy/cheroot>`_ it can be installed using pip.
* `apache-libcloud <http://libcloud.apache.org/>`_ 3.0 or later is used in the
LibCloud, OpenStack and GCE connectors.
LibCloud, OpenStack, EGI and GCE connectors.
* `boto <http://boto.readthedocs.org>`_ 2.29.0 or later is used as interface to
Amazon EC2. It is available as package named ``python-boto`` in Debian based
distributions. It can also be downloaded from `boto GitHub repository <https://github.com/boto/boto>`_.
Expand Down
4 changes: 2 additions & 2 deletions doc/source/radl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ machine. The supported features are:

* ``one://<server>:<port>/<image-id>``, for OpenNebula;
* ``one://<server>:<port>/<image-name>``, for OpenNebula;
* ``ost://<server>:<port>/<image-id>``, for OpenStack;
* ``ost://<server>:<port>/<image-id>``, for OpenStack or EGI;
* ``aws://<region>/<ami-id>``, for Amazon Web Service;
* ``aws://<region>/<snapshot-id>``, for Amazon Web Service;
* ``aws://<region>/<snapshot-name>``, for Amazon Web Service;
Expand All @@ -311,7 +311,7 @@ machine. The supported features are:
* ``azr://<publisher>/<offer>/<sku>/<version>``, for Microsoft Azure;
* ``azr://[snapshots|disk]/<rgname>/<diskname>``, for Microsoft Azure;
* ``<fedcloud_endpoint_url>/<image_id>``, for FedCloud OCCI connector.
* ``appdb://<site_name>/<apc_name>?<vo_name>``, for FedCloud OCCI or OpenStack connector using AppDB info (from vers. 1.6.0 and 1.8.6).
* ``appdb://<site_name>/<apc_name>?<vo_name>``, for FedCloud OCCI, OpenStack or EGI connectors using AppDB info (from vers. 1.6.0 and 1.8.6).
* ``docker://<docker_image>``, for Docker images.
* ``fbw://<fns_server>/<image-id>``, for FogBow images.
* ``lin://linode/<image-id>``, for Linode images.
Expand Down

0 comments on commit 396cd94

Please sign in to comment.