Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add project documentation contents to be displayed on RTD #210

Merged
merged 13 commits into from
Jan 11, 2024
14 changes: 8 additions & 6 deletions docs/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,16 @@ Verify Access
-------------
To use **COU** you need to have access to a `Charmed OpenStack`_ cloud, which is deployed
using `Juju`_. **COU** uses Juju credentials to access the OpenStack cloud, so accessing
the cloud with Juju is mandatory. Cloud access verification can be done by simply
calling the juju status command.
the cloud with Juju is mandatory.

**COU** requires at minimum *write* permission to the target model (see
`User access levels`_ for more information). To verify your current
user's model-scoped access level, simply calling the following Juju command and look for
your OpenStack model.
aieri marked this conversation as resolved.
Show resolved Hide resolved

.. code:: bash

juju status --model <name-of-your-openstack-model>


**COU** requires at minimum `write` permission to the target model.
juju models

Installation
------------
Expand All @@ -27,4 +28,5 @@ Install the **COU** snap from the `snap store`_:
.. LINKS
.. _Charmed OpenStack: https://ubuntu.com/openstack/docs
.. _Juju: https://juju.is/docs/juju
.. _User access levels: https://juju.is/docs/juju/user-permissions
.. _snap store: https://snapcraft.io/
1 change: 1 addition & 0 deletions docs/how-to/different-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ configuration files.

$ JUJU_DATA=./my-remote-cloud-juju-data cou plan


.. LINKS
.. _python-libjuju: https://github.com/juju/python-libjuju
.. _Juju environment variables: https://juju.is/docs/juju/environment-variables#heading--jujudata
Expand Down