| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="container_v1.html">Google Container Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.clusters.html">clusters</a> . <a href="container_v1.projects.zones.clusters.nodePools.html">nodePools</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(projectId, zone, clusterId, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a node pool for a cluster.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a node pool from a cluster.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the node pool requested.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(projectId, zone, clusterId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the node pools for a cluster.</p> |
| <p class="toc_element"> |
| <code><a href="#rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Roll back the previously Aborted or Failed NodePool upgrade.</p> |
| <p class="toc_element"> |
| <code><a href="#setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the NodeManagement options for a node pool.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(projectId, zone, clusterId, body, x__xgafv=None)</code> |
| <pre>Creates a node pool for a cluster. |
| |
| Args: |
| projectId: string, The Google Developers Console [project ID or project |
| number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| zone: string, The name of the Google Compute Engine |
| [zone](/compute/docs/zones#available) in which the cluster |
| resides. (required) |
| clusterId: string, The name of the cluster. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # CreateNodePoolRequest creates a node pool for a cluster. |
| "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # The node pool to create. |
| # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| # specification, under the control of the cluster master. They may have a set |
| # of Kubernetes labels applied to them, which may be used to reference them |
| # during pod scheduling. They may also be resized up or down, to accommodate |
| # the workload. |
| "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| # node pool. |
| "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| # pool. If enabled, the nodes in this node pool will be monitored and, if |
| # they fail health checks too many times, an automatic repair action will be |
| # triggered. |
| "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| # the Auto Upgrades will proceed. |
| "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the description of the upgrade. |
| "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the approximate start time for the upgrades, in |
| # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| }, |
| "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| # up to date with the latest release version of Kubernetes. |
| }, |
| "name": "A String", # The name of the node pool. |
| "instanceGroupUrls": [ # [Output only] The resource URLs of [instance |
| # groups](/compute/docs/instance-groups/) associated with this |
| # node pool. |
| "A String", |
| ], |
| "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| # only if a valid configuration is present. |
| # adjust the size of the node pool to the current cluster usage. |
| "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| # max_node_count. |
| "enabled": True or False, # Is autoscaling enabled for this node pool. |
| "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| # has to enough quota to scale up the cluster. |
| }, |
| "version": "A String", # [Output only] The version of the Kubernetes of this node. |
| "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| # is sufficient for this number of instances. You must also have available |
| # firewall and routes quota. |
| "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| "machineType": "A String", # The name of a Google Compute Engine [machine |
| # type](/compute/docs/machine-types) (e.g. |
| # `n1-standard-1`). |
| # |
| # If unspecified, the default machine type is |
| # `n1-standard-1`. |
| "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| # valid sources or targets for network firewalls and are specified by |
| # the client during cluster or node pool creation. Each tag within the list |
| # must comply with RFC1035. |
| "A String", |
| ], |
| "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| # https://cloud.google.com/compute/docs/instances/preemptible for more |
| # inforamtion about preemptible VM instances. |
| "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| # These will added in addition to any default label(s) that |
| # Kubernetes may apply to the node. |
| # In case of conflict in label keys, the applied set may differ depending on |
| # the Kubernetes version -- it's best to assume the behavior is undefined |
| # and conflicts should be avoided. |
| # For more information, including usage and the valid values, see: |
| # http://kubernetes.io/v1.1/docs/user-guide/labels.html |
| "a_key": "A String", |
| }, |
| "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| # no Service Account is specified, the "default" service account is used. |
| "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| # node VMs under the "default" service account. |
| # |
| # The following scopes are recommended, but not required, and by default are |
| # not included: |
| # |
| # * `https://www.googleapis.com/auth/compute` is required for mounting |
| # persistent storage on your nodes. |
| # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| # communicating with **gcr.io** |
| # (the [Google Container Registry](/container-registry/)). |
| # |
| # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| # Monitoring are enabled, in which case their required scopes will be added. |
| "A String", |
| ], |
| "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| # The smallest allowed disk size is 10GB. |
| # |
| # If unspecified, the default disk size is 100GB. |
| "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| # |
| # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| # in length. These are reflected as part of a URL in the metadata server. |
| # Additionally, to avoid ambiguity, keys must not conflict with any other |
| # metadata keys for the project or be one of the four reserved keys: |
| # "instance-template", "kube-env", "startup-script", and "user-data" |
| # |
| # Values are free-form strings, and only have meaning as interpreted by |
| # the image running in the instance. The only restriction placed on them is |
| # that each value's size must be less than or equal to 32 KB. |
| # |
| # The total size of all keys and values must be less than 512 KB. |
| "a_key": "A String", |
| }, |
| "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| # the latest version of it will be used. |
| "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| # |
| # The limit for this value is dependant upon the maximum number of |
| # disks available on a machine per zone. See: |
| # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits |
| # for more information. |
| }, |
| "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| # node pool instance, if available. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This operation resource represents operations that may have happened or are |
| # happening on the cluster. All fields are output only. |
| "status": "A String", # The current status of the operation. |
| "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| "name": "A String", # The server-assigned ID for the operation. |
| "zone": "A String", # The name of the Google Compute Engine |
| # [zone](/compute/docs/zones#available) in which the operation |
| # is taking place. |
| "detail": "A String", # Detailed operation progress, if available. |
| "targetLink": "A String", # Server-defined URL for the target of the operation. |
| "operationType": "A String", # The operation type. |
| "selfLink": "A String", # Server-defined URL for the resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</code> |
| <pre>Deletes a node pool from a cluster. |
| |
| Args: |
| projectId: string, The Google Developers Console [project ID or project |
| number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| zone: string, The name of the Google Compute Engine |
| [zone](/compute/docs/zones#available) in which the cluster |
| resides. (required) |
| clusterId: string, The name of the cluster. (required) |
| nodePoolId: string, The name of the node pool to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This operation resource represents operations that may have happened or are |
| # happening on the cluster. All fields are output only. |
| "status": "A String", # The current status of the operation. |
| "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| "name": "A String", # The server-assigned ID for the operation. |
| "zone": "A String", # The name of the Google Compute Engine |
| # [zone](/compute/docs/zones#available) in which the operation |
| # is taking place. |
| "detail": "A String", # Detailed operation progress, if available. |
| "targetLink": "A String", # Server-defined URL for the target of the operation. |
| "operationType": "A String", # The operation type. |
| "selfLink": "A String", # Server-defined URL for the resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</code> |
| <pre>Retrieves the node pool requested. |
| |
| Args: |
| projectId: string, The Google Developers Console [project ID or project |
| number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| zone: string, The name of the Google Compute Engine |
| [zone](/compute/docs/zones#available) in which the cluster |
| resides. (required) |
| clusterId: string, The name of the cluster. (required) |
| nodePoolId: string, The name of the node pool. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # NodePool contains the name and configuration for a cluster's node pool. |
| # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| # specification, under the control of the cluster master. They may have a set |
| # of Kubernetes labels applied to them, which may be used to reference them |
| # during pod scheduling. They may also be resized up or down, to accommodate |
| # the workload. |
| "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| # node pool. |
| "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| # pool. If enabled, the nodes in this node pool will be monitored and, if |
| # they fail health checks too many times, an automatic repair action will be |
| # triggered. |
| "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| # the Auto Upgrades will proceed. |
| "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the description of the upgrade. |
| "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the approximate start time for the upgrades, in |
| # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| }, |
| "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| # up to date with the latest release version of Kubernetes. |
| }, |
| "name": "A String", # The name of the node pool. |
| "instanceGroupUrls": [ # [Output only] The resource URLs of [instance |
| # groups](/compute/docs/instance-groups/) associated with this |
| # node pool. |
| "A String", |
| ], |
| "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| # only if a valid configuration is present. |
| # adjust the size of the node pool to the current cluster usage. |
| "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| # max_node_count. |
| "enabled": True or False, # Is autoscaling enabled for this node pool. |
| "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| # has to enough quota to scale up the cluster. |
| }, |
| "version": "A String", # [Output only] The version of the Kubernetes of this node. |
| "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| # is sufficient for this number of instances. You must also have available |
| # firewall and routes quota. |
| "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| "machineType": "A String", # The name of a Google Compute Engine [machine |
| # type](/compute/docs/machine-types) (e.g. |
| # `n1-standard-1`). |
| # |
| # If unspecified, the default machine type is |
| # `n1-standard-1`. |
| "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| # valid sources or targets for network firewalls and are specified by |
| # the client during cluster or node pool creation. Each tag within the list |
| # must comply with RFC1035. |
| "A String", |
| ], |
| "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| # https://cloud.google.com/compute/docs/instances/preemptible for more |
| # inforamtion about preemptible VM instances. |
| "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| # These will added in addition to any default label(s) that |
| # Kubernetes may apply to the node. |
| # In case of conflict in label keys, the applied set may differ depending on |
| # the Kubernetes version -- it's best to assume the behavior is undefined |
| # and conflicts should be avoided. |
| # For more information, including usage and the valid values, see: |
| # http://kubernetes.io/v1.1/docs/user-guide/labels.html |
| "a_key": "A String", |
| }, |
| "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| # no Service Account is specified, the "default" service account is used. |
| "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| # node VMs under the "default" service account. |
| # |
| # The following scopes are recommended, but not required, and by default are |
| # not included: |
| # |
| # * `https://www.googleapis.com/auth/compute` is required for mounting |
| # persistent storage on your nodes. |
| # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| # communicating with **gcr.io** |
| # (the [Google Container Registry](/container-registry/)). |
| # |
| # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| # Monitoring are enabled, in which case their required scopes will be added. |
| "A String", |
| ], |
| "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| # The smallest allowed disk size is 10GB. |
| # |
| # If unspecified, the default disk size is 100GB. |
| "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| # |
| # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| # in length. These are reflected as part of a URL in the metadata server. |
| # Additionally, to avoid ambiguity, keys must not conflict with any other |
| # metadata keys for the project or be one of the four reserved keys: |
| # "instance-template", "kube-env", "startup-script", and "user-data" |
| # |
| # Values are free-form strings, and only have meaning as interpreted by |
| # the image running in the instance. The only restriction placed on them is |
| # that each value's size must be less than or equal to 32 KB. |
| # |
| # The total size of all keys and values must be less than 512 KB. |
| "a_key": "A String", |
| }, |
| "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| # the latest version of it will be used. |
| "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| # |
| # The limit for this value is dependant upon the maximum number of |
| # disks available on a machine per zone. See: |
| # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits |
| # for more information. |
| }, |
| "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| # node pool instance, if available. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(projectId, zone, clusterId, x__xgafv=None)</code> |
| <pre>Lists the node pools for a cluster. |
| |
| Args: |
| projectId: string, The Google Developers Console [project ID or project |
| number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| zone: string, The name of the Google Compute Engine |
| [zone](/compute/docs/zones#available) in which the cluster |
| resides. (required) |
| clusterId: string, The name of the cluster. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # ListNodePoolsResponse is the result of ListNodePoolsRequest. |
| "nodePools": [ # A list of node pools for a cluster. |
| { # NodePool contains the name and configuration for a cluster's node pool. |
| # Node pools are a set of nodes (i.e. VM's), with a common configuration and |
| # specification, under the control of the cluster master. They may have a set |
| # of Kubernetes labels applied to them, which may be used to reference them |
| # during pod scheduling. They may also be resized up or down, to accommodate |
| # the workload. |
| "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. |
| # node pool. |
| "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| # pool. If enabled, the nodes in this node pool will be monitored and, if |
| # they fail health checks too many times, an automatic repair action will be |
| # triggered. |
| "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| # the Auto Upgrades will proceed. |
| "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the description of the upgrade. |
| "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the approximate start time for the upgrades, in |
| # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| }, |
| "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| # up to date with the latest release version of Kubernetes. |
| }, |
| "name": "A String", # The name of the node pool. |
| "instanceGroupUrls": [ # [Output only] The resource URLs of [instance |
| # groups](/compute/docs/instance-groups/) associated with this |
| # node pool. |
| "A String", |
| ], |
| "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled |
| # only if a valid configuration is present. |
| # adjust the size of the node pool to the current cluster usage. |
| "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= |
| # max_node_count. |
| "enabled": True or False, # Is autoscaling enabled for this node pool. |
| "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There |
| # has to enough quota to scale up the cluster. |
| }, |
| "version": "A String", # [Output only] The version of the Kubernetes of this node. |
| "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your |
| # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> |
| # is sufficient for this number of instances. You must also have available |
| # firewall and routes quota. |
| "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| "machineType": "A String", # The name of a Google Compute Engine [machine |
| # type](/compute/docs/machine-types) (e.g. |
| # `n1-standard-1`). |
| # |
| # If unspecified, the default machine type is |
| # `n1-standard-1`. |
| "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify |
| # valid sources or targets for network firewalls and are specified by |
| # the client during cluster or node pool creation. Each tag within the list |
| # must comply with RFC1035. |
| "A String", |
| ], |
| "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: |
| # https://cloud.google.com/compute/docs/instances/preemptible for more |
| # inforamtion about preemptible VM instances. |
| "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. |
| # These will added in addition to any default label(s) that |
| # Kubernetes may apply to the node. |
| # In case of conflict in label keys, the applied set may differ depending on |
| # the Kubernetes version -- it's best to assume the behavior is undefined |
| # and conflicts should be avoided. |
| # For more information, including usage and the valid values, see: |
| # http://kubernetes.io/v1.1/docs/user-guide/labels.html |
| "a_key": "A String", |
| }, |
| "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If |
| # no Service Account is specified, the "default" service account is used. |
| "oauthScopes": [ # The set of Google API scopes to be made available on all of the |
| # node VMs under the "default" service account. |
| # |
| # The following scopes are recommended, but not required, and by default are |
| # not included: |
| # |
| # * `https://www.googleapis.com/auth/compute` is required for mounting |
| # persistent storage on your nodes. |
| # * `https://www.googleapis.com/auth/devstorage.read_only` is required for |
| # communicating with **gcr.io** |
| # (the [Google Container Registry](/container-registry/)). |
| # |
| # If unspecified, no scopes are added, unless Cloud Logging or Cloud |
| # Monitoring are enabled, in which case their required scopes will be added. |
| "A String", |
| ], |
| "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. |
| # The smallest allowed disk size is 10GB. |
| # |
| # If unspecified, the default disk size is 100GB. |
| "metadata": { # The metadata key/value pairs assigned to instances in the cluster. |
| # |
| # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes |
| # in length. These are reflected as part of a URL in the metadata server. |
| # Additionally, to avoid ambiguity, keys must not conflict with any other |
| # metadata keys for the project or be one of the four reserved keys: |
| # "instance-template", "kube-env", "startup-script", and "user-data" |
| # |
| # Values are free-form strings, and only have meaning as interpreted by |
| # the image running in the instance. The only restriction placed on them is |
| # that each value's size must be less than or equal to 32 KB. |
| # |
| # The total size of all keys and values must be less than 512 KB. |
| "a_key": "A String", |
| }, |
| "imageType": "A String", # The image type to use for this node. Note that for a given image type, |
| # the latest version of it will be used. |
| "localSsdCount": 42, # The number of local SSD disks to be attached to the node. |
| # |
| # The limit for this value is dependant upon the maximum number of |
| # disks available on a machine per zone. See: |
| # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits |
| # for more information. |
| }, |
| "statusMessage": "A String", # [Output only] Additional information about the current status of this |
| # node pool instance, if available. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> |
| <pre>Roll back the previously Aborted or Failed NodePool upgrade. |
| This will be an no-op if the last upgrade successfully completed. |
| |
| Args: |
| projectId: string, The Google Developers Console [project ID or project |
| number](https://support.google.com/cloud/answer/6158840). (required) |
| zone: string, The name of the Google Compute Engine |
| [zone](/compute/docs/zones#available) in which the cluster |
| resides. (required) |
| clusterId: string, The name of the cluster to rollback. (required) |
| nodePoolId: string, The name of the node pool to rollback. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed |
| # NodePool upgrade. This will be an no-op if the last upgrade successfully |
| # completed. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This operation resource represents operations that may have happened or are |
| # happening on the cluster. All fields are output only. |
| "status": "A String", # The current status of the operation. |
| "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| "name": "A String", # The server-assigned ID for the operation. |
| "zone": "A String", # The name of the Google Compute Engine |
| # [zone](/compute/docs/zones#available) in which the operation |
| # is taking place. |
| "detail": "A String", # Detailed operation progress, if available. |
| "targetLink": "A String", # Server-defined URL for the target of the operation. |
| "operationType": "A String", # The operation type. |
| "selfLink": "A String", # Server-defined URL for the resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> |
| <pre>Sets the NodeManagement options for a node pool. |
| |
| Args: |
| projectId: string, The Google Developers Console [project ID or project |
| number](https://support.google.com/cloud/answer/6158840). (required) |
| zone: string, The name of the Google Compute Engine |
| [zone](/compute/docs/zones#available) in which the cluster |
| resides. (required) |
| clusterId: string, The name of the cluster to update. (required) |
| nodePoolId: string, The name of the node pool to update. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # SetNodePoolManagementRequest sets the node management properties of a node |
| # pool. |
| "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for the node pool. |
| # node pool. |
| "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node |
| # pool. If enabled, the nodes in this node pool will be monitored and, if |
| # they fail health checks too many times, an automatic repair action will be |
| # triggered. |
| "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. |
| # the Auto Upgrades will proceed. |
| "description": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the description of the upgrade. |
| "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence |
| # with the approximate start time for the upgrades, in |
| # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| }, |
| "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node |
| # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool |
| # up to date with the latest release version of Kubernetes. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This operation resource represents operations that may have happened or are |
| # happening on the cluster. All fields are output only. |
| "status": "A String", # The current status of the operation. |
| "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| "name": "A String", # The server-assigned ID for the operation. |
| "zone": "A String", # The name of the Google Compute Engine |
| # [zone](/compute/docs/zones#available) in which the operation |
| # is taking place. |
| "detail": "A String", # Detailed operation progress, if available. |
| "targetLink": "A String", # Server-defined URL for the target of the operation. |
| "operationType": "A String", # The operation type. |
| "selfLink": "A String", # Server-defined URL for the resource. |
| }</pre> |
| </div> |
| |
| </body></html> |