openstack
/
charm-guide
Code Issues Proposed changes

Fix various docs build warnings and errors 

- Update and usage of sphinx & openstackdocstheme latest version
- Introduce openstackdocstheme instead of oslosphinx
- Fix dead links tracked down by sphinx linkcheck
- Use opendev links

Change-Id: I3151e19b7a2584c6cc2436b405e9a58c43671b38
This commit is contained in:
Frank Kloeker 2019-05-03 05:14:20 +02:00 committed by Andreas Jaeger
parent ccdcae52be
commit d6cab4cb23
19 changed files with 120 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/1610.rst
View File

@ -99,9 +99,9 @@ Rewrite of neutron-api-odl and openvswitch-odl
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The neutron-api-odl and openvswitch-odl charms have both been rewritten using
the `reactive framework <https://pythonhosted.org/charms.reactive>`__ and the
`OpenStack charm layers <https://github.com/openstack?query=charm-layer>`__
and `interfaces <https://github.com/openstack?query=charm-interface>`__.
the `reactive framework <https://pypi.org/project/charms.reactive>`__ and the
`OpenStack charm layers <https://opendev.org/explore/repos?q=charm-layer>`__
and `interfaces <https://opendev.org/explore/repos?q=charm-interface>`__.
Upgrading an existing deployment which uses previous versions of these charms is
not supported.

3
doc/source/1802.rst
View File

@ -168,8 +168,7 @@ https://jujucharms.com/openstack-base
https://jujucharms.com/openstack-telemetry
https://jujucharms.com/ceph-base
https://jujucharms.com/u/openstack-charmers/ceph-base/
Deprecation Notices

4
doc/source/1808.rst
View File

@ -158,7 +158,7 @@ https://jujucharms.com/openstack-base
https://jujucharms.com/openstack-telemetry
https://jujucharms.com/ceph-base
https://jujucharms.com/u/openstack-charmers/ceph-base/
@ -205,7 +205,7 @@ The workaround is to manually set the read ACL on the glance container
.. code:: bash
swift post glance --read-acl ".r:*,.rlistings"
swift post glance --read-acl ".r:*,.rlistings"
Two, the glance-simplestreams-sync charm relies on simplestreams which is not yet glance v2 aware:

5
doc/source/1811.rst
View File

@ -174,7 +174,7 @@ https://jujucharms.com/openstack-telemetry
https://jujucharms.com/openstack-lxd
https://jujucharms.com/ceph-base
https://jujucharms.com/u/openstack-charmers/ceph-base/
Deprecation Notices
===================
@ -190,13 +190,14 @@ Glance v1 removed in Rocky, Glance v2 required
As of the Rocky OpenStack release the glance v1 API has been removed. Glance v2 is the only available API version. Two known issues from this have emerged.
One, when using swift store as a back end for glance, glance fails to set the ACLs on the swift container properly:
https://bugs.launchpad.net/glance/+bug/1789748
The workaround is to manually set the read ACL on the glance container
.. code:: bash
swift post glance --read-acl ".r:*,.rlistings"
swift post glance --read-acl ".r:*,.rlistings"
Two, the glance-simplestreams-sync charm relies on simplestreams which is not yet glance v2 aware:
https://bugs.launchpad.net/simplestreams/+bug/1790904

7
doc/source/1904.rst
View File

@ -110,7 +110,8 @@ to Nova KVM instances are now detailed in the charm deployment guide.
A common use case for this configuration is to provide direct access to a
GPGPU device within a virtual machine.
Please refer to the `charm deployment guide <https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-pci-passthrough-gpu.html>`_ for more details.
Please refer to the `app pci section in the charm deployment guide <https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-pci-passthrough-gpu.html>`_
for more details.
ceph-radosgw: multisite replication
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -156,8 +157,8 @@ For example:
Reference:
- https://launchpad.net/bugs/1817672
- https://review.openstack.org/#/c/639333
- https://review.openstack.org/#/q/topic:bug/1817672+(status:open+OR+status:merged)
- https://review.opendev.org/c/639333
- https://review.opendev.org/q/topic:bug/1817672+(status:open+OR+status:merged)
neutron-api: FWaaS v2
~~~~~~~~~~~~~~~~~~~~~

