Merge "Update the documentation link for doc migration"
This commit is contained in:
commit
c993e8d349
76
README.rst
76
README.rst
@ -32,53 +32,53 @@ Getting Started
|
||||
===============
|
||||
|
||||
Learn about Kolla-Ansible by reading the documentation online
|
||||
`docs.openstack.org <http://docs.openstack.org/developer/kolla-ansible/>`__.
|
||||
`docs.openstack.org <https://docs.openstack.org/kolla-ansible/latest/>`__.
|
||||
|
||||
Get started by reading the `Developer
|
||||
Quickstart <http://docs.openstack.org/developer/kolla-ansible/quickstart.html>`__.
|
||||
Quickstart <https://docs.openstack.org/kolla-ansible/latest/quickstart.html>`__.
|
||||
|
||||
OpenStack services
|
||||
------------------
|
||||
|
||||
Kolla-Ansible deploys containers for the following OpenStack projects:
|
||||
|
||||
- `Aodh <http://docs.openstack.org/developer/aodh/>`__
|
||||
- `Barbican <http://docs.openstack.org/developer/barbican/>`__
|
||||
- `Bifrost <http://docs.openstack.org/developer/bifrost/>`__
|
||||
- `Ceilometer <http://docs.openstack.org/developer/ceilometer/>`__
|
||||
- `Cinder <http://docs.openstack.org/developer/cinder/>`__
|
||||
- `CloudKitty <http://docs.openstack.org/developer/cloudkitty/>`__
|
||||
- `Congress <http://docs.openstack.org/developer/congress/>`__
|
||||
- `Designate <http://docs.openstack.org/developer/designate/>`__
|
||||
- `Aodh <https://docs.openstack.org/aodh/latest/>`__
|
||||
- `Barbican <https://docs.openstack.org/barbican/latest/>`__
|
||||
- `Bifrost <https://docs.openstack.org/bifrost/latest/>`__
|
||||
- `Ceilometer <https://docs.openstack.org/ceilometer/latest/>`__
|
||||
- `Cinder <https://docs.openstack.org/cinder/latest/>`__
|
||||
- `CloudKitty <https://docs.openstack.org/cloudkitty/latest/>`__
|
||||
- `Congress <https://docs.openstack.org/congress/latest/>`__
|
||||
- `Designate <https://docs.openstack.org/designate/latest/>`__
|
||||
- `Freezer <https://wiki.openstack.org/wiki/Freezer-docs>`__
|
||||
- `Glance <http://docs.openstack.org/developer/glance/>`__
|
||||
- `Heat <http://docs.openstack.org/developer/heat/>`__
|
||||
- `Horizon <http://docs.openstack.org/developer/horizon/>`__
|
||||
- `Ironic <http://docs.openstack.org/developer/ironic/>`__
|
||||
- `Karbor <http://docs.openstack.org/developer/karbor/>`__
|
||||
- `Keystone <http://docs.openstack.org/developer/keystone/>`__
|
||||
- `Kuryr <http://docs.openstack.org/developer/kuryr/>`__
|
||||
- `Magnum <http://docs.openstack.org/developer/magnum/>`__
|
||||
- `Manila <http://docs.openstack.org/developer/manila/>`__
|
||||
- `Mistral <http://docs.openstack.org/developer/mistral/>`__
|
||||
- `Murano <http://docs.openstack.org/developer/murano/>`__
|
||||
- `Neutron <http://docs.openstack.org/developer/neutron/>`__
|
||||
- `Nova <http://docs.openstack.org/developer/nova/>`__
|
||||
- `Octavia <http://docs.openstack.org/developer/octavia/>`__
|
||||
- `Panko <http://docs.openstack.org/developer/panko/>`__
|
||||
- `Rally <http://docs.openstack.org/developer/rally/>`__
|
||||
- `Sahara <http://docs.openstack.org/developer/sahara/>`__
|
||||
- `Searchlight <http://docs.openstack.org/developer/searchlight/>`__
|
||||
- `Senlin <http://docs.openstack.org/developer/senlin/>`__
|
||||
- `Solum <http://docs.openstack.org/developer/solum/>`__
|
||||
- `Swift <http://docs.openstack.org/developer/swift/>`__
|
||||
- `Tacker <http://docs.openstack.org/developer/tacker/>`__
|
||||
- `Tempest <http://docs.openstack.org/developer/tempest/>`__
|
||||
- `Trove <http://docs.openstack.org/developer/trove/>`__
|
||||
- `Vmtp <http://vmtp.readthedocs.io/en/latest/>`__
|
||||
- `Watcher <http://docs.openstack.org/developer/watcher/>`__
|
||||
- `Zaqar <http://docs.openstack.org/developer/zaqar/>`__
|
||||
- `Zun <http://wiki.openstack.org/wiki/zun>`__
|
||||
- `Glance <https://docs.openstack.org/glance/latest/>`__
|
||||
- `Heat <https://docs.openstack.org/heat/latest/>`__
|
||||
- `Horizon <https://docs.openstack.org/horizon/latest/>`__
|
||||
- `Ironic <https://docs.openstack.org/ironic/latest/>`__
|
||||
- `Karbor <https://docs.openstack.org/karbor/latest/>`__
|
||||
- `Keystone <https://docs.openstack.org/keystone/latest/>`__
|
||||
- `Kuryr <https://docs.openstack.org/kuryr/latest/>`__
|
||||
- `Magnum <https://docs.openstack.org/magnum/latest/>`__
|
||||
- `Manila <https://docs.openstack.org/manila/latest/>`__
|
||||
- `Mistral <https://docs.openstack.org/mistral/latest/>`__
|
||||
- `Murano <https://docs.openstack.org/murano/latest/>`__
|
||||
- `Neutron <https://docs.openstack.org/neutron/latest/>`__
|
||||
- `Nova <https://docs.openstack.org/nova/latest/>`__
|
||||
- `Octavia <https://docs.openstack.org/octavia/latest/>`__
|
||||
- `Panko <https://docs.openstack.org/panko/latest/>`__
|
||||
- `Rally <https://docs.openstack.org/rally/latest/>`__
|
||||
- `Sahara <https://docs.openstack.org/sahara/latest/>`__
|
||||
- `Searchlight <https://docs.openstack.org/searchlight/latest/>`__
|
||||
- `Senlin <https://docs.openstack.org/senlin/latest/>`__
|
||||
- `Solum <https://docs.openstack.org/solum/latest/>`__
|
||||
- `Swift <https://docs.openstack.org/swift/latest/>`__
|
||||
- `Tacker <https://docs.openstack.org/tacker/latest/>`__
|
||||
- `Tempest <https://docs.openstack.org/tempest/latest/>`__
|
||||
- `Trove <https://docs.openstack.org/trove/latest/>`__
|
||||
- `Vmtp <https://vmtp.readthedocs.io/en/latest/>`__
|
||||
- `Watcher <https://docs.openstack.org/watcher/latest/>`__
|
||||
- `Zaqar <https://docs.openstack.org/zaqar/latest/>`__
|
||||
- `Zun <https://docs.openstack.org/zun/latest/>`__
|
||||
|
||||
Infrastructure components
|
||||
-------------------------
|
||||
|
@ -734,7 +734,7 @@ SECURITY_GROUP_RULES = {
|
||||
# $glance --os-image-api-version 2 help md-namespace-import
|
||||
# $glance-manage db_load_metadefs <directory_with_definition_files>
|
||||
#
|
||||
# See Metadata Definitions on: http://docs.openstack.org/developer/glance/
|
||||
# See Metadata Definitions on: https://docs.openstack.org/glance/latest/
|
||||
|
||||
# TODO: (david-lyle) remove when plugins support settings natively
|
||||
# Note: This is only used when the Sahara plugin is configured and enabled
|
||||
|
@ -33,7 +33,7 @@ Development Environment
|
||||
Please follow our `quickstart`_ to deploy your environment and test your
|
||||
changes.
|
||||
|
||||
.. _quickstart: http://docs.openstack.org/developer/kolla-ansible/quickstart.html
|
||||
.. _quickstart: https://docs.openstack.org/kolla-ansible/latest/quickstart.html
|
||||
|
||||
Please use the existing sandbox repository, available at
|
||||
https://git.openstack.org/cgit/openstack-dev/sandbox, for learning, understanding
|
||||
|
@ -166,7 +166,7 @@ group. In the ``all-in-one`` and ``multinode`` inventory files, a ``bifrost``
|
||||
group is defined which contains all hosts in the ``deployment`` group. This
|
||||
top level ``deployment`` group is intended to represent the host running the
|
||||
``bifrost_deploy`` container. By default, this group contains ``localhost``.
|
||||
See `Multinode Deployment of Kolla <https://docs.openstack.org/developer/kolla-ansible/multinode.html>`_
|
||||
See `Multinode Deployment of Kolla <https://docs.openstack.org/kolla-ansible/latest/multinode.html>`_
|
||||
for details on how to modify the Ansible inventory in a multinode deployment.
|
||||
|
||||
Bifrost does not currently support running on multiple hosts so the ``bifrost``
|
||||
@ -285,7 +285,7 @@ For example to use the ``debian`` Disk Image Builder OS element:
|
||||
dib_os_element: debian
|
||||
|
||||
See the `diskimage-builder documentation
|
||||
<http://docs.openstack.org/developer/diskimage-builder/>`__ for more details.
|
||||
<https://docs.openstack.org/diskimage-builder/latest/>`__ for more details.
|
||||
|
||||
Deploy Bifrost
|
||||
--------------
|
||||
@ -467,9 +467,9 @@ done remotely with ``ipmitool`` and Serial Over LAN. For example
|
||||
References
|
||||
==========
|
||||
|
||||
Bifrost documentation: http://docs.openstack.org/developer/bifrost/
|
||||
Bifrost documentation: https://docs.openstack.org/bifrost/latest/
|
||||
|
||||
Bifrost troubleshooting guide: http://docs.openstack.org/developer/bifrost/troubleshooting.html
|
||||
Bifrost troubleshooting guide: https://docs.openstack.org/bifrost/latest/troubleshooting.html
|
||||
|
||||
Bifrost code repository: https://github.com/openstack/bifrost
|
||||
|
||||
|
@ -119,4 +119,4 @@ Query instance DNS information to Designate ``dns_interface`` IP address:
|
||||
|
||||
For more information about how Designate works, see
|
||||
`Designate, a DNSaaS component for OpenStack
|
||||
<http://docs.openstack.org/developer/designate>`__.
|
||||
<https://docs.openstack.org/designate/latest/>`__.
|
||||
|
@ -31,7 +31,7 @@ suit the operator's exact requirements.
|
||||
|
||||
For information on building container images for use with Kolla-Ansible, please
|
||||
refer to the `Kolla image documentation
|
||||
<http://docs.openstack.org/developer/kolla>`_.
|
||||
<https://docs.openstack.org/kolla/latest/>`_.
|
||||
|
||||
|
||||
Overview
|
||||
|
@ -49,7 +49,7 @@ Set ironic_console_serial_speed in ``/etc/kolla/globals.yml``:
|
||||
|
||||
ironic_console_serial_speed: 9600n8
|
||||
|
||||
.. _web_console_documentation: https://docs.openstack.org/developer/ironic/deploy/console.html#node-web-console
|
||||
.. _web_console_documentation: https://docs.openstack.org/ironic/latest/admin/console.html#node-web-console
|
||||
|
||||
Post-deployment configuration
|
||||
=============================
|
||||
@ -72,4 +72,4 @@ Create the flat network to launch the instances:
|
||||
And then the above ID is used to set cleaning_network_uuid in the neutron
|
||||
section of ironic.conf.
|
||||
|
||||
.. _documentation: http://docs.openstack.org/developer/ironic/deploy/install-guide.html
|
||||
.. _documentation: https://docs.openstack.org/ironic/latest/install/index.html
|
||||
|
@ -307,7 +307,7 @@ Modify the file ``/etc/kolla/config/manila.conf`` and add the contents:
|
||||
|
||||
Share migration requires have more than one back end configured.
|
||||
`Configure multiple back ends
|
||||
<http://docs.openstack.org/developer/kolla/manila-hnas-guide.html#configure-multiple-back-ends>`__.
|
||||
<https://docs.openstack.org/kolla-ansible/latest/manila-hnas-guide.html#configure-multiple-back-ends>`__.
|
||||
|
||||
Use the manila migration command, as shown in the following example:
|
||||
|
||||
|
@ -327,4 +327,4 @@ For more information about how to manage shares, see the
|
||||
|
||||
For more information about how HNAS driver works, see
|
||||
`Hitachi NAS Platform File Services Driver for OpenStack
|
||||
<http://docs.openstack.org/developer/manila/devref/hitachi_hnas_driver.html>`__.
|
||||
<https://docs.openstack.org/manila/latest/devref/hitachi_hnas_driver.html>`__.
|
||||
|
@ -201,4 +201,4 @@ Run the deployment:
|
||||
|
||||
kolla-ansible deploy -i <path/to/multinode/inventory/file>
|
||||
|
||||
.. _Building Container Images: http://docs.openstack.org/developer/kolla/image-building.html
|
||||
.. _Building Container Images: https://docs.openstack.org/kolla/latest/image-building.html
|
||||
|
@ -54,4 +54,4 @@ The previous command will output the command to retrieve OSprofiler trace.
|
||||
|
||||
For more information about how OSprofiler works, see
|
||||
`OSProfiler – Cross-project profiling library
|
||||
<https://docs.openstack.org/developer/osprofiler/>`__.
|
||||
<https://docs.openstack.org/osprofiler/latest/>`__.
|
||||
|
@ -29,7 +29,7 @@ bare metal or a virtual machine with Kolla.
|
||||
|
||||
If developing Kolla on a system that provides VirtualBox or Libvirt in addition
|
||||
to Vagrant, use the Vagrant virtual environment documented in
|
||||
`Development Environment with Vagrant <https://docs.openstack.org/developer/kolla-ansible/vagrant-dev-env.html>`_.
|
||||
`Development Environment with Vagrant <https://docs.openstack.org/kolla-ansible/latest/vagrant-dev-env.html>`_.
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
@ -538,7 +538,7 @@ Deploy Kolla
|
||||
Kolla-Ansible is used to deploy containers by using images built by Kolla.
|
||||
There are two methods of deployment: *all-in-one* and *multinode*. The
|
||||
*all-in-one* deployment is similar to `devstack
|
||||
<http://docs.openstack.org/developer/devstack/>`__ deploy which installs all
|
||||
<https://docs.openstack.org/devstack/latest/>`__ deploy which installs all
|
||||
OpenStack services on a single host. In the *multinode* deployment, OpenStack
|
||||
services can be run on specific hosts. This documentation describes deploying
|
||||
an *all-in-one* setup. To setup *multinode* see the
|
||||
@ -693,4 +693,4 @@ default to ``kolla_internal_vip_address``.
|
||||
|
||||
.. _Docker Hub Image Registry: https://hub.docker.com/u/kolla/
|
||||
.. _launchpad bug: https://bugs.launchpad.net/kolla/+filebug
|
||||
.. _Building Container Images: http://docs.openstack.org/developer/kolla/image-building.html
|
||||
.. _Building Container Images: https://docs.openstack.org/kolla/latest/image-building.html
|
||||
|
@ -98,7 +98,7 @@ Then run ``tox`` with the debug environment as one of the following::
|
||||
tox -e debug test_file_name.TestClass.test_name
|
||||
|
||||
For more information see the `oslotest documentation
|
||||
<http://docs.openstack.org/developer/oslotest/features.html#debugging-with-oslo-debug-helper>`_.
|
||||
<https://docs.openstack.org/oslotest/latest/user/features.html#debugging-with-oslo-debug-helper>`_.
|
||||
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
@ -187,4 +187,4 @@ Further Reading
|
||||
All Vagrant documentation can be found at
|
||||
`docs.vagrantup.com <http://docs.vagrantup.com>`__.
|
||||
|
||||
.. _Building Container Images: http://docs.openstack.org/developer/kolla/image-building.html
|
||||
.. _Building Container Images: https://docs.openstack.org/kolla/latest/image-building.html
|
||||
|
@ -9,7 +9,7 @@ Preparation and Deployment
|
||||
--------------------------
|
||||
|
||||
Zun requires kuryr and etcd services, for more information about how to
|
||||
configure kuryr refer to `Kuryr Guide <https://docs.openstack.org/developer/kolla-ansible/kuryr-guide.html>`_.
|
||||
configure kuryr refer to `Kuryr Guide <https://docs.openstack.org/kolla-ansible/latest/kuryr-guide.html>`_.
|
||||
|
||||
To allow Zun Compute connect to the Docker Daemon, add the following in the
|
||||
``docker.service`` file on each zun-compute node.
|
||||
|
@ -2,7 +2,7 @@
|
||||
prelude: >
|
||||
In Newton cycle we included means to change various things in Kolla images
|
||||
using override file. Full customization guide can be found here
|
||||
http://docs.openstack.org/developer/kolla/image-building.html#dockerfile-customisation
|
||||
https://docs.openstack.org/kolla/latest/image-building.html#dockerfile-customisation
|
||||
features:
|
||||
- Customization mechanism for dockerfile
|
||||
- Customization implemented in most of OpenStack services
|
||||
|
Loading…
Reference in New Issue
Block a user