diff --git a/README.org b/README.org index 94c33d436a7ab7830139290135fab136030f6e68..044b79624b151621bb3d6ad26f2407aed394c5d2 100644 --- a/README.org +++ b/README.org @@ -62,8 +62,11 @@ conform with the Grid5000 API models (with an 's'!) easily test and adapt them. - The configuration is read from a configuration file located in the home - directory (should be compatible with the restfully one). - It can be created with the following: + directory (should be compatible with the restfully one). It can be created + with the following: + +- When accessing the API from outside of Grid'5000 (e.g your local workstation), + you need to specify the following configuration file: #+BEGIN_EXAMPLE echo ' @@ -72,10 +75,15 @@ password: MYPASSWORD ' > ~/.python-grid5000.yaml #+END_EXAMPLE -#+BEGIN_hint -From a Grid'5000 frontend this file is optionnal. In all other cases the -configuration file is mandatory. -#+END_hint +- When accessing the API from a Grid'5000 frontend, providing the username and + password is optionnal. Nevertheless you'll need to deal with SSL verification + by specifying the path to the certificate to use: + +#+BEGIN_EXAMPLE +echo ' +verify_ssl: /etc/ssl/certs/ca-certificates.crt +' > ~/.python-grid5000.yaml +#+END_EXAMPLE - Using a virtualenv is recommended (python 3.5+ is required) diff --git a/README.rst b/README.rst index 05b83a2324ba94a921466cece350814603dcbca6..d5f94f1b8640d54a7de8e5f2bf05752a7782eb46 100644 --- a/README.rst +++ b/README.rst @@ -64,8 +64,11 @@ conform with the Grid5000 API models (with an ’s’!) easily test and adapt them. - The configuration is read from a configuration file located in the home - directory (should be compatible with the restfully one). - It can be created with the following: + directory (should be compatible with the restfully one). It can be created + with the following: + +- When accessing the API from outside of Grid’5000 (e.g your local workstation), + you need to specify the following configuration file: :: @@ -74,10 +77,15 @@ conform with the Grid5000 API models (with an ’s’!) password: MYPASSWORD ' > ~/.python-grid5000.yaml -.. hint:: +- When accessing the API from a Grid’5000 frontend, providing the username and + password is optionnal. Nevertheless you’ll need to deal with SSL verification + by specifying the path to the certificate to use: + +:: - From a Grid’5000 frontend this file is optionnal. In all other cases the - configuration file is mandatory. + echo ' + verify_ssl: /etc/ssl/certs/ca-certificates.crt + ' > ~/.python-grid5000.yaml - Using a virtualenv is recommended (python 3.5+ is required)