Added access rules documentation

docs/cloud/pouta/application-credentials.md

@@ -1,12 +1,14 @@
 # Application credentials
 
-Application credentials allow you to interact with Pouta via the [OpenStack command-line tools](command-line-tools.md) or directly via the API, by allowing you to create a **role specific** and **time limited** _TOKEN_ that can be revoked at any time. The most immediate advantage is that you no longer need to use or write your CSC password while using Pouta's API.
+Application credentials allow you to interact with Pouta via the [OpenStack command-line tools](command-line-tools.md) or directly via the API, by allowing you to create, for a given **project**, a **role specific** and **time limited** _TOKEN_ that can be revoked at any time. The most immediate advantage is that you no longer need to use or write your CSC password while using Pouta's API.
+
+* It will allow you access only to a given **project**.
 
 * **Role specific** means that the credentials can be created with limited permissions. You can create credentials that are only allowed to get data of your project, but not modify it. You can also create credentials that can only modify a specific resource. It is also possible to create credentials that can do everything that you can.
 
 * **Time limited** means that the credentials can have a much shorter life than the password of the account that created it. This is useful to limit the repercussion of a credential leak.
 
-* Other advantages are that credentials can be revoked at any time, and that you cannot change or obtain the password if you have only the application credential that created it.
+* Other advantages are that credentials can be revoked at any time from Poutas's web interface, and that you cannot change or obtain the password if you have only the application credential that created it.
 
 !!! info "Application credentials are linked to the personal account"
 
