openstack
/
magnum
Code Issues Proposed changes

Update docs links 

Many links are broken or point to redirect pages, update all of them.

Use better RST for intra-document links so that they do not silently
break if documents move.

Use opendev.org consistently for git.

Change-Id: I8fedff2fff82177fd12da808b8b421270cbe2d95
This commit is contained in:
Andreas Jaeger 2019-07-26 09:59:46 +02:00
parent 451358a57c
commit df54de88a3
16 changed files with 91 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/configuring.rst
View File

@ -55,4 +55,4 @@ pipeline, you can create a file under the file path defined by
``disable_by_file_path`` ie. ``/etc/magnum/healthcheck_disable``. ``disable_by_file_path`` ie. ``/etc/magnum/healthcheck_disable``.
For more information see For more information see
`oslo.middleware <http://docs.openstack.org/developer/oslo.middleware/api.html#oslo_middleware.Healthcheck>`_. `oslo.middleware <https://docs.openstack.org/oslo.middleware/latest/reference/api.html#oslo_middleware.Healthcheck>`_.

19
doc/source/admin/troubleshooting-guide.rst
View File

@ -1,3 +1,5 @@
.. _magnum_troubleshooting_guide:
============================ ============================
Magnum Troubleshooting Guide Magnum Troubleshooting Guide
============================ ============================
@ -239,16 +241,17 @@ Check the following:
interface? Does this interface have a route to the external internet? interface? Does this interface have a route to the external internet?
- If "external-network" is specified in the ClusterTemplate, does this - If "external-network" is specified in the ClusterTemplate, does this
network have a route to the external internet? network have a route to the external internet?
- Is your devstack environment behind a firewall? This can be the case for some - Is your devstack environment behind a firewall? This can be the
enterprises or countries. In this case, consider using a `proxy server case for some
<https://docs.openstack.org/magnum/latest/admin/magnum-proxy.html>`_. enterprises or countries. In this case, consider using a
:doc:`proxy server </admin/magnum-proxy>`.
- Is the traffic blocked by the security group? Check the - Is the traffic blocked by the security group? Check the
`rules of security group `rules of security group
<http://docs.openstack.org/ops-guide/ops-user-facing-operations.html#security-groups>`_. <https://docs.openstack.org/operations-guide/ops-user-facing-operations.html#security-groups>`_.
- Is your host NAT'ing your internal network correctly? Check your host - Is your host NAT'ing your internal network correctly? Check your host
`iptables <http://docs.openstack.org/ops-guide/ops-network-troubleshooting.html#iptables>`_. `iptables <https://docs.openstack.org/operations-guide/ops-network-troubleshooting.html#iptables>`_.
- Use *tcpdump* for `networking troubleshooting - Use *tcpdump* for `networking troubleshooting
<http://docs.openstack.org/ops-guide/ops-network-troubleshooting.html#tcpdump>`_. <https://docs.openstack.org/operations-guide/ops-network-troubleshooting.html#tcpdump>`_.
You can run *tcpdump* on the interface *docker0, flannel0* and *eth0* on the You can run *tcpdump* on the interface *docker0, flannel0* and *eth0* on the
node and then run *ping* to see the path of the message from the container. node and then run *ping* to see the path of the message from the container.
@ -266,7 +269,7 @@ If the name lookup fails, check the following:
specified by "dns-nameserver" in the ClusterTemplate. specified by "dns-nameserver" in the ClusterTemplate.
- If you are using your own DNS server by specifying "dns-nameserver" - If you are using your own DNS server by specifying "dns-nameserver"
in the ClusterTemplate, is it reachable and working? in the ClusterTemplate, is it reachable and working?
- More help on `DNS troubleshooting <http://docs.openstack.org/ops-guide/ops-network-troubleshooting.html#debugging-dns-issues>`_. - More help on `DNS troubleshooting <https://docs.openstack.org/operations-guide/ops-network-troubleshooting.html#debugging-dns-issues>`_.
Kubernetes networking Kubernetes networking
@ -354,7 +357,7 @@ If the ping is not successful, check the following:
- Is Flannel running properly? check the `Running Flannel`_. - Is Flannel running properly? check the `Running Flannel`_.
- Ping and try `tcpdump - Ping and try `tcpdump
<http://docs.openstack.org/ops-guide/ops-network-troubleshooting.html#tcpdump>`_ <https://docs.openstack.org/operations-guide/ops-network-troubleshooting.html#tcpdump>`_
on each network interface along the path between two nodes on each network interface along the path between two nodes
to see how far the message is able to travel. to see how far the message is able to travel.
The message path should be as follows: The message path should be as follows:

