Merge "Expose nodepool slot attribute"

1 files changed, 62 insertions, 0 deletions

diff --git a/doc/source/job-content.rst b/doc/source/job-content.rst
index d6bb07683..643632d5b 100644
--- a/doc/source/job-content.rst
+++ b/doc/source/job-content.rst
@@ -669,6 +669,68 @@ of item.
        - shell: echo example
          when: zuul_success | bool
 
+.. var:: nodepool
+
+   Information about each host from Nodepool is supplied in the
+   `nodepool` host variable.  Availability of values varies based on
+   the node and the driver that supplied it.  Values may be ``null``
+   if they are not applicable.
+
+   .. var:: label
+
+      The nodepool label of this node.
+
+   .. var:: az
+
+      The availability zone in which this node was placed.
+
+   .. var:: cloud
+
+      The name of the cloud in which this node was created.
+
+   .. var:: provider
+
+      The name of the nodepool provider of this node.
+
+   .. var:: region
+
+      The name of the nodepool provider's region.
+
+   .. var:: host_id
+
+      The cloud's host identification for this node's hypervisor.
+
+   .. var:: external_id
+
+      The cloud's identifier for this node.
+
+   .. var:: slot
+
+      If the node supports running multiple jobs on the node, a unique
+      numeric ID for the subdivision of the node assigned to this job.
+      This may be used to avoid build directory collisions.
+
+   .. var:: interface_ip
+
+      The best IP address to use to contact the node as determined by
+      the cloud provider and nodepool.
+
+   .. var:: public_ipv4
+
+      A public IPv4 address of the node.
+
+   .. var:: private_ipv4
+
+      A private IPv4 address of the node.
+
+   .. var:: public_ipv6
+
+      A public IPv6 address of the node.
+
+   .. var:: private_ipv6
+
+      A private IPv6 address of the node.
+
 
 Change Items
 ~~~~~~~~~~~~