Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / container_v1.projects.zones.clusters.html
blob: 2f8e9547f828caa9d1c3b6ffdfb5f25982d95a62 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]78 <code><a href="container_v1.projects.zones.clusters.nodePools.html">nodePools()</a></code>
79</p>
80<p class="firstline">Returns the nodePools Resource.</p>
81
82<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83 <code><a href="#create">create(projectId, zone, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]84<p class="firstline">Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="toc_element">
86 <code><a href="#delete">delete(projectId, zone, clusterId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]87<p class="firstline">Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#get">get(projectId, zone, clusterId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]90<p class="firstline">Gets the details of a specific cluster.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]91<p class="toc_element">
92 <code><a href="#list">list(projectId, zone, x__xgafv=None)</a></code></p>
93<p class="firstline">Lists all clusters owned by a project in either the specified zone or all zones.</p>
94<p class="toc_element">
95 <code><a href="#update">update(projectId, zone, clusterId, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]96<p class="firstline">Updates the settings of a specific cluster.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]97<h3>Method Details</h3>
98<div class="method">
99 <code class="details" id="create">create(projectId, zone, body, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]100 <pre>Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the cluster creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range is being used by the cluster.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101
102Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]103 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
105 body: object, The request body. (required)
106 The object takes the form of:
107
108{ # CreateClusterRequest creates a cluster.
109 "cluster": { # A Google Container Engine cluster. # A [cluster resource](/container-engine/reference/rest/v1/projects.zones.clusters)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]110 "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
111 "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
112 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
113 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
114 },
115 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
116 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
117 },
118 },
119 "locations": [ # The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
120 "A String",
121 ],
122 "network": "A String", # The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
123 "loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]124 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
125 "A String",
126 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]127 "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
128 "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
129 "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
130 "status": "A String", # [Output only] The current status of this cluster.
131 "description": "A String", # An optional description of this cluster.
132 "currentNodeVersion": "A String", # [Output only] The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]133 "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]134 "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint.
135 "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
136 "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password.
137 "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
138 "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
139 "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]140 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]141 "initialNodeCount": 42, # The number of nodes to create in this cluster. 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. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.
142 "nodePools": [ # The node pools associated with this cluster. When creating a new cluster, only a single node pool should be specified. This field should not be set if "node_config" or "initial_node_count" are specified.
143 { # 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.
144 "status": "A String", # The status of the nodes in this pool instance.
145 "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
146 "name": "A String", # The name of the node pool.
147 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
148 "A String",
149 ],
150 "version": "A String", # The version of the Kubernetes of this node.
151 "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.
152 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
153 "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.
154 "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`.
155 "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.
156 "A String",
157 ],
158 "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.
159 "a_key": "A String",
160 },
161 },
162 "selfLink": "A String", # Server-defined URL for the resource.
163 },
164 ],
165 "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used.
166 "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
167 "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
168 "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster.
169 "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
170 "initialClusterVersion": "A String", # [Output only] The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.
171 "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 "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.
173 "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`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]174 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]175 "A String",
176 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]177 "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.
178 "a_key": "A String",
179 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]181 "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]182 "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]183 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]184 },
185 }
186
187 x__xgafv: string, V1 error format.
188
189Returns:
190 An object of the form:
191
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]192 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]193 "status": "A String", # The current status of the operation.
194 "name": "A String", # The server-assigned ID for the operation.
195 "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]196 "detail": "A String", # Detailed operation progress, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]197 "selfLink": "A String", # Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]198 "operationType": "A String", # The operation type.
199 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]200 "targetLink": "A String", # Server-defined URL for the target of the operation.
201 }</pre>
202</div>
203
204<div class="method">
205 <code class="details" id="delete">delete(projectId, zone, clusterId, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]206 <pre>Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster (e.g. load balancer resources) will not be deleted if they weren't present at the initial create time.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]207
208Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]209 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]210 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
211 clusterId: string, The name of the cluster to delete. (required)
212 x__xgafv: string, V1 error format.
213
214Returns:
215 An object of the form:
216
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]217 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]218 "status": "A String", # The current status of the operation.
219 "name": "A String", # The server-assigned ID for the operation.
220 "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]221 "detail": "A String", # Detailed operation progress, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]222 "selfLink": "A String", # Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]223 "operationType": "A String", # The operation type.
224 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]225 "targetLink": "A String", # Server-defined URL for the target of the operation.
226 }</pre>
227</div>
228
229<div class="method">
230 <code class="details" id="get">get(projectId, zone, clusterId, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]231 <pre>Gets the details of a specific cluster.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]232
233Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]234 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]235 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
236 clusterId: string, The name of the cluster to retrieve. (required)
237 x__xgafv: string, V1 error format.
238
239Returns:
240 An object of the form:
241
242 { # A Google Container Engine cluster.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]243 "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
244 "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
245 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
246 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
247 },
248 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
249 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
250 },
251 },
252 "locations": [ # The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
253 "A String",
254 ],
255 "network": "A String", # The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
256 "loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]257 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
258 "A String",
259 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]260 "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
261 "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
262 "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
263 "status": "A String", # [Output only] The current status of this cluster.
264 "description": "A String", # An optional description of this cluster.
265 "currentNodeVersion": "A String", # [Output only] The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]266 "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]267 "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint.
268 "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
269 "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password.
270 "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
271 "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
272 "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]273 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]274 "initialNodeCount": 42, # The number of nodes to create in this cluster. 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. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.
275 "nodePools": [ # The node pools associated with this cluster. When creating a new cluster, only a single node pool should be specified. This field should not be set if "node_config" or "initial_node_count" are specified.
276 { # 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.
277 "status": "A String", # The status of the nodes in this pool instance.
278 "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
279 "name": "A String", # The name of the node pool.
280 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
281 "A String",
282 ],
283 "version": "A String", # The version of the Kubernetes of this node.
284 "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.
285 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
286 "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.
287 "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`.
288 "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.
289 "A String",
290 ],
291 "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.
292 "a_key": "A String",
293 },
294 },
295 "selfLink": "A String", # Server-defined URL for the resource.
296 },
297 ],
298 "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used.
299 "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
300 "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
301 "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster.
302 "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
303 "initialClusterVersion": "A String", # [Output only] The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.
304 "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]305 "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.
306 "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`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]307 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]308 "A String",
309 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]310 "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.
311 "a_key": "A String",
312 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]313 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]314 "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]315 "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]316 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]317 }</pre>
318</div>
319
320<div class="method">
321 <code class="details" id="list">list(projectId, zone, x__xgafv=None)</code>
322 <pre>Lists all clusters owned by a project in either the specified zone or all zones.
323
324Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]325 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]326 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. (required)
327 x__xgafv: string, V1 error format.
328
329Returns:
330 An object of the form:
331
332 { # ListClustersResponse is the result of ListClustersRequest.
333 "clusters": [ # A list of clusters in the project in the specified zone, or across all ones.
334 { # A Google Container Engine cluster.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]335 "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range.
336 "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
337 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
338 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
339 },
340 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
341 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
342 },
343 },
344 "locations": [ # The list of Google Compute Engine [locations](/compute/docs/zones#available) in which the cluster's nodes should be located.
345 "A String",
346 ],
347 "network": "A String", # The name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
348 "loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com` - the Google Cloud Logging service. * `none` - no logs will be exported from the cluster. * if left as an empty string,`logging.googleapis.com` will be used.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]349 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
350 "A String",
351 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]352 "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
353 "statusMessage": "A String", # [Output only] Additional information about the current status of this cluster, if available.
354 "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
355 "status": "A String", # [Output only] The current status of this cluster.
356 "description": "A String", # An optional description of this cluster.
357 "currentNodeVersion": "A String", # [Output only] The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]358 "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]359 "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint.
360 "username": "A String", # The username to use for HTTP basic authentication to the master endpoint.
361 "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password.
362 "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
363 "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
364 "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]365 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]366 "initialNodeCount": 42, # The number of nodes to create in this cluster. 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. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.
367 "nodePools": [ # The node pools associated with this cluster. When creating a new cluster, only a single node pool should be specified. This field should not be set if "node_config" or "initial_node_count" are specified.
368 { # 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.
369 "status": "A String", # The status of the nodes in this pool instance.
370 "statusMessage": "A String", # [Output only] Additional information about the current status of this node pool instance, if available.
371 "name": "A String", # The name of the node pool.
372 "instanceGroupUrls": [ # [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this node pool.
373 "A String",
374 ],
375 "version": "A String", # The version of the Kubernetes of this node.
376 "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.
377 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
378 "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.
379 "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`.
380 "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.
381 "A String",
382 ],
383 "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.
384 "a_key": "A String",
385 },
386 },
387 "selfLink": "A String", # Server-defined URL for the resource.
388 },
389 ],
390 "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com` - the Google Cloud Monitoring service. * `none` - no metrics will be exported from the cluster. * if left as an empty string, `monitoring.googleapis.com` will be used.
391 "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
392 "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
393 "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster.
394 "name": "A String", # The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
395 "initialClusterVersion": "A String", # [Output only] The software version of the master endpoint and kubelets used in the cluster when it was first created. The version can be upgraded over time.
396 "nodeConfig": { # Parameters that describe the nodes in a cluster. # Parameters used in creating the cluster's nodes. See `nodeConfig` for the description of its properties. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]397 "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.
398 "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`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]399 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]400 "A String",
401 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]402 "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.
403 "a_key": "A String",
404 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]405 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]406 "clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]407 "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](/compute/docs/subnetworks) to which the cluster is connected.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]408 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]409 },
410 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]411 "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.
412 "A String",
413 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]414 }</pre>
415</div>
416
417<div class="method">
418 <code class="details" id="update">update(projectId, zone, clusterId, body, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]419 <pre>Updates the settings of a specific cluster.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]420
421Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]422 projectId: string, The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]423 zone: string, The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. (required)
424 clusterId: string, The name of the cluster to upgrade. (required)
425 body: object, The request body. (required)
426 The object takes the form of:
427
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]428{ # UpdateClusterRequest updates the settings of a cluster.
429 "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # A description of the update.
430 "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
431 "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if the "desired_node_version" or "desired_image_family" is specified and there is more than one node pool on the cluster.
432 "desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an upgrade). Use `-` to upgrade to the latest version supported by the server.
433 "desiredMonitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster
434 "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
435 "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
436 "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
437 },
438 "horizontalPodAutoscaling": { # Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. # Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
439 "disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.
440 },
441 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]442 },
443 }
444
445 x__xgafv: string, V1 error format.
446
447Returns:
448 An object of the form:
449
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]450 { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]451 "status": "A String", # The current status of the operation.
452 "name": "A String", # The server-assigned ID for the operation.
453 "zone": "A String", # The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the operation is taking place.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]454 "detail": "A String", # Detailed operation progress, if available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]455 "selfLink": "A String", # Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]456 "operationType": "A String", # The operation type.
457 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]458 "targetLink": "A String", # Server-defined URL for the target of the operation.
459 }</pre>
460</div>
461
462</body></html>