8
doc/source/author-guides/index.rst
View File

@ -14,11 +14,3 @@ have some potential pitfalls that these notes address.
:includehidden:
reactive-handlers-optimization
====================
Indices and tables
====================
* :ref:`genindex`
* :ref:`search`

2
doc/source/author-guides/reactive-handlers-optimization.rst
View File

@ -81,7 +81,7 @@ The implementation for the *interface* is typical. If you look at the
``..available`` state/flags are *continuous* from the moment the conditions for
them are met.
.. _`interfaces.juju.solutions`: https://interfaces.juju.solutions/
.. _`interfaces.juju.solutions`: https://github.com/juju-solutions/
.. _`interface-etcd`: https://github.com/juju-solutions/interface-etcd
By now you will have probably seen the issue; once the ``<name>.connected``

44
doc/source/charm-anatomy.rst
View File

@ -75,28 +75,28 @@ for use by the charm.
OpenStack Layer
~~~~~~~~~~~~~~~
The `Openstack Layer <https://github.com/openstack/charm-layer-openstack>`__
The `Openstack Layer <https://opendev.org/openstack/charm-layer-openstack>`__
provides the base OpenStack configuration options, templates, template
fragments and dependencies for authoring OpenStack Charms. Typically this layer
is used for subordinate charms. The openstack-api or openstack-principle layers
are probably more appropriate for principle charms and both of those layers
inherit this one.
This layer includes a wheelhouse to pull in `charms.openstack <https://github.com/openstack/charms.openstack>`__
This layer includes a wheelhouse to pull in `charms.openstack <https://opendev.org/openstack/charms.openstack>`__
. See `charms.openstack`_ for more details.
Openstack Principle Layer
~~~~~~~~~~~~~~~~~~~~~~~~~
The `Openstack Principle Layer <https://github.com/openstack/charm-layer-openstack-principle>`__
The `Openstack Principle Layer <https://opendev.org/openstack/charm-layer-openstack-principle>`__
provides the base layer for OpenStack charms that are intended for
use as principle (rather than subordinate)
Openstack API Layer
~~~~~~~~~~~~~~~~~~~
The `Openstack API Layer <https://github.com/openstack/charm-layer-openstack-api>`__
The `Openstack API Layer <https://opendev.org/openstack/charm-layer-openstack-api>`__
provides the base layer for OpenStack charms that are will deploy API services,
and provides all of the core functionality for:
@ -115,42 +115,42 @@ OpenStack Interfaces
Interfaces define the data exchange between each of the charms. A list of all
available interfaces is available `here <https://github.com/juju/layer-index>`__.
A list of OpenStack specific interfaces can be found `here <https://github.com/openstack?q=charm-interface>`__
A list of OpenStack specific interfaces can be found `here <https://opendev.org/openstack?q=charm-interface>`__
The interfaces a charm needs are defines in the `layers.yaml`_. Below is a list
of the typical interfaces needed by different OpenStack charm types:
**API Charm**
- `mysql-shared <https://github.com/openstack/charm-interface-mysql-shared>`__
- `rabbitmq <https://github.com/openstack/charm-interface-rabbitmq>`__
- `keystone <https://github.com/openstack/charm-interface-keystone>`__
- `mysql-shared <https://opendev.org/openstack/charm-interface-mysql-shared>`__
- `rabbitmq <https://opendev.org/openstack/charm-interface-rabbitmq>`__
- `keystone <https://opendev.org/openstack/charm-interface-keystone>`__
**Neutron SDN Plugin**
- `neutron-plugin <https://github.com/openstack/charm-interface-neutron-plugin>`__
- `service-control <https://github.com/openstack/charm-interface-service-control>`__
- `neutron-plugin <https://opendev.org/openstack/charm-interface-neutron-plugin>`__
- `service-control <https://opendev.org/openstack/charm-interface-service-control>`__
**Neutron ODL Based SDN Plugin**
- `neutron-plugin <https://github.com/openstack/charm-interface-neutron-plugin>`__
- `service-control <https://github.com/openstack/charm-interface-service-control>`__
- `ovsdb-manager <https://github.com/openstack/charm-interface-ovsdb-manager>`__
- `odl-controller-api <https://github.com/openstack/charm-interface-odl-controller-api>`__
- `neutron-plugin <https://opendev.org/openstack/charm-interface-neutron-plugin>`__
- `service-control <https://opendev.org/openstack/charm-interface-service-control>`__
- `ovsdb-manager <https://opendev.org/openstack/charm-interface-ovsdb-manager>`__
- `odl-controller-api <https://opendev.org/openstack/charm-interface-odl-controller-api>`__
**Neutron API Plugin**
- `neutron-plugin-api-subordinate <https://github.com/openstack/charm-interface-neutron-plugin-api-subordinate>`__
- `service-control <https://github.com/openstack/charm-interface-service-control>`__
- `neutron-plugin-api-subordinate <https://opendev.org/openstack/charm-interface-neutron-plugin-api-subordinate>`__
- `service-control <https://opendev.org/openstack/charm-interface-service-control>`__
.. _`charms.openstack`:
charms.openstack
----------------
The `charms.openstack <https://github.com/openstack/charms.openstack>`__ python
The `charms.openstack <https://opendev.org/openstack/charms.openstack>`__ python
module provides helpers for building layered, reactive OpenStack charms. It is
installed by the `OpenStack Layer <https://github.com/openstack/charm-layer-openstack>`_ .
installed by the `OpenStack Layer <https://opendev.org/openstack/charm-layer-openstack>`_ .
Defining the Charm
------------------
@ -253,7 +253,7 @@ Template properties from Interfaces
By default some interfaces are automatically allocated a namespace within the
template context. Those namespaces are also automatically populated with some
options directly from the interface. For example if a charm is related to
Keystone's `keystone interface <https://github.com/openstack/charm-interface-keystone>`__
Keystone's `keystone interface <https://opendev.org/openstack/charm-interface-keystone>`__
then a number of **service\_** variables are set in the
identity\_service namespace. So, charm template could contain the following to
access those variables:
@ -264,7 +264,7 @@ access those variables:
www_authenticate_uri = {{ identity_service.service_protocol }}://{{ identity_service.service_host }}:{{ identity_service.service_port }}
auth_url = {{ identity_service.auth_protocol }}://{{ identity_service.auth_host }}:{{ identity_service.auth_port }}
See the **auto\_accessors** list in `charm-interface-keystone <https://github.com/openstack/charm-interface-keystone/blob/master/requires.py>`__
See the **auto\_accessors** list in `charm-interface-keystone <https://opendev.org/openstack/charm-interface-keystone/src/master/requires.py>`__
for a complete list
However, most interface data is accessed via Adapters...
@ -274,7 +274,7 @@ Template properties from Adapters
Adapters are used to take the data from an interface and create new variables
in the template context. For example the **RabbitMQRelationAdapter** (which can
be found in the `adapters.py <https://github.com/openstack/charms.openstack/blob/master/charms_openstack/adapters.py>`__
be found in the `adapters.py <https://opendev.org/openstack/charms.openstack/src/master/charms_openstack/adapters.py>`__
from charms.openstack.) adds an **ssl\_ca\_file** variable to the amqp
namespace. This setting is really independent of the interface with rabbit but
should be consistent across the OpenStack deployment. This variable can then
@ -388,7 +388,7 @@ Sending data via an Interface
Some interfaces are used to send as well as receive data. The interface will
expose a method for sending data to a remote application if it is supported.
For example the `neutron-plugin interface <https://github.com/openstack/charm-interface-neutron-plugin>`__
For example the `neutron-plugin interface <https://opendev.org/openstack/charm-interface-neutron-plugin>`__
can be used to send configuration to the principle charm.
The handler below waits for the neutron-plugin relation with the principle to

