From 2153287a6d5b8390bf92ca6ac9a2a955296aeff0 Mon Sep 17 00:00:00 2001 From: Alexandra Settle Date: Thu, 12 Sep 2019 14:57:15 +0100 Subject: [PATCH] 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: Ie3fab1afc5b2958819b74c39a0e492fd7da5d6a3 Backports: stein rocky Signed-off-by: Alexandra Settle --- doc/source/admin/troubleshooting-guide.rst | 45 +++------------------- doc/source/user/glossary.rst | 17 ++++---- doc/source/user/index.rst | 14 +++---- 3 files changed, 20 insertions(+), 56 deletions(-) diff --git a/doc/source/admin/troubleshooting-guide.rst b/doc/source/admin/troubleshooting-guide.rst index 58d7135609..9832cb1fcc 100644 --- a/doc/source/admin/troubleshooting-guide.rst +++ b/doc/source/admin/troubleshooting-guide.rst @@ -115,8 +115,8 @@ 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 -`_. +please refer to +`Create a trustee user for each bay `_. If Magnum fails to create the trustee, check the magnum config file (usually in /etc/magnum/magnum.conf). Make sure 'trustee_*' and 'www_authenticate_uri' @@ -670,8 +670,9 @@ Kubernetes services (How to introspect k8s when heat works and k8s does not) -Additional `Kubernetes troubleshooting guide -`_ is available. +Additional `Kubernetes troubleshooting section +`_ +is available in the Monitoring, Logging, and Debugging section. Swarm services -------------- @@ -715,10 +716,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 \ @@ -796,35 +795,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 `_. - - * 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 `` and run it. - - * Parameters can be found in `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 `_: - - * 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 diff --git a/doc/source/user/glossary.rst b/doc/source/user/glossary.rst index f27aaa7086..8a33486daf 100644 --- a/doc/source/user/glossary.rst +++ b/doc/source/user/glossary.rst @@ -55,9 +55,8 @@ Pod smallest deployable unit that can be created and managed. A pod is a 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 - `_ in the `Kubernetes - User Guide`_ for more information. + `pods section `_ in + `Kubernetes Tasks`_ for more information. Replication controller A replication controller is used to ensure that at any given time a certain @@ -65,8 +64,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 - `_ in - the `Kubernetes User Guide`_ for more information. + `_ in + the `Kubernetes Tasks`_ for more information. Service A service is an additional layer of abstraction provided by the Kubernetes @@ -75,8 +74,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 - `_ in the - `Kubernetes User Guide`_ for more information. - -.. _Kubernetes User Guide: http://kubernetes.io/v1.0/docs/user-guide/ + `_ in + `Kubernetes Concepts`_ for more information. +.. _Kubernetes Tasks: https://kubernetes.io/docs/tasks/ +.. _Kubernetes Concepts: https://kubernetes.io/docs/concepts/ diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 83bb2b874a..599cf76a16 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -1110,7 +1110,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 - `_. + `_. The default value corresponds to the one recommended in this doc for our current Kubernetes version. @@ -1566,7 +1566,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 - `_ ) + `_ ) TLS (tls-disabled) Transport Layer Security is enabled by default to secure the Swarm API for @@ -2932,11 +2932,9 @@ Kubernetes on Fedora Atomic --------------------------- This image can be downloaded from the `public Atomic site -`_ +`_ or can be built locally using diskimagebuilder. Details can be found in the -`fedora-atomic element -`_ -The image currently has the following OS/software: +``fedora-atomic element``. The image currently has the following OS/software: +--------------------------+-----------+ | OS/software | version | @@ -3011,9 +3009,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 -`_. +`_. Currently Ironic is not fully supported yet, therefore more details will be provided when this driver has been fully tested.