From 60e9d0f09104cd72d74260ee44fa5f81ec6b371a Mon Sep 17 00:00:00 2001 From: Rodion Gyrbu Date: Mon, 20 Jun 2022 18:04:35 +0300 Subject: [PATCH] Minor changes in `demo` and `installation` docs (#92) Minor changes in `demo` and `installation` docs Description Update installation.rst and demo.rst docs Resolves: #85 Reviewed-by: Anton Sidelnikov --- doc/source/examples/demo.rst | 14 +++++++------- doc/source/installation.rst | 11 +++++++++-- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/doc/source/examples/demo.rst b/doc/source/examples/demo.rst index aa8085b..8f3974f 100644 --- a/doc/source/examples/demo.rst +++ b/doc/source/examples/demo.rst @@ -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 @@ -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:// username= password= user_domain_name= password_policy=os-policy + $ vault write openstack/cloud/demo auth_url=https:// username= password= user_domain_name= password_policy=os-policy - Configure root token role .. code-block:: console - vault write /openstack/role/root_token cloud=demo project_name= domain_name= root=true + $ vault write /openstack/role/root_token cloud=demo project_name= domain_name= root=true - Prepare Terraform configuration @@ -79,4 +79,4 @@ perform invoke Terraform to query image_id for the image by name. .. code-block:: console - terraform apply + $ terraform apply diff --git a/doc/source/installation.rst b/doc/source/installation.rst index eddf462..13585bb 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -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. @@ -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 \