Fixing broken links
This also removes reference to the deprecated DevStack gate. A few links have been removed, namely anything relating to /elements/ as it doesn't appear to exist anymore and I cannot find any reference to it. If anyone can point me in the right direction, that would be appreciated. Change-Id: I6daf27e4003e8d781fc4117d63741548100dd030
This commit is contained in:
Alexandra Settle
Alexandra Settle
parent
5554abb0a7
commit
15ba2c8001
|
|
@ -113,8 +113,7 @@ for the cluster. The service account will be used by the cluster to
|
|||
access the OpenStack services (i.e. Neutron, Swift, etc.). A trust relationship
|
||||
will be created between the user who created the cluster (the "trustor") and
|
||||
the service account created for the cluster (the "trustee"). For details,
|
||||
please refer
|
||||
<http://git.openstack.org/cgit/openstack/magnum/tree/specs/create-trustee-user-for-each-cluster.rst>`_.
|
||||
please refer to `Create a trustee user for each bay <https://opendev.org/openstack/magnum/src/branch/master/specs/create-trustee-user-for-each-bay.rst>`_.
|
||||
|
||||
If Magnum fails to create the trustee, check the magnum config file (usually
|
||||
in /etc/magnum/magnum.conf). Make sure 'trustee_*' and 'auth_uri' are set and
|
||||
|
|
@ -667,8 +666,9 @@ Kubernetes services
|
|||
|
||||
(How to introspect k8s when heat works and k8s does not)
|
||||
|
||||
Additional `Kubernetes troubleshooting guide
|
||||
<http://kubernetes.io/v1.0/docs/troubleshooting.html>`_ is available.
|
||||
Additional `Kubernetes troubleshooting section
|
||||
<https://kubernetes.io/docs/tasks/debug-application-cluster/troubleshooting/>`_
|
||||
is available in the Monitoring, Logging, and Debugging section.
|
||||
|
||||
Swarm services
|
||||
--------------
|
||||
|
|
@ -712,10 +712,8 @@ Troubleshooting in Gate
|
|||
-----------------------
|
||||
|
||||
Simulating gate tests
|
||||
*Note*: This is adapted from Devstack Gate's `README`_ which
|
||||
is worth a quick read to better understand the following)
|
||||
|
||||
#. Boot a VM like described in the Devstack Gate's `README`_ .
|
||||
#. Boot a VM.
|
||||
#. Provision this VM like so::
|
||||
|
||||
apt-get update \
|
||||
|
|
@ -793,35 +791,3 @@ Simulating gate tests
|
|||
export -f post_test_hook
|
||||
cp devstack-gate/devstack-vm-gate-wrap.sh ./safe-devstack-vm-gate-wrap.sh
|
||||
./safe-devstack-vm-gate-wrap.sh
|
||||
|
||||
Helpful nuances about the Devstack Gate
|
||||
* Main job is in ``project-config``'s `magnum.yaml <https://github.com/openstack-infra/project-config/blob/master/jenkins/jobs/magnum.yaml>`_.
|
||||
|
||||
* Must modify parameters passed in since those are escaped:
|
||||
|
||||
* Anything with ``{}`` should be set as an environment variable
|
||||
|
||||
* Anything with ``{{ }}`` should have those brackets changed to
|
||||
single brackets - ``{}``.
|
||||
|
||||
* As with the documentation for Devstack Gate, you can just create
|
||||
a new file for the job you want, paste in what you want, then
|
||||
``chmod u+x <filename>`` and run it.
|
||||
|
||||
* Parameters can be found in `projects.yaml <https://github.com/openstack-infra/project-config/blob/master/jenkins/jobs/projects.yaml>`_.
|
||||
This file changes a lot, so it's more reliable to say that you can
|
||||
search for the magnum jobs where you'll see examples of what
|
||||
gets passed in.
|
||||
|
||||
* Three jobs are usually run as a part of Magnum gate, all of which are found in ``project-config``'s `macros.yml <https://github.com/openstack-infra/project-config/blob/master/jenkins/jobs/macros.yaml>`_:
|
||||
|
||||
* link-logs
|
||||
|
||||
* net-info
|
||||
|
||||
* devstack-checkout
|
||||
|
||||
* After you run a job, it's ideal to clean up and start over with a
|
||||
fresh VM to best simulate the Devstack Gate environment.
|
||||
|
||||
.. _README: https://github.com/openstack-infra/devstack-gate/blob/master/README.rst#simulating-devstack-gate-tests P
|
||||
|
|
|
|||
|
|
@ -54,8 +54,8 @@ Pod
|
|||
co-located group of application containers that run with a shared context.
|
||||
When using Magnum, pods are created and managed within clusters. Refer to the
|
||||
`pods section
|
||||
<https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/>`_ in the `Kubernetes
|
||||
User Guide`_ for more information.
|
||||
<https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/>`_ in `Kubernetes Tasks`_
|
||||
for more information.
|
||||
|
||||
Replication controller
|
||||
A replication controller is used to ensure that at any given time a certain
|
||||
|
|
@ -63,8 +63,8 @@ Replication controller
|
|||
deleted by the replication controller as necessary based on a template to
|
||||
ensure that the defined number of replicas exist. Refer to the `replication
|
||||
controller section
|
||||
<http://kubernetes.io/v1.0/docs/user-guide/replication-controller.html>`_ in
|
||||
the `Kubernetes User Guide`_ for more information.
|
||||
<https://kubernetes.io/docs/tasks/run-application/rolling-update-replication-controller/>`_ in
|
||||
the `Kubernetes Tasks`_ for more information.
|
||||
|
||||
Service
|
||||
A service is an additional layer of abstraction provided by the Kubernetes
|
||||
|
|
@ -73,8 +73,8 @@ Service
|
|||
deleted by a replication controller, for example, other pods needing to
|
||||
discover them can do so via the service abstraction. Refer to the
|
||||
`services section
|
||||
<http://kubernetes.io/v1.0/docs/user-guide/services.html>`_ in the
|
||||
`Kubernetes User Guide`_ for more information.
|
||||
|
||||
.. _Kubernetes User Guide: http://kubernetes.io/v1.0/docs/user-guide/
|
||||
<https://kubernetes.io/docs/concepts/services-networking/service/>`_ in
|
||||
`Kubernetes Concepts`_ for more information.
|
||||
|
||||
.. _Kubernetes Tasks: https://kubernetes.io/docs/tasks/
|
||||
.. _Kubernetes Concepts: https://kubernetes.io/docs/concepts/
|
||||
|
|
|
|||
|
|
@ -973,7 +973,7 @@ Kubernetes
|
|||
==========
|
||||
Kubernetes uses a range of terminology that we refer to in this guide. We
|
||||
define these common terms in the `Glossary
|
||||
<https://docs.openstack.org/magnum/latest/glossary.html>`_ for your reference.
|
||||
<https://docs.openstack.org/magnum/latest/user/glossary.html>`_ for your reference.
|
||||
|
||||
When Magnum deploys a Kubernetes cluster, it uses parameters defined in the
|
||||
ClusterTemplate and specified on the cluster-create command, for example::
|
||||
|
|
@ -1065,7 +1065,7 @@ labels attribute.
|
|||
_`admission_control_list`
|
||||
This label corresponds to Kubernetes parameter for the API server '--admission-control'.
|
||||
For more details, refer to the `Admission Controllers
|
||||
<https://kubernetes.io/docs/admin/admission-controllers//>`_.
|
||||
<https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/>`_.
|
||||
The default value corresponds to the one recommended in this doc
|
||||
for our current Kubernetes version.
|
||||
|
||||
|
|
@ -1147,31 +1147,31 @@ _`cert_manager_api`
|
|||
_`kubelet_options`
|
||||
This label can hold any additional options to be passed to the kubelet.
|
||||
For more details, refer to the `kubelet admin guide
|
||||
<https://kubernetes.io/docs/admin/kubelet//>`_.
|
||||
<https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/>`_.
|
||||
By default no additional options are passed.
|
||||
|
||||
_`kubeproxy_options`
|
||||
This label can hold any additional options to be passed to the kube proxy.
|
||||
For more details, refer to the `kube proxy admin guide
|
||||
<https://kubernetes.io/docs/admin/kube-proxy//>`_.
|
||||
<https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/>`_.
|
||||
By default no additional options are passed.
|
||||
|
||||
_`kubecontroller_options`
|
||||
This label can hold any additional options to be passed to the kube controller manager.
|
||||
For more details, refer to the `kube controller manager admin guide
|
||||
<https://kubernetes.io/docs/admin/kube-controller-manager//>`_.
|
||||
<https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/>`_.
|
||||
By default no additional options are passed.
|
||||
|
||||
_`kubeapi_options`
|
||||
This label can hold any additional options to be passed to the kube api server.
|
||||
For more details, refer to the `kube api admin guide
|
||||
<https://kubernetes.io/docs/admin/kube-apiserver//>`_.
|
||||
<https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/>`_.
|
||||
By default no additional options are passed.
|
||||
|
||||
_`kubescheduler_options`
|
||||
This label can hold any additional options to be passed to the kube scheduler.
|
||||
For more details, refer to the `kube scheduler admin guide
|
||||
<https://kubernetes.io/docs/admin/kube-scheduler//>`_.
|
||||
<https://kubernetes.io/docs/reference/command-line-tools-reference/kube-scheduler/>`_.
|
||||
By default no additional options are passed.
|
||||
|
||||
_`influx_grafana_dashboard_enabled`
|
||||
|
|
@ -1398,7 +1398,7 @@ Image (image)
|
|||
The image binary is loaded in Glance with the attribute
|
||||
'os_distro = fedora-atomic'.
|
||||
Current supported image is Fedora Atomic (download from `Fedora
|
||||
<https://alt.fedoraproject.org/pub/alt/atomic/stable/Cloud-Images/x86_64/Images>`_ )
|
||||
<https://dl.fedoraproject.org/pub/alt/atomic/stable/>`_ )
|
||||
|
||||
TLS (tls-disabled)
|
||||
Transport Layer Security is enabled by default to secure the Swarm API for
|
||||
|
|
@ -2762,11 +2762,9 @@ Kubernetes on Fedora Atomic
|
|||
---------------------------
|
||||
|
||||
This image can be downloaded from the `public Atomic site
|
||||
<https://alt.fedoraproject.org/pub/alt/atomic/stable/Cloud-Images/x86_64/Images/>`_
|
||||
<https://dl.fedoraproject.org/pub/alt/atomic/stable/>`_
|
||||
or can be built locally using diskimagebuilder. Details can be found in the
|
||||
`fedora-atomic element
|
||||
<https://github.com/openstack/magnum/tree/master/magnum/elements/fedora-atomic>`_
|
||||
The image currently has the following OS/software:
|
||||
``fedora-atomic element``. The image currently has the following OS/software:
|
||||
|
||||
+--------------------------+-----------+
|
||||
| OS/software | version |
|
||||
|
|
@ -2841,9 +2839,9 @@ The login for this image is *core*.
|
|||
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
|
||||
<https://github.com/openstack/magnum/tree/master/magnum/templates/kubernetes/elements>`_.
|
||||
<https://github.com/openstack/magnum/>`_.
|
||||
Currently Ironic is not fully supported yet, therefore more details will be
|
||||
provided when this driver has been fully tested.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue