zuul
/
nodepool
Code Issues Proposed changes

Fix openshift doc attribute hierarchy 

The entire provider.pools.labels configuration attribute hierarchy was
outdented one level in the openshift and openshiftpods documentation,
causing it to incorrectly appear as provider.labels.  This change
corrects this and any existing references.

Change-Id: I6b682a05bc1d7622038ea6c62935259f0cffc585
This commit is contained in:
James E. Blair 2023-01-25 11:07:52 -08:00
parent ad7bf9aaeb
commit 89f8d7a000
2 changed files with 202 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/openshift-pods.rst
View File

@ -181,5 +181,3 @@ Selecting the openshift pods driver adds the following options to the
A map of key-value pairs to ensure the OpenShift scheduler
places the Pod on a node with specific node labels.

14
doc/source/openshift.rst
View File

@ -18,7 +18,7 @@ Selecting the openshift driver adds the following options to the
An Openshift provider's resources are partitioned into groups called `pool`
(see :attr:`providers.[openshift].pools` for details), and within a pool,
the node types which are to be made available are listed
(see :attr:`providers.[openshift].labels` for details).
(see :attr:`providers.[openshift].pools.labels` for details).
.. note:: For documentation purposes the option names are prefixed
``providers.[openshift]`` to disambiguate from other
@ -126,14 +126,14 @@ Selecting the openshift driver adds the following options to the
Pod labels provide a new dedicated project with a single
pod created using the
:attr:`providers.[openshift].labels.image` parameter and it
:attr:`providers.[openshift].pools.labels.image` parameter and it
is configured with a service account that can exec and get
the logs of the pod.
.. attr:: image
Only used by the
:value:`providers.[openshift].labels.type.pod` label type;
:value:`providers.[openshift].pools.labels.type.pod` label type;
specifies the image name used by the pod.
.. attr:: image-pull
@ -188,14 +188,14 @@ Selecting the openshift driver adds the following options to the
:type: int
Only used by the
:value:`providers.[openshift].labels.type.pod` label type;
:value:`providers.[openshift].pools.labels.type.pod` label type;
specifies the number of cpu to request for the pod.
.. attr:: memory
:type: int
Only used by the
:value:`providers.[openshift].labels.type.pod` label type;
:value:`providers.[openshift].pools.labels.type.pod` label type;
specifies the amount of memory in MiB to request for the pod.
.. attr:: env
@ -203,7 +203,7 @@ Selecting the openshift driver adds the following options to the
:default: []
Only used by the
:value:`providers.[openshift].labels.type.pod` label type;
:value:`providers.[openshift].pools.labels.type.pod` label type;
A list of environment variables to pass to the Pod.
.. attr:: name
@ -222,6 +222,6 @@ Selecting the openshift driver adds the following options to the
:type: dict
Only used by the
:value:`providers.[openshift].labels.type.pod` label type;
:value:`providers.[openshift].pools.labels.type.pod` label type;
A map of key-value pairs to ensure the OpenShift scheduler
places the Pod on a node with specific node labels.