Skip to content

Commit

Permalink
[chore] Minor docs tidy.
Browse files Browse the repository at this point in the history
  • Loading branch information
javacruft committed Jul 25, 2022
1 parent 2620b0a commit b3f19fd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Create and activate a virtualenv with the development requirements:
Get familiarise with [Charmed Operator Framework](https://juju.is/docs/sdk)
and [Sunbeam documentation](sunbeam-docs).

nova-k8s charm uses the ops_sunbeam library and extends
nova-k8s charm uses the ops\_sunbeam library and extends
OSBaseOperatorAPICharm from the library.

nova-k8s charm consumes shared-db relation to connect to database,
Expand Down Expand Up @@ -50,9 +50,7 @@ run:

To deploy the local test instance:

tox -e build
juju add-model nova
juju deploy ./nova-k8s_ubuntu-20.04-amd64.charm --resource nova-api-image=kolla/ubuntu-binary-nova-api:xena --resource nova-scheduler-image=kolla/ubuntu-binary-nova-scheduler:xena nova-conductor-image=kolla/ubuntu-binary-nova-condcutor:xena
juju deploy ./nova-k8s_ubuntu-20.04-amd64.charm --trust --resource nova-api-image=kolla/ubuntu-binary-nova-api:xena --resource nova-scheduler-image=kolla/ubuntu-binary-nova-scheduler:xena nova-conductor-image=kolla/ubuntu-binary-nova-condcutor:xena

<!-- LINKS -->

Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Description

The nova-k8s is an operator to manage the nova control services
on a kubernetes based environment.
nova-k8s is an operator to manage the Nova API, Conductor and Scheduler
services on a Kubernetes based environment.

## Usage

Expand All @@ -13,8 +13,8 @@ nova-k8s is deployed using below command:

juju deploy nova-k8s nova --trust

Now connect the nova application to an existing database,
amqp and keystone identity.
Now connect the nova operator to existing database,
messaging and keystone identity operators:

juju relate mysql:database nova:shared-db
juju relate rabbitmq:amqp nova:amqp
Expand All @@ -38,15 +38,16 @@ deployed then see file `actions.yaml`.

nova-k8s requires the following relations:

`shared-db`: To connect to the database
`amqp`: To connect to rabbitmq
`identity-service`: To register endpoints in keystone
`shared-db`: To connect to MySQL
`amqp`: To connect to RabbitMQ
`identity-service`: To register endpoints in Keystone
`ingress-internal`: To expose service on underlying internal network
`ingress-public`: To expose service on public network

## OCI Images

The charm by default uses following images:

`docker.io/kolla/ubuntu-binary-nova-api:xena`
`docker.io/kolla/ubuntu-binary-nova-scheduler:xena`
`docker.io/kolla/ubuntu-binary-nova-conductor:xena`
Expand Down

0 comments on commit b3f19fd

Please sign in to comment.