7
doc/source/contributor/functional-test.rst
View File

@ -9,10 +9,9 @@ Prerequisite
============ ============
You need to have a Magnum instance running somewhere. If you are using You need to have a Magnum instance running somewhere. If you are using
devstack, follow the developer quickstart guide to deploy Magnum in a devstack devstack, follow :ref:`quickstart` to deploy Magnum in a devstack
environment environment.
`<https://docs.openstack.org/developer/magnum/dev/quickstart.html>`_
Configuration Configuration
============= =============
@ -66,7 +65,7 @@ Outside of devstack
If you are not using devstack, you'll need to create the configuration files. If you are not using devstack, you'll need to create the configuration files.
The /etc/tempest.conf configuration file is documented here The /etc/tempest.conf configuration file is documented here
`<https://docs.openstack.org/developer/tempest/configuration.html#tempest-configuration>`_ `<https://docs.openstack.org/tempest/latest/configuration.html#tempest-configuration>`_
Here's a reasonable sample of tempest.conf settings you might need:: Here's a reasonable sample of tempest.conf settings you might need::

6
doc/source/contributor/objects.rst
View File

@ -18,7 +18,7 @@ Versioned Objects
================= =================
Magnum uses the `oslo.versionedobjects library Magnum uses the `oslo.versionedobjects library
<http://docs.openstack.org/developer/oslo.versionedobjects/index.html>`_ to <https://docs.openstack.org/oslo.versionedobjects/latest/index.html>`_ to
construct an object model that can be communicated via RPC. These objects have construct an object model that can be communicated via RPC. These objects have
a version history and functionality to convert from one version to a previous a version history and functionality to convert from one version to a previous
version. This allows for 2 different levels of the code to still pass objects version. This allows for 2 different levels of the code to still pass objects
@ -30,7 +30,7 @@ Object Version Testing
In order to ensure object versioning consistency is maintained, In order to ensure object versioning consistency is maintained,
oslo.versionedobjects has a fixture to aid in testing object versioning. oslo.versionedobjects has a fixture to aid in testing object versioning.
`oslo.versionedobjects.fixture.ObjectVersionChecker `oslo.versionedobjects.fixture.ObjectVersionChecker
<http://docs.openstack.org/developer/oslo.versionedobjects/api/fixture.html#oslo_versionedobjects.fixture.ObjectVersionChecker>`_ <https://docs.openstack.org/oslo.versionedobjects/latest/reference/fixture.html#oslo_versionedobjects.fixture.ObjectVersionChecker>`_
generates fingerprints of each object, which is a combination of the current generates fingerprints of each object, which is a combination of the current
version number of the object, along with a hash of the RPC-critical parts of version number of the object, along with a hash of the RPC-critical parts of
the object (fields and remotable methods). the object (fields and remotable methods).
@ -61,7 +61,7 @@ This results in a unit test failure with the following output:
.. code-block:: console .. code-block:: console
: Fields or remotable methods in some objects have changed. Make sure the versions of the objects has been bumped, and update the hashes in the static fingerprints tree (object_data). For more information, read http://docs.openstack.org/developer/magnum/objects.html. : Fields or remotable methods in some objects have changed. Make sure the versions of the objects has been bumped, and update the hashes in the static fingerprints tree (object_data). For more information, read https://docs.openstack.org/developer/magnum/objects.html.
This is an indication that me adding the 'foo' field to Cluster means I need This is an indication that me adding the 'foo' field to Cluster means I need
to bump the version of Cluster, so I increase the version and add a comment to bump the version of Cluster, so I increase the version and add a comment

8
doc/source/contributor/policies.rst
View File