9
doc/source/conf.py
View File

@ -32,7 +32,7 @@ from jinja2.utils import Markup
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'oslosphinx'
'openstackdocstheme'
]
todo_include_todos = True
@ -51,7 +51,7 @@ master_doc = 'index'
# General information about the project.
project = u'OpenStack Charms Guide'
copyright = Markup(u'%s, OpenStack Contributors '
copyright = (u'%s, OpenStack Contributors '
u'- use the <a href="https://git.openstack.org/cgit/'
u'openstack/charm-guide">openstack/charm-guide git repo</a> '
u'to propose changes' % datetime.date.today().year)
@ -100,7 +100,7 @@ man_pages = []
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nature'
html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -128,8 +128,7 @@ html_theme = 'nature'
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
html_last_updated_fmt = os.popen(git_cmd).read()
# html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.

2
doc/source/feature-specification.rst
View File

@ -45,5 +45,5 @@ Recommended work flow for introducing a new feature specification:
.. _published charm specs: https://specs.openstack.org/openstack/charm-specs/
.. _charm-specs source repository: https://opendev.org/openstack/charm-specs
.. _charm-specs history: https://review.opendev.org/#/q/project:openstack/charm-specs+status:merged
.. _charm-specs history: https://review.opendev.org/q/project:openstack/charm-specs+status:merged
.. _charm-specs template: https://opendev.org/openstack/charm-specs/src/branch/master/specs/template.rst

4
doc/source/how-to-contribute.rst
View File

@ -20,5 +20,5 @@ to the OpenStack Charms.
making-a-change
creating-charms
backport-policy
Gerrit Reviewable Items <https://review.openstack.org/#/q/project:%22%255Eopenstack/charm.*%22+status:open+label:Verified%252B1+NOT+label:Verified-1+NOT+label:Code-Review-1>
Gerrit All Open Items <https://review.openstack.org/#/q/project:%22%255Eopenstack/charm.*%22+status:open>
Gerrit Reviewable Items <https://review.opendev.org/q/project:%22%255Eopenstack/charm.*%22+status:open+label:Verified%252B1+NOT+label:Verified-1+NOT+label:Code-Review-1>
Gerrit All Open Items <https://review.opendev.org/q/project:%22%255Eopenstack/charm.*%22+status:open>

7
doc/source/index.rst
View File

@ -20,10 +20,3 @@ deployments with loose coupling between OpenStack services.
release-policy
release-schedule
release-notes
====================
Indices and tables
====================
* :ref:`genindex`
* :ref:`search`

6
doc/source/making-a-change.rst
View File

@ -19,7 +19,7 @@ Broadly the work flow for making a change to a charm is:
.. code:: bash
git clone https://github.com/openstack/charm-cinder
git clone https://opendev.org/openstack/charm-cinder
cd charm-cinder
git checkout -b bug/XXXXXX master
@ -61,7 +61,7 @@ Finally, submit your change for review (if they pass pep8 and unit tests!):
git review
This will push your proposed changes to Gerrit and provide you with a URL for the
review board on https://review.openstack.org/.
review board on https://review.opendev.org/.
To make amendments to your proposed change, update your local branch and then:
@ -94,7 +94,7 @@ charm-helpers style charms
In a charm-helpers style charm, **charm-helpers** is synced into the charm using
a *make* command. Inspecting the ``Makefile`` of, say, `charm-keystone
<https://github.com/openstack/charm-keystone>`_ shows:
<https://opendev.org/openstack/charm-keystone>`_ shows:
.. code:: Makefile

10
doc/source/new-api-charm.rst
View File

@ -6,8 +6,8 @@ New API Charm
The example below will walk through the creation of a basic API charm for the
Openstack `Congress <https://wiki.openstack.org/wiki/Congress>`__ service.
The charm will use prewritten Openstack `layers <https://github.com/openstack?query=charm-layer>`__
and `interfaces <https://github.com/openstack?query=charm-interface>`__. Once the charm
The charm will use prewritten Openstack `layers <https://opendev.org/explore/repos?q=charm-layer>`__
and `interfaces <https://opendev.org/explore/repos?q=charm-interface>`__. Once the charm
is written it will be composed using `charm tools <https://github.com/juju/charm-tools/>`__.
For more details of the internal of a charm see Charm Anatomy.
@ -93,10 +93,10 @@ the following contents:
.. _`Build Charm`:
.. _`Build API Charm`:
Build Charm
~~~~~~~~~~~
Build API Charm
~~~~~~~~~~~~~~~
The charm now needs to be built to pull down all the interfaces and layers the
charm depends on and rolled into the built charm which can be deployed.

6
doc/source/new-sdn-charm.rst
View File

@ -43,8 +43,8 @@ During the charm generation charm tools asks a few questions about the charm.
.. _`build_sdn_charm`:
Build Charm
===========
Build SDN Charm
===============
The charm now needs to be built to pull down all the interfaces and layers the
charm depends on and rolled into the built charm which can be deployed.
@ -75,7 +75,7 @@ During the initial install of this SDN charm, the standard charms.openstack
default installer will install the packages specified in the class
CharmName.packages, but it will not do any other configuration.
In order to update nova.conf in the nova-compute principal charm, this
virtual-token-ring subordinate charm will need to access the `neutron plugin <https://github.com/openstack/charm-interface-neutron-plugin>`__
virtual-token-ring subordinate charm will need to access the `neutron plugin <https://opendev.org/openstack/charm-interface-neutron-plugin>`__
interface, which will allow it to send configuration information to the
nova-computer principal charm for inclusion in nova.conf on the co-located
machine.

108
doc/source/openstack-charms.rst
View File

@ -15,31 +15,31 @@ OpenStack Charms
These charms have stable releases with ongoing maintenance and testing.
* `aodh <https://git.openstack.org/cgit/openstack/charm-aodh/>`_
* `barbican <https://git.openstack.org/cgit/openstack/charm-barbican/>`_
* `barbican-vault <https://git.openstack.org/cgit/openstack/charm-barbican-vault/>`_
* `ceilometer <https://git.openstack.org/cgit/openstack/charm-ceilometer/>`_
* `ceilometer-agent <https://git.openstack.org/cgit/openstack/charm-ceilometer-agent/>`_
* `cinder <https://git.openstack.org/cgit/openstack/charm-cinder/>`_
* `cinder-backup <https://git.openstack.org/cgit/openstack/charm-cinder-backup/>`_
* `cinder-ceph <https://git.openstack.org/cgit/openstack/charm-cinder-ceph/>`_
* `designate <https://git.openstack.org/cgit/openstack/charm-designate/>`_
* `glance <https://git.openstack.org/cgit/openstack/charm-glance/>`_
* `heat <https://git.openstack.org/cgit/openstack/charm-heat/>`_
* `keystone <https://git.openstack.org/cgit/openstack/charm-keystone/>`_
* `keystone-ldap <https://git.openstack.org/cgit/openstack/charm-keystone-ldap/>`_
* `neutron-api <https://git.openstack.org/cgit/openstack/charm-neutron-api/>`_
* `neutron-dynamic-routing <https://git.openstack.org/cgit/openstack/charm-neutron-dynamic-routing/>`_
* `neutron-gateway <https://git.openstack.org/cgit/openstack/charm-neutron-gateway/>`_
* `neutron-openvswitch <https://git.openstack.org/cgit/openstack/charm-neutron-openvswitch/>`_
* `nova-cell-controller <https://git.openstack.org/cgit/openstack/charm-nova-cell-controller/>`_
* `nova-cloud-controller <https://git.openstack.org/cgit/openstack/charm-nova-cloud-controller/>`_
* `nova-compute <https://git.openstack.org/cgit/openstack/charm-nova-compute/>`_
* `octavia <https://git.openstack.org/cgit/openstack/charm-octavia/>`_
* `octavia-dashboard <https://git.openstack.org/cgit/openstack/charm-octavia-dashboard/>`_
* `openstack-dashboard <https://git.openstack.org/cgit/openstack/charm-openstack-dashboard/>`_
* `swift-proxy <https://git.openstack.org/cgit/openstack/charm-swift-proxy/>`_
* `swift-storage <https://git.openstack.org/cgit/openstack/charm-swift-storage/>`_
* `aodh <https://opendev.org/openstack/charm-aodh/>`_
* `barbican <https://opendev.org/openstack/charm-barbican/>`_
* `barbican-vault <https://opendev.org/openstack/charm-barbican-vault/>`_
* `ceilometer <https://opendev.org/openstack/charm-ceilometer/>`_
* `ceilometer-agent <https://opendev.org/openstack/charm-ceilometer-agent/>`_
* `cinder <https://opendev.org/openstack/charm-cinder/>`_
* `cinder-backup <https://opendev.org/openstack/charm-cinder-backup/>`_
* `cinder-ceph <https://opendev.org/openstack/charm-cinder-ceph/>`_
* `designate <https://opendev.org/openstack/charm-designate/>`_
* `glance <https://opendev.org/openstack/charm-glance/>`_
* `heat <https://opendev.org/openstack/charm-heat/>`_
* `keystone <https://opendev.org/openstack/charm-keystone/>`_
* `keystone-ldap <https://opendev.org/openstack/charm-keystone-ldap/>`_
* `neutron-api <https://opendev.org/openstack/charm-neutron-api/>`_
* `neutron-dynamic-routing <https://opendev.org/openstack/charm-neutron-dynamic-routing/>`_
* `neutron-gateway <https://opendev.org/openstack/charm-neutron-gateway/>`_
* `neutron-openvswitch <https://opendev.org/openstack/charm-neutron-openvswitch/>`_
* `nova-cell-controller <https://opendev.org/openstack/charm-nova-cell-controller/>`_
* `nova-cloud-controller <https://opendev.org/openstack/charm-nova-cloud-controller/>`_
* `nova-compute <https://opendev.org/openstack/charm-nova-compute/>`_
* `octavia <https://opendev.org/openstack/charm-octavia/>`_
* `octavia-dashboard <https://opendev.org/openstack/charm-octavia-dashboard/>`_
* `openstack-dashboard <https://opendev.org/openstack/charm-openstack-dashboard/>`_
* `swift-proxy <https://opendev.org/openstack/charm-swift-proxy/>`_
* `swift-storage <https://opendev.org/openstack/charm-swift-storage/>`_
Other Supporting Charms
~~~~~~~~~~~~~~~~~~~~~~~
@ -47,17 +47,17 @@ Other Supporting Charms
These charms have stable releases with ongoing maintenance and testing. They're
classified differently because the payload of each is not technically an OpenStack project.
* `percona-cluster <https://git.openstack.org/cgit/openstack/charm-percona-cluster/>`_
* `rabbitmq-server <https://git.openstack.org/cgit/openstack/charm-rabbitmq-server/>`_
* `lxd <https://git.openstack.org/cgit/openstack/charm-lxd/>`_
* `ceph-osd <https://git.openstack.org/cgit/openstack/charm-ceph-osd/>`_
* `ceph-mon <https://git.openstack.org/cgit/openstack/charm-ceph-mon/>`_
* `ceph-proxy <https://git.openstack.org/cgit/openstack/charm-ceph-proxy/>`_
* `ceph-radosgw <https://git.openstack.org/cgit/openstack/charm-ceph-radosgw/>`_
* `hacluster <https://git.openstack.org/cgit/openstack/charm-hacluster/>`_
* `designate-bind <https://git.openstack.org/cgit/openstack/charm-designate-bind/>`_
* `gnocchi <https://git.openstack.org/cgit/openstack/charm-gnocchi/>`_
* `vault <https://git.openstack.org/cgit/openstack/charm-vault/>`_
* `percona-cluster <https://opendev.org/openstack/charm-percona-cluster/>`_
* `rabbitmq-server <https://opendev.org/openstack/charm-rabbitmq-server/>`_
* `lxd <https://opendev.org/openstack/charm-lxd/>`_
* `ceph-osd <https://opendev.org/openstack/charm-ceph-osd/>`_
* `ceph-mon <https://opendev.org/openstack/charm-ceph-mon/>`_
* `ceph-proxy <https://opendev.org/openstack/charm-ceph-proxy/>`_
* `ceph-radosgw <https://opendev.org/openstack/charm-ceph-radosgw/>`_
* `hacluster <https://opendev.org/openstack/charm-hacluster/>`_
* `designate-bind <https://opendev.org/openstack/charm-designate-bind/>`_
* `gnocchi <https://opendev.org/openstack/charm-gnocchi/>`_
* `vault <https://opendev.org/openstack/charm-vault/>`_
Development / Preview Charms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -66,16 +66,16 @@ These charms are either in development or are released as a beta/preview. This
is to indicate that additional validation, and further work may be necessary to
make a stable release for production use.
* `barbican-softhsm <https://git.openstack.org/cgit/openstack/charm-barbican-softhsm/>`_
* `ceph-fs <https://git.openstack.org/cgit/openstack/charm-ceph-fs/>`_
* `cinder-backup <https://git.openstack.org/cgit/openstack/charm-cinder-backup/>`_
* `barbican-softhsm <https://opendev.org/openstack/charm-barbican-softhsm/>`_
* `ceph-fs <https://opendev.org/openstack/charm-ceph-fs/>`_
* `cinder-backup <https://opendev.org/openstack/charm-cinder-backup/>`_
* `keystone-saml-mellon <https://github.com/openstack-charmers/charm-keystone-saml-mellon/>`_
* `manila <https://git.openstack.org/cgit/openstack/charm-manila/>`_
* `manila-generic <https://git.openstack.org/cgit/openstack/charm-manila-generic/>`_
* `masakari <https://git.openstack.org/cgit/openstack/charm-masakari/>`_
* `masakari-monitors <https://git.openstack.org/cgit/openstack/charm-masakari-monitors/>`_
* `pacemaker-remote <https://git.openstack.org/cgit/openstack/charm-pacemaker-remote/>`_
* `tempest <https://git.openstack.org/cgit/openstack/charm-tempest/>`_
* `manila <https://opendev.org/openstack/charm-manila/>`_
* `manila-generic <https://opendev.org/openstack/charm-manila-generic/>`_
* `masakari <https://opendev.org/openstack/charm-masakari/>`_
* `masakari-monitors <https://opendev.org/openstack/charm-masakari-monitors/>`_
* `pacemaker-remote <https://opendev.org/openstack/charm-pacemaker-remote/>`_
* `tempest <https://opendev.org/openstack/charm-tempest/>`_
Maintenance-Mode Charms
~~~~~~~~~~~~~~~~~~~~~~~
@ -91,12 +91,12 @@ Deprecated Charms
These charms have reached EOL and are deprecated.
* `ceph <https://git.openstack.org/cgit/openstack/charm-ceph/>`_ - Use ceph-osd + ceph-mon instead.
* `glusterfs <https://git.openstack.org/cgit/openstack/charm-glusterfs/>`_
* `manila-glusterfs <https://git.openstack.org/cgit/openstack/charm-manila-glusterfs/>`_
* `murano <https://git.openstack.org/cgit/openstack/charm-murano/>`_
* `neutron-api-odl <https://git.openstack.org/cgit/openstack/charm-neutron-api-odl/>`_
* `nova-compute-proxy <https://git.openstack.org/cgit/openstack/charm-nova-compute-proxy/>`_
* `openvswitch-odl <https://git.openstack.org/cgit/openstack/charm-openvswitch-odl/>`_
* `odl-controller <https://git.openstack.org/cgit/openstack/charm-odl-controller/>`_
* `trove <https://git.openstack.org/cgit/openstack/charm-trove/>`_
* `ceph <https://opendev.org/openstack/charm-ceph/>`_ - Use ceph-osd + ceph-mon instead.
* `glusterfs <https://opendev.org/openstack/charm-glusterfs/>`_
* `manila-glusterfs <https://opendev.org/openstack/charm-manila-glusterfs/>`_
* `murano <https://opendev.org/openstack/charm-murano/>`_
* `neutron-api-odl <https://opendev.org/openstack/charm-neutron-api-odl/>`_
* `nova-compute-proxy <https://opendev.org/openstack/charm-nova-compute-proxy/>`_
* `openvswitch-odl <https://opendev.org/openstack/charm-openvswitch-odl/>`_
* `odl-controller <https://opendev.org/openstack/charm-odl-controller/>`_
* `trove <https://opendev.org/openstack/charm-trove/>`_

10
doc/source/openstack-on-lxd.rst
View File

@ -41,7 +41,7 @@ You'll need to clone the repository with the bundles and configuration for the d
.. code:: bash
git clone https://github.com/openstack-charmers/openstack-on-lxd
git clone https://opendev.org/openstack-charmers/openstack-on-lxd
All commands in this document assume they are being made from within the local copy of this repo.
@ -450,6 +450,8 @@ In your SSH session, press the ~C key combo to initiate an SSH command console o
Then visit the following URL from a browser on your local machine:
.. code:: rest
http://localhost:10080/horizon
.. code:: bash
@ -476,7 +478,9 @@ The IP address of the Juju GUI will be locally accessible.
The URL provided should work directly, and it should look something like:
https://10.0.8.x:17070/gui/u/admin/default
.. code:: rest
https://10.0.8.x:17070/gui/u/admin/default
OpenStack-on-LXD is deployed on a remote machine
@ -492,6 +496,8 @@ In your SSH session, press the ~C key combo to initiate an SSH command console o
Then visit the following URL from a browser on your local machine:
.. code:: rest
https://localhost:10070/gui/login/u/admin/default
Switching in a dev charm

2
doc/source/rotas.rst
View File

@ -28,7 +28,7 @@ Review `new bugs <https://bugs.launchpad.net/openstack-charms/+bugs?search=Searc
Charm Review
############
Review of `open changes <https://review.openstack.org/#/q/project:%22%255Eopenstack/charm.*%22+status:open>`__ on the OpenStack Charms.
Review of `open changes <https://review.opendev.org/q/project:%22%255Eopenstack/charm.*%22+status:open>`__ on the OpenStack Charms.
+--------+------------+--------------+-------------+------------+
| Monday | Tuesday | Wednesday | Thursday | Friday |

5
requirements.txt
View File

@ -1,3 +1,4 @@
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 # BSD
oslosphinx>=2.5.0,!=3.4.0 # Apache-2.0
pbr>=1.6 # Apache-2.0
sphinx>=2.0.0 # BSD
openstackdocstheme>=1.29.2 # Apache-2.0
doc8>=0.8.0 # Apache-2.0