Skip to content

Commit

Permalink
Minor changes in demo and installation docs (#92)
Browse files Browse the repository at this point in the history
Minor changes in `demo` and `installation` docs

Description
Update installation.rst and demo.rst docs
Resolves: #85

Reviewed-by: Anton Sidelnikov <None>
  • Loading branch information
lego963 authored Jun 20, 2022
1 parent a7ba0b7 commit 60e9d0f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
14 changes: 7 additions & 7 deletions doc/source/examples/demo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ perform invoke Terraform to query image_id for the image by name.

.. code-block:: console
wget https://github.com/opentelekomcloud/vault-plugin-secrets-openstack/releases/download/v1.0.2/vault-plugin-secrets-openstack_1.0.2_linux_amd64.tar.gz
tar xvf vault-plugin-secrets-openstack_1.0.2_linux_arm64.tar.gz -C /opt/vault/plugins
$ wget https://github.com/opentelekomcloud/vault-plugin-secrets-openstack/releases/download/v1.1.2/vault-plugin-secrets-openstack_1.1.2_linux_amd64.tar.gz
$ tar xvf vault-plugin-secrets-openstack_1.1.2_linux_amd64.tar.gz -C /opt/vault/plugins
- Register the plugin

.. code-block::
vault secrets enable -path="openstack" -plugin-name="vault-plugin-secrets-openstack" plugin
$ vault secrets enable -path="openstack" -plugin-name="vault-plugin-secrets-openstack" plugin
- Register password policy

Expand All @@ -46,20 +46,20 @@ perform invoke Terraform to query image_id for the image by name.
.. code-block:: console
vault write sys/policies/password/os-policy policy=@os_policy.hcl
$ vault write sys/policies/password/os-policy policy=@os_policy.hcl
- Configure cloud root account

.. code-block::
vault write openstack/cloud/demo auth_url=https://<AUTH_URL> username=<USER> password=<PASSWORD> user_domain_name=<USER_DOMAIN_NAME> password_policy=os-policy
$ vault write openstack/cloud/demo auth_url=https://<AUTH_URL> username=<USER> password=<PASSWORD> user_domain_name=<USER_DOMAIN_NAME> password_policy=os-policy
- Configure root token role

.. code-block:: console
vault write /openstack/role/root_token cloud=demo project_name=<PROJECT_NAME> domain_name=<DOMAIN_NAME> root=true
$ vault write /openstack/role/root_token cloud=demo project_name=<PROJECT_NAME> domain_name=<DOMAIN_NAME> root=true
- Prepare Terraform configuration

Expand All @@ -79,4 +79,4 @@ perform invoke Terraform to query image_id for the image by name.

.. code-block:: console
terraform apply
$ terraform apply
11 changes: 9 additions & 2 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ the repository or it can be built from sources.

.. code-block:: console
$ wget https://github.com/opentelekomcloud/vault-plugin-secrets-openstack/releases/download/v1.0.1/vault-plugin-secrets-openstack_1.0.1_linux_arm64.tar.gz
$ tar xvf vault-plugin-secrets-openstack_1.0.1_linux_arm64.tar.gz -C /etc/vault/plugins
$ wget https://github.com/opentelekomcloud/vault-plugin-secrets-openstack/releases/download/v1.0.1/vault-plugin-secrets-openstack_1.1.2_linux_arm64.tar.gz
$ tar xvf vault-plugin-secrets-openstack_1.1.2_linux_amd64.tar.gz -C /etc/vault/plugins
Once the plugin is unpacked into the location expected by Vault the server
should be restarted.
Expand All @@ -25,6 +25,13 @@ should be restarted.
After that it is possible to register the plugin and proceed with the
configuration.

.. code-block:: console
$ export SHA256=$(shasum -a 256 "/etc/vault/plugins/vault-plugin-secrets-openstack" | cut -d' ' -f1)
$ vault plugin register -sha256="${SHA256}" secret vault-plugin-secrets-openstack
Now we need to enable the plugin.

.. code-block:: console
$ vault secrets enable \
Expand Down

0 comments on commit 60e9d0f

Please sign in to comment.