@ -133,7 +133,7 @@ Summary of Core Reviewer Responsibilities
PTL Responsibilities PTL Responsibilities
==================== ====================
In accordance with our `Project Team Guide for PTLs In accordance with our `Project Team Guide for PTLs
<http://docs.openstack.org/project-team-guide/ptl.html>`_ <https://docs.openstack.org/project-team-guide/ptl.html>`_
our PTL carries all the responsibilities referenced above plus: our PTL carries all the responsibilities referenced above plus:
* Select and target blueprints for each release cycle. * Select and target blueprints for each release cycle.
@ -310,9 +310,9 @@ Reviews
======= =======
A review is a patch set that includes a proposal for inclusion in our code A review is a patch set that includes a proposal for inclusion in our code
base. We follow the process outlined in the `Code Review base. We follow the process outlined in the `Code Review
<http://docs.openstack.org/infra/manual/developers.html#code-review>`_ <https://docs.openstack.org/infra/manual/developers.html#code-review>`_
section of the `OpenStack Developer's Guide section of the `OpenStack Developer's Guide
<http://docs.openstack.org/infra/manual/developers.html>`_. <https://docs.openstack.org/infra/manual/developers.html>`_.
The following workflow states may by applied to each review: The following workflow states may by applied to each review:
========== ================== ============================================= ========== ================== =============================================
@ -478,7 +478,7 @@ applied.
Fast Revert Fast Revert
----------- -----------
This policy was adapted from nova's `Reverts for Retrospective Vetos This policy was adapted from nova's `Reverts for Retrospective Vetos
<http://docs.openstack.org/developer/nova/policies.html>`_ policy in 2017. <https://docs.openstack.org/nova/latest/policies.html>`_ policy in 2017.
Sometimes our simple `2 +2s` approval policy will result in errors when we Sometimes our simple `2 +2s` approval policy will result in errors when we
move quickly. These errors might be a bug that was missed, or equally move quickly. These errors might be a bug that was missed, or equally
importantly, it might be that other cores feel that there is a need for importantly, it might be that other cores feel that there is a need for

35
doc/source/contributor/quickstart.rst
View File

