Missing examples for newer openstack versions in Shared filesystem services in charm-deployment-guide

[Sebastian Sporrer]

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:
1. The documentation needs an update for newer openstack versions. Especially missing relations for e.g. vault and the setup with mysql-innodb-cluster need to be covered imho.
2. The reference to the base.yaml needs be changed to "bundle.yaml"
- [ ] 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.dev416 on 2021-10-27 17:50:11
SHA: 155ff94e433f4ff14e296c528133870f19992628
Source: https://opendev.org/openstack/charm-deployment-guide/src/deploy-guide/source/manila-ganesha.rst
URL: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/xena/manila-ganesha.html

[Peter Matulis (petermatulis)]

I'm not sure why I confirmed this. The doc page in question is about adding shared file system services to an existing cloud. It's certainly not about setting up Vault. The page also did recently receive a thorough refresh that, among other benefits, makes it more versatile in terms of Ubuntu series and OpenStack releases. I think we're done here.

[Sebastian Sporrer (s-sporrer-dlr)]

In my opinon, this is not done, yet. The current site (yoga: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/yoga/manila-ganesha.html) is clearly for older releases and does not match deployment workflow and standard applications of current releases like xena or yoga.

1. Since you are referring to the installation via bundles, and the base bundle does not feature "base.yaml" anymore, I would still recommend to change "base.yaml" in the command at the end of the Deployment section to "bundle.yaml". (https://github.com/openstack-charmers/openstack-bundles/tree/master/stable/openstack-base) But this is just a minor issue, more in terms of convenience.

2. The main issue, that I stummbled upon, was a missing relation regarding vault:

- - manila:certificates
  - vault:certificates

3. Also the yaml-file includes relations for the outdated percona-cluster, while innodb is standard now (xena, yoga).

So I would recommend to replace these relations with

- - manila:shared-db
  - manila-mysql-router:shared-db
- - manila-mysql-router:db-router
  - mysql-innodb-cluster:db-router
- - manila-ganesha:shared-db
  - manila-ganesha-mysql-router:shared-db
- - manila-ganesha-mysql-router:db-router
  - mysql-innodb-cluster:db-router

and add the routers in the applications section:

  manila-mysql-router:
    charm: cs:mysql-router

  manila-ganesha-mysql-router:
    charm: cs:mysql-router

Conclusion:
"The page also did recently receive a thorough refresh that, among other benefits, makes it more versatile in terms of Ubuntu series and OpenStack releases."

If I understand this correct, there is no benefit for the documentation in being more versatile in terms of different OpenStack releases, because this site exists individually for multiple releases. I would prefer to get the right relations and workflow on the site of the release I selected rather than having a versatile documentation, where it does not need to be. In a documentation related to xena and meanwhile yoga, I strongly recommend to reconsider the changes I wrote above and maybe check the document for more updates according to the newer OpenStack releases. Of course, people will figure out to edit this, but it would be nice to cover all this in the installation guide right away. It will prevent users with new installations fo newer releases from struggling.

"It's certainly not about setting up Vault."

I never claimed, that this report was about setting up vault. Since vault is one of the standard applications in the base bundle, I would strongly suggest to take this into account for this newer releases and the corresponding documentation. At least for me, this part of the documentation did NOT WORK on the fly like the other parts of the deployment guide did.