Class: Google::Container::V1::Cluster
- Inherits:
-
Object
- Object
- Google::Container::V1::Cluster
- Defined in:
- lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb
Overview
A Google Kubernetes Engine cluster.
Defined Under Namespace
Modules: Status
Instance Attribute Summary collapse
-
#addons_config ⇒ Google::Container::V1::AddonsConfig
Configurations for the various addons available to run in the cluster.
-
#cluster_ipv4_cidr ⇒ String
The IP address range of the container pods in this cluster, in CIDR notation (e.g.
10.96.0.0/14
). -
#create_time ⇒ String
[Output only] The time the cluster was created, in RFC3339 text format.
-
#current_master_version ⇒ String
[Output only] The current software version of the master endpoint.
-
#current_node_count ⇒ Integer
[Output only] The number of nodes currently in the cluster.
-
#current_node_version ⇒ String
[Output only] Deprecated, use NodePool.version instead.
-
#description ⇒ String
An optional description of this cluster.
-
#enable_kubernetes_alpha ⇒ true, false
Kubernetes alpha features are enabled on this cluster.
-
#endpoint ⇒ String
[Output only] The IP address of this cluster's master endpoint.
-
#expire_time ⇒ String
[Output only] The time the cluster will be automatically deleted in RFC3339 text format.
-
#initial_cluster_version ⇒ String
The initial Kubernetes version for this cluster.
-
#initial_node_count ⇒ Integer
The number of nodes to create in this cluster.
-
#instance_group_urls ⇒ Array<String>
Deprecated.
-
#ip_allocation_policy ⇒ Google::Container::V1::IPAllocationPolicy
Configuration for cluster IP allocation.
-
#label_fingerprint ⇒ String
The fingerprint of the set of labels for this cluster.
-
#legacy_abac ⇒ Google::Container::V1::LegacyAbac
Configuration for the legacy ABAC authorization mode.
- #location ⇒ String
-
#locations ⇒ Array<String>
The list of Google Compute Engine locations in which the cluster's nodes should be located.
-
#logging_service ⇒ String
The logging service the cluster should use to write logs.
-
#maintenance_policy ⇒ Google::Container::V1::MaintenancePolicy
Configure the maintenance policy for this cluster.
-
#master_auth ⇒ Google::Container::V1::MasterAuth
The authentication information for accessing the master endpoint.
-
#master_authorized_networks_config ⇒ Google::Container::V1::MasterAuthorizedNetworksConfig
The configuration options for master authorized networks feature.
-
#monitoring_service ⇒ String
The monitoring service the cluster should use to write metrics.
-
#name ⇒ String
The name of this cluster.
-
#network ⇒ String
The name of the Google Compute Engine network to which the cluster is connected.
-
#network_config ⇒ Google::Container::V1::NetworkConfig
Configuration for cluster networking.
-
#network_policy ⇒ Google::Container::V1::NetworkPolicy
Configuration options for the NetworkPolicy feature.
-
#node_config ⇒ Google::Container::V1::NodeConfig
Parameters used in creating the cluster's nodes.
-
#node_ipv4_cidr_size ⇒ Integer
[Output only] The size of the address space on each node for hosting containers.
-
#node_pools ⇒ Array<Google::Container::V1::NodePool>
The node pools associated with this cluster.
-
#private_cluster_config ⇒ Google::Container::V1::PrivateClusterConfig
Configuration for private cluster.
-
#resource_labels ⇒ Hash{String => String}
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
-
#self_link ⇒ String
[Output only] Server-defined URL for the resource.
-
#services_ipv4_cidr ⇒ String
[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g.
1.2.3.4/29
). -
#status ⇒ Google::Container::V1::Cluster::Status
[Output only] The current status of this cluster.
-
#status_message ⇒ String
[Output only] Additional information about the current status of this cluster, if available.
-
#subnetwork ⇒ String
The name of the Google Compute Engine subnetwork to which the cluster is connected.
-
#zone ⇒ String
[Output only] The name of the Google Compute Engine zone in which the cluster resides.
Instance Attribute Details
#addons_config ⇒ Google::Container::V1::AddonsConfig
Returns Configurations for the various addons available to run in the cluster.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#cluster_ipv4_cidr ⇒ String
Returns The IP address range of the container pods in this cluster, in
CIDR
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
.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#create_time ⇒ String
Returns [Output only] The time the cluster was created, in RFC3339 text format.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#current_master_version ⇒ String
Returns [Output only] The current software version of the master endpoint.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#current_node_count ⇒ Integer
Returns [Output only] The number of nodes currently in the cluster.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#current_node_version ⇒ String
Returns [Output only] Deprecated, use NodePool.version instead. 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.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#description ⇒ String
Returns An optional description of this cluster.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#enable_kubernetes_alpha ⇒ true, false
Returns Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#endpoint ⇒ String
Returns [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.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#expire_time ⇒ String
Returns [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#initial_cluster_version ⇒ String
Returns The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.
Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:
- "latest": picks the highest valid Kubernetes version
- "1.X": picks the highest valid patch+gke.N patch in the 1.X version
- "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
- "1.X.Y-gke.N": picks an explicit Kubernetes version
- "","-": picks the default Kubernetes version.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#initial_node_count ⇒ Integer
Returns 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.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#instance_group_urls ⇒ Array<String>
Returns Deprecated. Use node_pools.instance_group_urls.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#ip_allocation_policy ⇒ Google::Container::V1::IPAllocationPolicy
Returns Configuration for cluster IP allocation.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#label_fingerprint ⇒ String
Returns The fingerprint of the set of labels for this cluster.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#legacy_abac ⇒ Google::Container::V1::LegacyAbac
Returns Configuration for the legacy ABAC authorization mode.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#location ⇒ String
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#locations ⇒ Array<String>
Returns The list of Google Compute Engine locations in which the cluster's nodes should be located.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#logging_service ⇒ String
Returns 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.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#maintenance_policy ⇒ Google::Container::V1::MaintenancePolicy
Returns Configure the maintenance policy for this cluster.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#master_auth ⇒ Google::Container::V1::MasterAuth
Returns The authentication information for accessing the master endpoint.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#master_authorized_networks_config ⇒ Google::Container::V1::MasterAuthorizedNetworksConfig
Returns The configuration options for master authorized networks feature.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#monitoring_service ⇒ String
Returns 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.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#name ⇒ String
Returns 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.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#network ⇒ String
Returns The name of the Google Compute Engine
network to which the
cluster is connected. If left unspecified, the default
network
will be used.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#network_config ⇒ Google::Container::V1::NetworkConfig
Returns Configuration for cluster networking.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#network_policy ⇒ Google::Container::V1::NetworkPolicy
Returns Configuration options for the NetworkPolicy feature.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#node_config ⇒ Google::Container::V1::NodeConfig
Returns 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.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#node_ipv4_cidr_size ⇒ Integer
Returns [Output only] The size of the address space on each node for hosting
containers. This is provisioned from within the container_ipv4_cidr
range.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#node_pools ⇒ Array<Google::Container::V1::NodePool>
Returns The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#private_cluster_config ⇒ Google::Container::V1::PrivateClusterConfig
Returns Configuration for private cluster.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#resource_labels ⇒ Hash{String => String}
Returns The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#self_link ⇒ String
Returns [Output only] Server-defined URL for the resource.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#services_ipv4_cidr ⇒ String
Returns [Output only] The IP address range of the Kubernetes services in
this cluster, in
CIDR
notation (e.g. 1.2.3.4/29
). Service addresses are
typically put in the last /16
from the container CIDR.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#status ⇒ Google::Container::V1::Cluster::Status
Returns [Output only] The current status of this cluster.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#status_message ⇒ String
Returns [Output only] Additional information about the current status of this cluster, if available.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#subnetwork ⇒ String
Returns The name of the Google Compute Engine subnetwork to which the cluster is connected.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |
#zone ⇒ String
Returns [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb', line 593 class Cluster # The current status of the cluster. module Status # Not set. STATUS_UNSPECIFIED = 0 # The PROVISIONING state indicates the cluster is being created. PROVISIONING = 1 # The RUNNING state indicates the cluster has been created and is fully # usable. RUNNING = 2 # The RECONCILING state indicates that some work is actively being done on # the cluster, such as upgrading the master or node software. Details can # be found in the `statusMessage` field. RECONCILING = 3 # The STOPPING state indicates the cluster is being deleted. STOPPING = 4 # The ERROR state indicates the cluster may be unusable. Details # can be found in the `statusMessage` field. ERROR = 5 # The DEGRADED state indicates the cluster requires user action to restore # full functionality. Details can be found in the `statusMessage` field. DEGRADED = 6 end end |