@ -10,7 +10,7 @@ OpenStack project.
.. seealso:: .. seealso::
http://docs.openstack.org/infra/manual/developers.html https://docs.openstack.org/infra/manual/developers.html
Setup Dev Environment Setup Dev Environment
===================== =====================
@ -57,7 +57,7 @@ Magnum source code should be pulled directly from git::
# from your home or source directory # from your home or source directory
cd ~ cd ~
git clone https://git.openstack.org/openstack/magnum git clone https://opendev.org/openstack/magnum
cd magnum cd magnum
All unit tests should be run using tox. To run magnum's entire test suite:: All unit tests should be run using tox. To run magnum's entire test suite::
@ -84,7 +84,7 @@ To run unit test coverage and check percentage of code covered::
tox -e cover tox -e cover
To discover and interact with templates, please refer to To discover and interact with templates, please refer to
`<http://docs.openstack.org/developer/magnum/dev/cluster-type-definition.html>`_ :doc:`/user/cluster-type-definition`.
Exercising the Services Using DevStack Exercising the Services Using DevStack
====================================== ======================================
@ -113,7 +113,7 @@ Clone devstack::
sudo mkdir -p /opt/stack sudo mkdir -p /opt/stack
sudo chown $USER /opt/stack sudo chown $USER /opt/stack
git clone https://git.openstack.org/openstack-dev/devstack /opt/stack/devstack git clone https://opendev.org/openstack/devstack /opt/stack/devstack
We will run devstack with minimal local.conf settings required to enable We will run devstack with minimal local.conf settings required to enable
magnum, heat, and neutron (neutron is enabled by default in devstack since magnum, heat, and neutron (neutron is enabled by default in devstack since
@ -130,16 +130,16 @@ Kilo, and heat must be enabled by yourself)::
PUBLIC_INTERFACE=eth1 PUBLIC_INTERFACE=eth1
# Enable barbican service and use it to store TLS certificates # Enable barbican service and use it to store TLS certificates
# For details https://docs.openstack.org/developer/magnum/userguide.html#transport-layer-security # For details https://docs.openstack.org/magnum/latest/user/index.html#transport-layer-security
enable_plugin barbican https://git.openstack.org/openstack/barbican enable_plugin barbican https://opendev.org/openstack/barbican
enable_plugin heat https://git.openstack.org/openstack/heat enable_plugin heat https://opendev.org/openstack/heat
# Enable magnum plugin after dependent plugins # Enable magnum plugin after dependent plugins
enable_plugin magnum https://git.openstack.org/openstack/magnum enable_plugin magnum https://opendev.org/openstack/magnum
# Optional: uncomment to enable the Magnum UI plugin in Horizon # Optional: uncomment to enable the Magnum UI plugin in Horizon
#enable_plugin magnum-ui https://github.com/openstack/magnum-ui #enable_plugin magnum-ui https://opendev.org/openstack/magnum-ui
VOLUME_BACKING_FILE_SIZE=20G VOLUME_BACKING_FILE_SIZE=20G
END END
@ -152,8 +152,8 @@ Optionally, you can enable neutron/lbaas v2 with octavia to create load
balancers for multi master clusters:: balancers for multi master clusters::
$ cat >> /opt/stack/devstack/local.conf << END $ cat >> /opt/stack/devstack/local.conf << END
enable_plugin neutron-lbaas https://git.openstack.org/openstack/neutron-lbaas enable_plugin neutron-lbaas https://opendev.org/openstack/neutron-lbaas
enable_plugin octavia https://git.openstack.org/openstack/octavia enable_plugin octavia https://opendev.org/openstack/octavia
# Disable LBaaS(v1) service # Disable LBaaS(v1) service
disable_service q-lbaas disable_service q-lbaas
@ -170,7 +170,7 @@ Optionally, you can enable ceilometer in devstack. If ceilometer is enabled,
magnum will periodically send metrics to ceilometer:: magnum will periodically send metrics to ceilometer::
$ cat >> /opt/stack/devstack/local.conf << END $ cat >> /opt/stack/devstack/local.conf << END
enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer enable_plugin ceilometer https://opendev.org/openstack/ceilometer
END END
If you want to deploy Docker Registry 2.0 in your cluster, you should enable If you want to deploy Docker Registry 2.0 in your cluster, you should enable
@ -184,10 +184,10 @@ swift in devstack::
END END
More devstack configuration information can be found at More devstack configuration information can be found at
http://docs.openstack.org/developer/devstack/configuration.html https://docs.openstack.org/devstack/latest/configuration.html
More neutron configuration information can be found at More neutron configuration information can be found at
http://docs.openstack.org/developer/devstack/guides/neutron.html https://docs.openstack.org/devstack/latest/guides/neutron.html
Run devstack:: Run devstack::
@ -391,8 +391,7 @@ cluster using::
sudo mv ./kubectl /usr/local/bin/kubectl sudo mv ./kubectl /usr/local/bin/kubectl
We first need to setup the certs to allow Kubernetes to authenticate our We first need to setup the certs to allow Kubernetes to authenticate our
connection. Please refer to connection. Please refer to :ref:`transport_layer_security`
`<http://docs.openstack.org/developer/magnum/userguide.html#transport-layer-security>`_
for more info on using TLS keys/certs which are setup below. for more info on using TLS keys/certs which are setup below.
To generate an RSA key, you will use the 'genrsa' command of the 'openssl' To generate an RSA key, you will use the 'genrsa' command of the 'openssl'
@ -550,7 +549,7 @@ except for the absence of some Kubernetes-specific arguments and the use of
--coe swarm-mode --coe swarm-mode
**NOTE:** If you are using Magnum behind a firewall then refer **NOTE:** If you are using Magnum behind a firewall then refer
to `<http://docs.openstack.org/developer/magnum/magnum-proxy.html>`_ to :doc:`/admin/magnum-proxy`.
Finally, create the cluster. Use the ClusterTemplate 'swarm-cluster-template' Finally, create the cluster. Use the ClusterTemplate 'swarm-cluster-template'
as a template for cluster creation. This cluster will result in one swarm as a template for cluster creation. This cluster will result in one swarm
@ -658,7 +657,7 @@ Building and Using a Mesos Cluster
Provisioning a mesos cluster requires a Ubuntu-based image with some packages Provisioning a mesos cluster requires a Ubuntu-based image with some packages
pre-installed. To build and upload such image, please refer to pre-installed. To build and upload such image, please refer to
`<http://docs.openstack.org/developer/magnum/userguide.html#building-mesos-image>`_ :ref`building_mesos_image`.
Alternatively, you can download and upload a pre-built image:: Alternatively, you can download and upload a pre-built image::

10
doc/source/contributor/reno.rst
View File

@ -4,7 +4,7 @@ Release Notes
What is reno ? What is reno ?
-------------- --------------
Magnum uses `reno <http://docs.openstack.org/developer/reno/usage.html>`_ for Magnum uses `reno <https://docs.openstack.org/reno/latest/index.html>`_ for
providing release notes in-tree. That means that a patch can include a *reno providing release notes in-tree. That means that a patch can include a *reno
file* or a series can have a follow-on change containing that file explaining file* or a series can have a follow-on change containing that file explaining
what the impact is. what the impact is.
@ -19,7 +19,7 @@ generated using the reno tool this way:
where usually ``<name-your-file>`` can be ``bp-<blueprint_name>`` for a where usually ``<name-your-file>`` can be ``bp-<blueprint_name>`` for a
blueprint or ``bug-XXXXXX`` for a bugfix. blueprint or ``bug-XXXXXX`` for a bugfix.
Refer to the `reno documentation <http://docs.openstack.org/developer/reno/usage.html#editing-a-release-note>`_ Refer to the `reno documentation <https://docs.openstack.org/reno/latest/user/usage.html#editing-a-release-note>`_
for the full list of sections. for the full list of sections.
@ -32,10 +32,10 @@ of the note file entirely. If no section is needed, then you know you don't
need to provide a release note :-) need to provide a release note :-)
* ``upgrade`` * ``upgrade``
* The patch has an `UpgradeImpact <http://docs.openstack.org/infra/manual/developers.html#peer-review>`_ tag * The patch has an `UpgradeImpact <https://docs.openstack.org/infra/manual/developers.html#peer-review>`_ tag
* A DB change needs some deployer modification (like a migration) * A DB change needs some deployer modification (like a migration)
* A configuration option change (deprecation, removal or modified default) * A configuration option change (deprecation, removal or modified default)
* some specific changes that have a `DocImpact <http://docs.openstack.org/infra/manual/developers.html#peer-review>`_ tag * some specific changes that have a `DocImpact <https://docs.openstack.org/infra/manual/developers.html#peer-review>`_ tag
but require further action from an deployer perspective but require further action from an deployer perspective
* any patch that requires an action from the deployer in general * any patch that requires an action from the deployer in general
@ -43,7 +43,7 @@ need to provide a release note :-)
* If the patch fixes a known vulnerability * If the patch fixes a known vulnerability
* ``features`` * ``features``
* If the patch has an `APIImpact <http://docs.openstack.org/infra/manual/developers.html#peer-review>`_ tag * If the patch has an `APIImpact <https://docs.openstack.org/infra/manual/developers.html#peer-review>`_ tag
* ``critical`` * ``critical``
* Bugfixes categorized as Critical in Launchpad *impacting users* * Bugfixes categorized as Critical in Launchpad *impacting users*

