| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <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> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(projectId, zone, clusterId, body, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a node pool for a cluster.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a node pool from a cluster.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Retrieves the node pool requested.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(projectId, zone, clusterId, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists the node pools for a cluster.</p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Sets the NodeManagement options for a node pool.</p> |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="create">create(projectId, zone, clusterId, body, x__xgafv=None)</code> |
| 98 | <pre>Creates a node pool for a cluster. |
| 99 | |
| 100 | Args: |
| 101 | projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| 102 | zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required) |
| 103 | clusterId: string, The name of the cluster. (required) |
| 104 | body: object, The request body. (required) |
| 105 | The object takes the form of: |
| 106 | |
| 107 | { # CreateNodePoolRequest creates a node pool for a cluster. |
| 108 | "nodePool": { # 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. # The node pool to create. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 109 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 110 | "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available. |
| 111 | "name": "A String", # The name of the node pool. |
| 112 | "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool. |
| 113 | "A String", |
| 114 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 115 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. |
| 116 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. |
| 117 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 118 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster. |
| 119 | }, |
| 120 | "version": "A String", # [Output only] The version of the Kubernetes of this node. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 121 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 122 | "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. |
| 123 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. |
| 124 | "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. |
| 125 | "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. |
| 126 | }, |
| 127 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 128 | }, |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 129 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 130 | "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`. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 131 | "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. |
| 132 | "A String", |
| 133 | ], |
| 134 | "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. |
| 135 | "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 |
| 136 | "a_key": "A String", |
| 137 | }, |
| 138 | "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. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 139 | "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. |
| 140 | "A String", |
| 141 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 142 | "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. |
| 143 | "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. |
| 144 | "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. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 145 | "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. |
| 146 | "a_key": "A String", |
| 147 | }, |
| 148 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 149 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 150 | }, |
| 151 | } |
| 152 | |
| 153 | x__xgafv: string, V1 error format. |
| 154 | |
| 155 | Returns: |
| 156 | An object of the form: |
| 157 | |
| 158 | { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
| 159 | "status": "A String", # The current status of the operation. |
| 160 | "name": "A String", # The server-assigned ID for the operation. |
| 161 | "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. |
| 162 | "detail": "A String", # Detailed operation progress, if available. |
| 163 | "selfLink": "A String", # Server-defined URL for the resource. |
| 164 | "operationType": "A String", # The operation type. |
| 165 | "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| 166 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 167 | }</pre> |
| 168 | </div> |
| 169 | |
| 170 | <div class="method"> |
| 171 | <code class="details" id="delete">delete(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</code> |
| 172 | <pre>Deletes a node pool from a cluster. |
| 173 | |
| 174 | Args: |
| 175 | projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| 176 | zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required) |
| 177 | clusterId: string, The name of the cluster. (required) |
| 178 | nodePoolId: string, The name of the node pool to delete. (required) |
| 179 | x__xgafv: string, V1 error format. |
| 180 | |
| 181 | Returns: |
| 182 | An object of the form: |
| 183 | |
| 184 | { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
| 185 | "status": "A String", # The current status of the operation. |
| 186 | "name": "A String", # The server-assigned ID for the operation. |
| 187 | "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. |
| 188 | "detail": "A String", # Detailed operation progress, if available. |
| 189 | "selfLink": "A String", # Server-defined URL for the resource. |
| 190 | "operationType": "A String", # The operation type. |
| 191 | "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| 192 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 193 | }</pre> |
| 194 | </div> |
| 195 | |
| 196 | <div class="method"> |
| 197 | <code class="details" id="get">get(projectId, zone, clusterId, nodePoolId, x__xgafv=None)</code> |
| 198 | <pre>Retrieves the node pool requested. |
| 199 | |
| 200 | Args: |
| 201 | projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| 202 | zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required) |
| 203 | clusterId: string, The name of the cluster. (required) |
| 204 | nodePoolId: string, The name of the node pool. (required) |
| 205 | x__xgafv: string, V1 error format. |
| 206 | |
| 207 | Returns: |
| 208 | An object of the form: |
| 209 | |
| 210 | { # 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. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 211 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 212 | "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available. |
| 213 | "name": "A String", # The name of the node pool. |
| 214 | "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool. |
| 215 | "A String", |
| 216 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 217 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. |
| 218 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. |
| 219 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 220 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster. |
| 221 | }, |
| 222 | "version": "A String", # [Output only] The version of the Kubernetes of this node. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 223 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 224 | "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. |
| 225 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. |
| 226 | "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. |
| 227 | "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. |
| 228 | }, |
| 229 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 230 | }, |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 231 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 232 | "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`. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 233 | "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. |
| 234 | "A String", |
| 235 | ], |
| 236 | "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. |
| 237 | "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 |
| 238 | "a_key": "A String", |
| 239 | }, |
| 240 | "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. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 241 | "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. |
| 242 | "A String", |
| 243 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 244 | "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. |
| 245 | "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. |
| 246 | "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. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 247 | "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. |
| 248 | "a_key": "A String", |
| 249 | }, |
| 250 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 251 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 252 | }</pre> |
| 253 | </div> |
| 254 | |
| 255 | <div class="method"> |
| 256 | <code class="details" id="list">list(projectId, zone, clusterId, x__xgafv=None)</code> |
| 257 | <pre>Lists the node pools for a cluster. |
| 258 | |
| 259 | Args: |
| 260 | projectId: string, The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). (required) |
| 261 | zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required) |
| 262 | clusterId: string, The name of the cluster. (required) |
| 263 | x__xgafv: string, V1 error format. |
| 264 | |
| 265 | Returns: |
| 266 | An object of the form: |
| 267 | |
| 268 | { # ListNodePoolsResponse is the result of ListNodePoolsRequest. |
| 269 | "nodePools": [ # A list of node pools for a cluster. |
| 270 | { # 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. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 271 | "status": "A String", # [Output only] The status of the nodes in this pool instance. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 272 | "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available. |
| 273 | "name": "A String", # The name of the node pool. |
| 274 | "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool. |
| 275 | "A String", |
| 276 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 277 | "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. |
| 278 | "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count. |
| 279 | "enabled": True or False, # Is autoscaling enabled for this node pool. |
| 280 | "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster. |
| 281 | }, |
| 282 | "version": "A String", # [Output only] The version of the Kubernetes of this node. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 283 | "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 284 | "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. |
| 285 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. |
| 286 | "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. |
| 287 | "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. |
| 288 | }, |
| 289 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 290 | }, |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 291 | "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 292 | "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`. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 293 | "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. |
| 294 | "A String", |
| 295 | ], |
| 296 | "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. |
| 297 | "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 |
| 298 | "a_key": "A String", |
| 299 | }, |
| 300 | "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. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 301 | "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. |
| 302 | "A String", |
| 303 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 304 | "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. |
| 305 | "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. |
| 306 | "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. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 307 | "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. |
| 308 | "a_key": "A String", |
| 309 | }, |
| 310 | }, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 311 | "selfLink": "A String", # [Output only] Server-defined URL for the resource. |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 312 | }, |
| 313 | ], |
| 314 | }</pre> |
| 315 | </div> |
| 316 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 317 | <div class="method"> |
| 318 | <code class="details" id="rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> |
| 319 | <pre>Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. |
| 320 | |
| 321 | Args: |
| 322 | projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required) |
| 323 | zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required) |
| 324 | clusterId: string, The name of the cluster to rollback. (required) |
| 325 | nodePoolId: string, The name of the node pool to rollback. (required) |
| 326 | body: object, The request body. (required) |
| 327 | The object takes the form of: |
| 328 | |
| 329 | { # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed. |
| 330 | } |
| 331 | |
| 332 | x__xgafv: string, V1 error format. |
| 333 | |
| 334 | Returns: |
| 335 | An object of the form: |
| 336 | |
| 337 | { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
| 338 | "status": "A String", # The current status of the operation. |
| 339 | "name": "A String", # The server-assigned ID for the operation. |
| 340 | "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. |
| 341 | "detail": "A String", # Detailed operation progress, if available. |
| 342 | "selfLink": "A String", # Server-defined URL for the resource. |
| 343 | "operationType": "A String", # The operation type. |
| 344 | "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| 345 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 346 | }</pre> |
| 347 | </div> |
| 348 | |
| 349 | <div class="method"> |
| 350 | <code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> |
| 351 | <pre>Sets the NodeManagement options for a node pool. |
| 352 | |
| 353 | Args: |
| 354 | projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required) |
| 355 | zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required) |
| 356 | clusterId: string, The name of the cluster to update. (required) |
| 357 | nodePoolId: string, The name of the node pool to update. (required) |
| 358 | body: object, The request body. (required) |
| 359 | The object takes the form of: |
| 360 | |
| 361 | { # SetNodePoolManagementRequest sets the node management properties of a node pool. |
| 362 | "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for the node pool. |
| 363 | "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. |
| 364 | "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. |
| 365 | "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. |
| 366 | }, |
| 367 | "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. |
| 368 | }, |
| 369 | } |
| 370 | |
| 371 | x__xgafv: string, V1 error format. |
| 372 | |
| 373 | Returns: |
| 374 | An object of the form: |
| 375 | |
| 376 | { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. |
| 377 | "status": "A String", # The current status of the operation. |
| 378 | "name": "A String", # The server-assigned ID for the operation. |
| 379 | "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place. |
| 380 | "detail": "A String", # Detailed operation progress, if available. |
| 381 | "selfLink": "A String", # Server-defined URL for the resource. |
| 382 | "operationType": "A String", # The operation type. |
| 383 | "statusMessage": "A String", # If an error has occurred, a textual description of the error. |
| 384 | "targetLink": "A String", # Server-defined URL for the target of the operation. |
| 385 | }</pre> |
| 386 | </div> |
| 387 | |
| Jon Wayne Parrott | 0a471d3 | 2016-05-19 10:54:38 -0700 | [diff] [blame] | 388 | </body></html> |