Class: Ansible::Ruby::Modules::Gcp_container_cluster

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb

Overview

A Google Container Engine cluster.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#addons_config ⇒ Object?

Returns Configurations for the various addons available to run in the cluster.

Returns:

  • (Object, nil) —

    Configurations for the various addons available to run in the cluster.



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 49

attribute :addons_config

#cluster_ipv4_cidr ⇒ Object?

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.

Returns:

  • (Object, nil) —

    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.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 46

attribute :cluster_ipv4_cidr

#description ⇒ Object?

Returns An optional description of this cluster.

Returns:

  • (Object, nil) —

    An optional description of this cluster.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 20

attribute :description

#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 “nodePool” object, since this configuration (along with the “nodeConfig”) will be used to create a “NodePool” object with an auto-generated name. Do not use this and a nodePool at the same time.

Returns:

  • (Integer) —

    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 “nodePool” object, since this configuration (along with the “nodeConfig”) will be used to create a “NodePool” object with an auto-generated name. Do not use this and a nodePool at the same time.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 23

attribute :initial_node_count

#location ⇒ Object?

Returns The list of Google Compute Engine locations in which the cluster’s nodes should be located.

Returns:

  • (Object, nil) —

    The list of Google Compute Engine locations in which the cluster’s nodes should be located.



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 55

attribute :location

#logging_service ⇒ :"logging.googleapis.com", ...

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.

Returns:

  • (:"logging.googleapis.com", :none, nil) —

    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.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 35

attribute :logging_service

#master_auth ⇒ Hash?

Returns The authentication information for accessing the master endpoint.

Returns:

  • (Hash, nil) —

    The authentication information for accessing the master endpoint.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 31

attribute :master_auth

#monitoring_service ⇒ :"monitoring.googleapis.com", ...

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.

Returns:

  • (:"monitoring.googleapis.com", :none, nil) —

    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.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 39

attribute :monitoring_service

#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. Must be Lowercase letters, numbers, and hyphens only. Must start with a letter. Must end with a number or a letter.

Returns:

  • (String, nil) —

    The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters. Must be Lowercase letters, numbers, and hyphens only. Must start with a letter. Must end with a number or a letter.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 16

attribute :name

#network ⇒ Object?

Returns The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.,To ensure it exists and it is operations, configure the network using ‘gcompute_network’ resource.

Returns:

  • (Object, nil) —

    The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.,To ensure it exists and it is operations, configure the network using ‘gcompute_network’ resource.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 43

attribute :network

#node_config ⇒ Hash?

Returns Parameters used in creating the cluster’s nodes.,For requests, this field should only be used in lieu of a “nodePool” object, since this configuration (along with the “initialNodeCount”) will be used to create a “NodePool” object with an auto-generated name. Do not use this and a nodePool 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.

Returns:

  • (Hash, nil) —

    Parameters used in creating the cluster’s nodes.,For requests, this field should only be used in lieu of a “nodePool” object, since this configuration (along with the “initialNodeCount”) will be used to create a “NodePool” object with an auto-generated name. Do not use this and a nodePool 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.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 27

attribute :node_config

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 12

attribute :state

#subnetwork ⇒ Object?

Returns The name of the Google Compute Engine subnetwork to which the cluster is connected.

Returns:

  • (Object, nil) —

    The name of the Google Compute Engine subnetwork to which the cluster is connected.



52
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 52

attribute :subnetwork

#zone ⇒ String

Returns The zone where the cluster is deployed.

Returns:

  • (String) —

    The zone where the cluster is deployed.



58
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_container_cluster.rb', line 58

attribute :zone