2
doc/source/install/index.rst
View File

@ -21,5 +21,5 @@ runs that image in either virtual machines or bare metal in a cluster
configuration. configuration.
This chapter assumes a working setup of OpenStack following `OpenStack This chapter assumes a working setup of OpenStack following `OpenStack
Installation Tutorial <http://docs.openstack.org/#install-guides>`_. Installation Tutorial <https://docs.openstack.org/#install-guides>`_.

4
doc/source/install/install-guide-from-source.rst
View File

@ -105,7 +105,7 @@ Install and configure components
.. code-block:: console .. code-block:: console
# cd /var/lib/magnum # cd /var/lib/magnum
# git clone https://git.openstack.org/openstack/magnum.git # git clone https://opendev.org/openstack/magnum
# chown -R magnum:magnum magnum # chown -R magnum:magnum magnum
# cd magnum # cd magnum
# su -s /bin/sh -c "/var/lib/magnum/env/bin/pip install -r requirements.txt" magnum # su -s /bin/sh -c "/var/lib/magnum/env/bin/pip install -r requirements.txt" magnum
@ -254,7 +254,7 @@ Install the command-line client
.. code-block:: console .. code-block:: console
$ cd ~ $ cd ~
$ git clone https://git.openstack.org/openstack/python-magnumclient.git $ git clone https://opendev.org/openstack/python-magnumclient
$ cd python-magnumclient $ cd python-magnumclient
$ virtualenv .magnumclient-env $ virtualenv .magnumclient-env
$ .magnumclient-env/bin/pip install -r requirements.txt $ .magnumclient-env/bin/pip install -r requirements.txt

24
doc/source/install/install.rst
View File

@ -9,28 +9,30 @@ Infrastructure Management service, code-named magnum, on the controller node.
This section assumes that you already have a working OpenStack environment with This section assumes that you already have a working OpenStack environment with
at least the following components installed: Identity service, Image service, at least the following components installed: Identity service, Image service,
Compute service, Networking service, Block Storage service and Orchestration Compute service, Networking service, Block Storage service and Orchestration
service. See `OpenStack Install Guides <http://docs.openstack.org/ service. See `OpenStack Install Guides <https://docs.openstack.org/
#install-guides>`__. #install-guides>`__.
To provide access to Docker Swarm or Kubernetes using the native clients To provide access to Docker Swarm or Kubernetes using the native clients
(docker or kubectl, respectively) magnum uses TLS certificates. To store the (docker or kubectl, respectively) magnum uses TLS certificates. To store the
certificates, it is recommended to use the `Key Manager service, code-named certificates, it is recommended to use the `Key Manager service, code-named
barbican <http://docs.openstack.org/project-install-guide/key-manager/ barbican <https://docs.openstack.org/project-install-guide/key-manager/
draft/>`__, or you can save them in magnum's database. draft/>`__, or you can save them in magnum's database.
Optionally, you can install the following components: Optionally, you can install the following components:
- `Load Balancer as a Service (LBaaS v2) <http://docs.openstack.org/ - `Load Balancer as a Service (LBaaS v2) <https://docs.openstack.org/
networking-guide/config-lbaas.html>`__ to create clusters with multiple ocata/networking-guide/config-lbaas.html>`__ to create clusters with multiple
masters masters
- `Bare Metal service <http://docs.openstack.org/project-install-guide/ - `Bare Metal service
baremetal/draft/>`__ to create baremetal clusters <https://docs.openstack.org/ironic/latest/install/index.html/>`__
- `Object Storage service <http://docs.openstack.org/project-install-guide/ to create baremetal clusters
object-storage/draft/>`__ to make private Docker registries available to - `Object Storage service
<https://docs.openstack.org/swift/latest/install/index.html>`__
to make private Docker registries available to
users users
- `Telemetry Data Collection service <http://docs.openstack.org/ - `Telemetry Data Collection service
project-install-guide/telemetry/draft/>`__ to periodically send <https://docs.openstack.org/ceilometer/latest/install/index.html>`__
magnum-related metrics to periodically send magnum-related metrics
.. note:: .. note::

