Vault unsealing process link doesn't actually have the process

Bug #2019267 reported by Nobuto Murata
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Charms Deployment Guide
Fix Released
Undecided
Unassigned

Bug Description

The doc has a paragraph as:
https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/install-openstack.html#vault
> Vault must now be initialised and unsealed. The vault charm will also need to be authorised to carry out certain tasks. These steps are covered in the vault charm documentation. Perform them now.

"the vault charm documentation" is linked to:
https://charmhub.io/vault

But the charmhub page nowadays doesn't reveal charm's README but only a brief description as follows.

> a tool for managing secrets
>
> Vault secures, stores, and tightly controls access to tokens, passwords, certificates, API keys, and other secrets in modern computing. Vault handles leasing, key revocation, key rolling, and auditing. Through a unified API, users can access an encrypted Key/Value store and network encryption-as-a-service, or generate AWS IAM/STS credentials, SQL/NoSQL databases, X.509 certificates, SSH credentials, and more.

I think we need either:
1. the charmhub page should reveal the whole unsealing process
or
2. the charm-guide linked to the README directly
https://github.com/openstack/charm-vault/blob/master/src/README.md#post-deployment-tasks

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [X] This doc is inaccurate in this way: ______
- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - The mailing list: https://lists.openstack.org
 - IRC: 'openstack' channel on OFTC

-----------------------------------
Release: 0.0.1.dev508 on 2023-04-25 23:57:20
SHA: 2c084a8be0316d5886f720ff861d7511aea11357
Source: https://opendev.org/openstack/charm-deployment-guide/src/deploy-guide/source/install-openstack.rst
URL: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/install-openstack.html

Revision history for this message
Corey Bryant (corey.bryant) wrote :

Hi Nobuto,

It looks like this has been fixed. Thanks for reporting it. Please let us know if you need anything else.

Corey

Changed in charm-deployment-guide:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.