openstack/sunbeam-charms
Code Issues Proposed changes

[chore] Minor docs tidy.

Browse Source
This commit is contained in:
James Page 2022-07-25 10:40:43 +01:00
parent 035ee8bcc7
commit b97e89838d
2 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
charms/keystone-k8s/CONTRIBUTING.md
View File

@ -13,7 +13,7 @@ Create and activate a virtualenv with the development requirements:
Get familiarise with [Charmed Operator Framework](https://juju.is/docs/sdk) Get familiarise with [Charmed Operator Framework](https://juju.is/docs/sdk)
and [Sunbeam documentation](sunbeam-docs). and [Sunbeam documentation](sunbeam-docs).
keystone-k8s charm uses the ops_sunbeam library and extends keystone-k8s charm uses the ops\_sunbeam library and extends
OSBaseOperatorAPICharm from the library. OSBaseOperatorAPICharm from the library.
The charm provides identity-service and identity-credentials relations The charm provides identity-service and identity-credentials relations
@ -52,9 +52,7 @@ run:
To deploy the local test instance: To deploy the local test instance:
tox -e build juju deploy ./keystone-k8s_ubuntu-20.04-amd64.charm --trust --resource keystone-image=kolla/ubuntu-binary-keystone:xena
juju add-model keystone
juju deploy ./keystone-k8s_ubuntu-20.04-amd64.charm --resource keystone-image=kolla/ubuntu-binary-keystone:xena
<!-- LINKS --> <!-- LINKS -->

9
charms/keystone-k8s/README.md
View File

@ -2,8 +2,8 @@
## Description ## Description
The keystone-k8s is an operator to manage the keystone identity service keystone-k8s is an operator to manage the Keystone identity service
on a kubernetes based environment. on a Kubernetes based environment.
## Usage ## Usage
@ -13,9 +13,8 @@ keystone-k8s is deployed using below command:
juju deploy keystone-k8s keystone --trust juju deploy keystone-k8s keystone --trust
Now connect the keystone application to an existing database. Now connect the keystone operator to an existing database.
juju deploy sunbeam-mysql-k8s mysql
juju relate mysql:database keystone:shared-db juju relate mysql:database keystone:shared-db
### Configuration ### Configuration
@ -77,7 +76,7 @@ The charm by default uses `docker.io/kolla/ubuntu-binary-keystone:xena` image.
## Contributing ## Contributing
Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines
on enhancements to this charm following best practice guidelines, and on enhancements to this charm following best practice guidelines, and
[CONTRIBUTING.md](contributors-guide) for developer guidance. [CONTRIBUTING.md](contributors-guide) for developer guidance.