6
doc/source/install/launch-instance.rst
View File

@ -6,9 +6,9 @@ Launch an instance
In environments that include the Container Infrastructure Management service, In environments that include the Container Infrastructure Management service,
you can provision container clusters made up of virtual machines or baremetal you can provision container clusters made up of virtual machines or baremetal
servers. The Container Infrastructure Management service uses servers. The Container Infrastructure Management service uses
`Cluster Templates <http://docs.openstack.org/developer/magnum/userguide.html#clustertemplate>`__ `Cluster Templates <ClusterTemplate>`_
to describe how a `Cluster <http://docs.openstack.org/developer/magnum/ to describe how a :ref:`cluster` is constructed. In each of the
userguide.html#cluster>`__ is constructed. In each of the following examples following examples
you will create a Cluster Template for a specific COE and then you will you will create a Cluster Template for a specific COE and then you will
provision a Cluster using the corresponding Cluster Template. Then, you can use provision a Cluster using the corresponding Cluster Template. Then, you can use
the appropriate COE client or endpoint to create containers. the appropriate COE client or endpoint to create containers.

2
doc/source/install/next-steps.rst
View File

@ -6,4 +6,4 @@ Next steps
Your OpenStack environment now includes the magnum service. Your OpenStack environment now includes the magnum service.
To add more services, see the `additional documentation on installing OpenStack To add more services, see the `additional documentation on installing OpenStack
<http://docs.openstack.org/#install-guides>`_ . <https://docs.openstack.org/#install-guides>`_ .

2
doc/source/user/cluster-type-definition.rst
View File

@ -45,7 +45,7 @@ Enabling a Cluster Type is as simple as adding it's Entry Point to the
$ virtualenv .venv $ virtualenv .venv
$ . .venv/bin/active $ . .venv/bin/active
(.venv)$ git clone https://github.com/openstack/magnum.git (.venv)$ git clone https://opendev.org/openstack/magnum
(.venv)$ cd magnum (.venv)$ cd magnum
(.venv)$ python setup.py install (.venv)$ python setup.py install

2
doc/source/user/glossary.rst
View File

@ -1,3 +1,5 @@
.. _glossary:
======== ========
Glossary Glossary
======== ========

43
doc/source/user/index.rst
View File