@@ -18,7 +20,7 @@ In general Application credentials give the power and flexibility to allow a saf
 
 1. Go to [Pouta's web-interface](https://pouta.csc.fi/).
 2. Choose which project you want to use. (You will only see the projects that have cPouta activated in [my.csc.fi](https://my.csc.fi).)
-3. Go to `Identitiy` -> `Application Credentials`.
+3. Go to `Identity` -> `Application Credentials`.
 4. Press `Create Application Credential`. A dialog will open.
 
     ![Create Application Credential cPouta](../../img/create-application-credential-cpouta.png)
@@ -30,86 +32,129 @@ credentials `Testing application credentials $TODAYS_DATE`.
 service will create a secret for you, this is probably the preferred method.
 7. It is a good idea to put an `expiration date` especially if you are testing the credentials only
 for today.
-8. There are four roles in cPouta, `member`, `heat_stack_owner`, `object_store_user` and `creator`. Usually you want to use the `member` role. You can find
-out more in the [Using roles sections](#using-roles).
-9. The `Unrestricted (dangerous)` check-box will allow your application credentials to
-create new application credentials. You should never give an application or automation any credentials that have this permission.
-10.  Once you have created the application credentials you can either download the credentials as a
-file that you can source, a YAML file that can be used directly by the CLI, or alternatively add the secret to your secret manager. This is the **first and last time** that you will be able to get access to this secret. If you lose it, you will need to revoke it and create a new one.
 
-    If you downloaded the `openrc file` you will get a file that contains something like this:
+    !!! warning "Temporary Unavailability of Role Restrictions for Application Credentials"
+        The usage of role restrictions for Application Credentials is temporarily unavailable.
 
-    ```bash
-    #!/usr/bin/env bash
+8. <del>There are four roles in cPouta, `member`, `heat_stack_owner`, `object_store_user` and `creator`. Usually you want to use the `member` role:</del>
 
-    export OS_AUTH_TYPE=v3applicationcredential
-    export OS_AUTH_URL=https://pouta.csc.fi:5001/v3
-    export OS_IDENTITY_API_VERSION=3
-    export OS_REGION_NAME="regionOne" # Depends if you are using cPouta or ePouta
-    export OS_INTERFACE=public
-    export OS_APPLICATION_CREDENTIAL_ID=xxxxxxxxxxxxxxxxxxxxxx
-    export OS_APPLICATION_CREDENTIAL_SECRET=xxxxxxxxxxxxxxxxxxx
-    ```
+    * <del> `member` role is the normal user role. It can make changes to the system. When you login into the web-interface you have the member role enabled.</del>
+
+    * <del> `heat_stack_owner` can operate over Heat stacks, that is create, modify and delete infrastructure. This is useful for using it in a IaC setup.</del>
+
+    * <del> `object_store_user` can operate over Allas and Objects Store.</del>
 
-    If you source that file, you can use it together with with [OpenStack command-line tools](command-line-tools.md).
+    * <del> `creator` can create secrets such as passwords, encryption keys.</del>
 
-    You can also download the `cloud.yaml` file that will look like this:
+    <del> If you are using Applications credentials in ePouta, it's slightly different. There are two roles available: `member` and `heat_stack_owner`.</del>
+
+1. `Access Rules` allows you to fine tune permissions. You can add one or more rules in either _JSON_ or _YAML_ format. Each rule needs to specify the `service`, `method` and `path`. This example allows you to list servers:
+
+    ```yaml
+    - service: compute
+      method: GET
+      path: /v2.1/servers/**
+    ```
+
+    This one allows to list volumes:
 
     ```yaml
-    # This is a clouds.yaml file, which can be used by OpenStack tools as a source
-    # of configuration on how to connect to a cloud. If this is your only cloud,
-    # just put this file in ~/.config/openstack/clouds.yaml and tools like
-    # python-openstackclient will just work with no further config. (You will need
-    # to add your password to the auth section)
-    # If you have more than one cloud account, add the cloud entry to the clouds
-    # section of your existing file and you can refer to them by name with
-    # OS_CLOUD=openstack or --os-cloud=openstack
-    clouds:
-      openstack:
+    - method: GET
+      path: /v3/*/volumes/**
+      service: volumev3
+    ```
+
+    See the [Access rules](https://docs.openstack.org/keystone/victoria/user/application_credentials.html#access-rules) upstream documentation for more examples and help. Access Rules have a lot of granularity and it can be complex to craft the exact rules you need.
+
+9. The `Unrestricted (dangerous)` check-box will allow your application credentials to
+create new application credentials. You should never give an application or automation any credentials that have this permission.
+
+## Using Application Credentials
+
+Once you have created the application credentials you can either download the credentials as a
+file that you can source, a YAML file that can be used directly by the CLI, or alternatively add the secret to your secret manager. This is the **first and last time** that you will be able to get access to this secret. If you lose it, you will need to revoke it and create a new one.
+
+If you downloaded the `openrc file` you will get a file that contains something like this:
+
+```bash
+#!/usr/bin/env bash
+
+export OS_AUTH_TYPE=v3applicationcredential
+export OS_AUTH_URL=https://pouta.csc.fi:5001/v3
+export OS_IDENTITY_API_VERSION=3
+export OS_REGION_NAME="regionOne" # Depends if you are using cPouta or ePouta
+export OS_INTERFACE=public
+export OS_APPLICATION_CREDENTIAL_ID=xxxxxxxxxxxxxxxxxxxxxx
+export OS_APPLICATION_CREDENTIAL_SECRET=xxxxxxxxxxxxxxxxxxx
+```
+
+If you source that file, you can use it together with with [OpenStack command-line tools](command-line-tools.md).
+
+You can also download the `cloud.yaml` file that will look like this:
+
+```yaml
+# This is a clouds.yaml file, which can be used by OpenStack tools as a source
+# of configuration on how to connect to a cloud. If this is your only cloud,
+# just put this file in ~/.config/openstack/clouds.yaml and tools like
+# python-openstackclient will just work with no further config. (You will need
+# to add your password to the auth section)
+# If you have more than one cloud account, add the cloud entry to the clouds
+# section of your existing file and you can refer to them by name with
+# OS_CLOUD=openstack or --os-cloud=openstack
+clouds:
+  openstack:
+
+    auth:
+
+      auth_url: https://pouta.csc.fi:5001/v3
+
+      application_credential_id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 
+      application_credential_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 
+
+
+    regions:
 
-        auth:
-
-          auth_url: https://pouta.csc.fi:5001/v3
-
-          application_credential_id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 
-          application_credential_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 
+    - regionOne # Depends if you are using cPouta or ePouta
 
-
-        regions:
-
-        - regionOne # Depends if you are using cPouta or ePouta
-
-
-        interface: "public"
-        identity_api_version: 3
-        auth_type: "v3applicationcredential"
-    ```
+
+    interface: "public"
+    identity_api_version: 3
+    auth_type: "v3applicationcredential"
+```
 
-    See the comment on the file itself on how to use it.
+See the comment on the file itself on how to use it.
 
 !!! info "Verify the credentials"
 
     It is a good idea to test that the application credentials are allowed to do what you expect them to be able to do. It is also a good idea to verify that they are **NOT** allowed to do what you expect them not to be allowed to do.
 
-## Using roles
+### Troubleshooting tips
 
-!!! warning "Temporary Unavailability of Role Restrictions for Application Credentials"
-    The usage of role restrictions for Application Credentials is temporarily unavailable.
+  * You can review the application credentials by running:
 
+    ```sh
+    $ openstack application credential list
+    ```
 
-<del> In cPouta, there are four roles available: `member`, `heat_stack_owner`, `object_store_user` and `creator`.
+    and to see single application credential:
 
+    ```sh
+    $ openstack application credential show <name>
+    ```
 
-* <del> `member` role is the normal user role. It can make changes to the system. When you login into the web-interface you have the `member` role enabled.
+    It is also possible to see the rules on the [Application Credentials](https://pouta.csc.fi/dashboard/identity/application_credentials/) page by clicking on the name of the credential.
 
-* <del> `heat_stack_owner` can operate over Heat stacks, that is create, modify and delete infrastructure. This is useful for using it in a `IaC` setup. 
+    If you add `--debug` to any command you run, you will see a much more detailed output including API calls.
 
-* <del> `object_store_user` can operate over Allas and Objects Store.
+  * Before sourcing the application credentials file, make sure you do not have any other OpenStack variables (`env | grep OS`). Otherwise you will get this failure:
 
-* <del> `creator` can create secrets such as passwords, encryption keys.
+    ```sh
+    $ openstack server list
+    Error authenticating with application credential: Application credentials cannot request a scope. (HTTP 401) (Request-ID: req-23dac9b0-5fd5-4f67-a23f-129b4ca55444)
+    ```
 
-<del> If you are using Applications credentials in ePouta, it's slightly different. There are two roles available: `member` and `heat_stack_owner`.
+    Please try again (the sourcing and the command) in a _clean_ terminal.
 
-* <del> `member` role is the normal user role. When you login into the web-interface you have the `member` role enabled.
+  * In order to fine tune the Access Rules, you can see all the API endpoints in the [API access](https://pouta.csc.fi/dashboard/project/api_access/) page in the web interface. You can also see the same information by running the command `openstack catalog list`.
 
-* <del> `heat_stack_owner` can operate over Heat stacks, that is create, modify and delete infrastructure. This is useful for using it in a `IaC` setup. 
+  * The `Object Store` API is not within `Pouta`, but `Allas`. This means that they do not support `Access Rules`. If `Access Rules` are used no access to Allas will be possible using them, no matter the configuration used.