@ -420,6 +420,8 @@ the table are linked to more details elsewhere in the user guide.
| | - false | | | | - false | |
+---------------------------------------+--------------------+---------------+ +---------------------------------------+--------------------+---------------+
.. _cluster:
Cluster Cluster
------- -------
@ -503,9 +505,7 @@ network cannot be removed while a Nova instance is still attached.
**NOTE** Currently Heat nested templates are used to create the **NOTE** Currently Heat nested templates are used to create the
resources; therefore if an error occurs, you can troubleshoot through resources; therefore if an error occurs, you can troubleshoot through
Heat. For more help on Heat stack troubleshooting, refer to the Heat. For more help on Heat stack troubleshooting, refer to the
`Troubleshooting Guide :ref:`magnum_troubleshooting_guide`.
<https://docs.openstack.org/magnum/latest/admin/troubleshooting-guide.html#heat-stacks>`_.
Create Create
@ -700,11 +700,11 @@ Follow the instructions in the OpenStack Installation Guide to enable the
repositories for your distribution: repositories for your distribution:
* `RHEL/CentOS/Fedora * `RHEL/CentOS/Fedora
<http://docs.openstack.org/liberty/install-guide-rdo/>`_ <https://docs.openstack.org/liberty/install-guide-rdo/>`_
* `Ubuntu/Debian * `Ubuntu/Debian
<http://docs.openstack.org/liberty/install-guide-ubuntu/>`_ <https://docs.openstack.org/liberty/install-guide-ubuntu/>`_
* `openSUSE/SUSE Linux Enterprise * `openSUSE/SUSE Linux Enterprise
<http://docs.openstack.org/liberty/install-guide-obs/>`_ <https://docs.openstack.org/liberty/install-guide-obs/>`_
Install using distribution packages for RHEL/CentOS/Fedora:: Install using distribution packages for RHEL/CentOS/Fedora::
@ -730,7 +730,7 @@ Using the command-line client
----------------------------- -----------------------------
Refer to the `OpenStack Command-Line Interface Reference Refer to the `OpenStack Command-Line Interface Reference
<http://docs.openstack.org/cli-reference/magnum.html>`_ for a full list of the <https://docs.openstack.org/cli-reference/magnum.html>`_ for a full list of the
commands supported by the `openstack coe` command-line client. commands supported by the `openstack coe` command-line client.
Horizon Interface Horizon Interface
@ -739,11 +739,10 @@ Horizon Interface
Magnum provides a Horizon plugin so that users can access the Container Magnum provides a Horizon plugin so that users can access the Container
Infrastructure Management service through the OpenStack browser-based Infrastructure Management service through the OpenStack browser-based
graphical UI. The plugin is available from graphical UI. The plugin is available from
`magnum-ui <https://github.com/openstack/magnum-ui>`_. It is not `magnum-ui <https://opendev.org/openstack/magnum-ui>`_. It is not
installed by default in the standard Horizon service, but you can installed by default in the standard Horizon service, but you can
follow the instruction for `installing a Horizon plugin follow the instruction for `installing a Horizon plugin
<http://docs.openstack.org/developer/horizon/tutorials/ <https://docs.openstack.org/horizon/latest/contributor/tutorials/plugin.html#installing-your-plugin>`_.
plugin.html#installing-your-plugin>`_.
In Horizon, the container infrastructure panel is part of the In Horizon, the container infrastructure panel is part of the
'Project' view and it currently supports the following operations: 'Project' view and it currently supports the following operations:
@ -1015,8 +1014,7 @@ look for the attribute *coe_version* and *container_version*::
Kubernetes Kubernetes
========== ==========
Kubernetes uses a range of terminology that we refer to in this guide. We Kubernetes uses a range of terminology that we refer to in this guide. We
define these common terms in the `Glossary define these common terms in the :ref:`Glossary` for your reference.
<https://docs.openstack.org/magnum/latest/glossary.html>`_ for your reference.
When Magnum deploys a Kubernetes cluster, it uses parameters defined in the When Magnum deploys a Kubernetes cluster, it uses parameters defined in the
ClusterTemplate and specified on the cluster-create command, for example:: ClusterTemplate and specified on the cluster-create command, for example::
@ -1757,6 +1755,8 @@ _`mesos_slave_executor_env_variables`
variables. variables.
.. _building_mesos_image:
Building Mesos image Building Mesos image
-------------------- --------------------
@ -1774,7 +1774,7 @@ Diskimage-builder
+++++++++++++++++ +++++++++++++++++
To run the `diskimage-builder To run the `diskimage-builder
<http://docs.openstack.org/developer/diskimage-builder>`__ tool <https://docs.openstack.org/diskimage-builder/latest>`__ tool
manually, use the provided `elements manually, use the provided `elements
<https://opendev.org/openstack/magnum/src/branch/master/magnum/drivers/mesos_ubuntu_v1/image/mesos/>`__. <https://opendev.org/openstack/magnum/src/branch/master/magnum/drivers/mesos_ubuntu_v1/image/mesos/>`__.
Following are the typical steps to use the diskimage-builder tool on Following are the typical steps to use the diskimage-builder tool on
@ -1784,10 +1784,10 @@ an Ubuntu server::
$ sudo apt-get install git qemu-utils python-pip $ sudo apt-get install git qemu-utils python-pip
$ sudo pip install diskimage-builder $ sudo pip install diskimage-builder
$ git clone https://git.openstack.org/openstack/magnum $ git clone https://opendev.org/openstack/magnum
$ git clone https://git.openstack.org/openstack/dib-utils.git $ git clone https://opendev.org/openstack/dib-utils.git
$ git clone https://git.openstack.org/openstack/tripleo-image-elements.git $ git clone https://opendev.org/openstack/tripleo-image-elements.git
$ git clone https://git.openstack.org/openstack/heat-templates.git $ git clone https://opendev.org/openstack/heat-templates.git
$ export PATH="${PWD}/dib-utils/bin:$PATH" $ export PATH="${PWD}/dib-utils/bin:$PATH"
$ export ELEMENTS_PATH=tripleo-image-elements/elements:heat-templates/hot/software-config/elements:magnum/magnum/drivers/mesos_ubuntu_v1/image/mesos $ export ELEMENTS_PATH=tripleo-image-elements/elements:heat-templates/hot/software-config/elements:magnum/magnum/drivers/mesos_ubuntu_v1/image/mesos
$ export DIB_RELEASE=trusty $ export DIB_RELEASE=trusty
@ -1806,7 +1806,7 @@ provided `Dockerfile
The output image will be saved as '/tmp/ubuntu-mesos.qcow2'. The output image will be saved as '/tmp/ubuntu-mesos.qcow2'.
Following are the typical steps to run a Docker container to build the image:: Following are the typical steps to run a Docker container to build the image::
$ git clone https://git.openstack.org/openstack/magnum $ git clone https://opendev.org/openstack/magnum
$ cd magnum/magnum/drivers/mesos_ubuntu_v1/image $ cd magnum/magnum/drivers/mesos_ubuntu_v1/image
$ sudo docker build -t magnum/mesos-builder . $ sudo docker build -t magnum/mesos-builder .
$ sudo docker run -v /tmp:/output --rm -ti --privileged magnum/mesos-builder $ sudo docker run -v /tmp:/output --rm -ti --privileged magnum/mesos-builder
@ -1849,6 +1849,7 @@ For example, you can 'post' a JSON app description to
$ curl -X POST -H "Content-Type: application/json" \ $ curl -X POST -H "Content-Type: application/json" \
http://${API_ADDRESS}:8080/v2/apps -d@app.json http://${API_ADDRESS}:8080/v2/apps -d@app.json
.. _transport_layer_security:
Transport Layer Security Transport Layer Security
======================== ========================
@ -2918,7 +2919,7 @@ This image can be downloaded from the `public Atomic site
<https://alt.fedoraproject.org/pub/alt/atomic/stable/Cloud-Images/x86_64/Images/>`_ <https://alt.fedoraproject.org/pub/alt/atomic/stable/Cloud-Images/x86_64/Images/>`_
or can be built locally using diskimagebuilder. Details can be found in the or can be built locally using diskimagebuilder. Details can be found in the
`fedora-atomic element `fedora-atomic element
<https://github.com/openstack/magnum/tree/master/magnum/elements/fedora-atomic>`_ <https://opendev.org/openstack/magnum/src/branch/master/magnum/drivers/k8s_fedora_atomic_v1>`_
The image currently has the following OS/software: The image currently has the following OS/software:
+--------------------------+-----------+ +--------------------------+-----------+
@ -2996,7 +2997,7 @@ Kubernetes on Ironic
This image is built manually using diskimagebuilder. The scripts and This image is built manually using diskimagebuilder. The scripts and
instructions are included in `Magnum code repo instructions are included in `Magnum code repo
<https://github.com/openstack/magnum/tree/master/magnum/templates/kubernetes/elements>`_. <https://opendev.org/openstack/magnum/src/branch/master/magnum/drivers/k8s_fedora_ironic_v1>`_.
Currently Ironic is not fully supported yet, therefore more details will be Currently Ironic is not fully supported yet, therefore more details will be
provided when this driver has been fully tested. provided when this driver has been fully tested.
@ -3048,7 +3049,7 @@ capabilities for compliance with security, operational, and business processes
and supports normalized and categorized event data for federation and and supports normalized and categorized event data for federation and
aggregation. aggregation.
.. _PyCADF: http://docs.openstack.org/developer/pycadf .. _PyCADF: https://docs.openstack.org/pycadf
.. _CADF: http://www.dmtf.org/standards/cadf .. _CADF: http://www.dmtf.org/standards/cadf
Below table describes the event model components and semantics for Below table describes the event model components and semantics for

4
doc/source/user/kubernetes-load-balancer.rst
View File

@ -128,8 +128,8 @@ Create a file (e.g nginx-service.yaml) describing a service for the nginx pod::
app: nginx app: nginx
type: LoadBalancer type: LoadBalancer
Please refer to the `quickstart <https://docs.openstack.org/developer/magnum/ Please refer to :ref:`quickstart` on how to connect to Kubernetes
userguide.html>`_ guide on how to connect to Kubernetes running on the launched running on the launched
cluster. Assuming a Kubernetes cluster named k8sclusterv1 has been created, cluster. Assuming a Kubernetes cluster named k8sclusterv1 has been created,
deploy the pod and service using following commands:: deploy the pod and service using following commands::