lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb in google-cloud-container-0.2.1 vs lib/google/cloud/container/v1/doc/google/container/v1/cluster_service.rb in google-cloud-container-0.2.2

- old
+ new

@@ -19,14 +19,14 @@ # Parameters that describe the nodes in a cluster. # @!attribute [rw] machine_type # @return [String] # The name of a Google Compute Engine [machine # type](/compute/docs/machine-types) (e.g. - # +n1-standard-1+). + # `n1-standard-1`). # # If unspecified, the default machine type is - # +n1-standard-1+. + # `n1-standard-1`. # @!attribute [rw] disk_size_gb # @return [Integer] # Size of the disk attached to each node, specified in GB. # The smallest allowed disk size is 10GB. # @@ -37,13 +37,13 @@ # 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 + # * `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 + # * `https://www.googleapis.com/auth/devstorage.read_only` is required for # communicating with **gcr.io** # (the [Google Container Registry](https://cloud.google.com/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. @@ -264,14 +264,14 @@ # Whether alias IPs will be used for pod IPs in the cluster. # @!attribute [rw] create_subnetwork # @return [true, false] # Whether a new subnetwork will be created automatically for the cluster. # - # This field is only applicable when +use_ip_aliases+ is true. + # This field is only applicable when `use_ip_aliases` is true. # @!attribute [rw] subnetwork_name # @return [String] - # A custom subnetwork name to be used if +create_subnetwork+ is true. If + # A custom subnetwork name to be used if `create_subnetwork` is true. If # this field is empty, then an automatic name will be chosen for the new # subnetwork. # @!attribute [rw] cluster_ipv4_cidr # @return [String] # This field is deprecated, use cluster_ipv4_cidr_block. @@ -300,56 +300,56 @@ # This field is only applicable with use_ip_aliases is true and # create_subnetwork is false. # @!attribute [rw] cluster_ipv4_cidr_block # @return [String] # The IP address range for the cluster pod IPs. If this field is set, then - # +cluster.cluster_ipv4_cidr+ must be left blank. + # `cluster.cluster_ipv4_cidr` must be left blank. # - # This field is only applicable when +use_ip_aliases+ is true. + # This field is only applicable when `use_ip_aliases` is true. # # Set to blank to have a range chosen with the default size. # - # Set to /netmask (e.g. +/14+) to have a range chosen with a specific + # Set to /netmask (e.g. `/14`) to have a range chosen with a specific # netmask. # # Set to a # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. +10.96.0.0/14+) from the RFC-1918 private networks (e.g. - # +10.0.0.0/8+, +172.16.0.0/12+, +192.168.0.0/16+) to pick a specific range + # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range # to use. # @!attribute [rw] node_ipv4_cidr_block # @return [String] # The IP address range of the instance IPs in this cluster. # - # This is applicable only if +create_subnetwork+ is true. + # This is applicable only if `create_subnetwork` is true. # # Set to blank to have a range chosen with the default size. # - # Set to /netmask (e.g. +/14+) to have a range chosen with a specific + # Set to /netmask (e.g. `/14`) to have a range chosen with a specific # netmask. # # Set to a # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. +10.96.0.0/14+) from the RFC-1918 private networks (e.g. - # +10.0.0.0/8+, +172.16.0.0/12+, +192.168.0.0/16+) to pick a specific range + # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range # to use. # @!attribute [rw] services_ipv4_cidr_block # @return [String] # The IP address range of the services IPs in this cluster. If blank, a range # will be automatically chosen with the default size. # - # This field is only applicable when +use_ip_aliases+ is true. + # This field is only applicable when `use_ip_aliases` is true. # # Set to blank to have a range chosen with the default size. # - # Set to /netmask (e.g. +/14+) to have a range chosen with a specific + # Set to /netmask (e.g. `/14`) to have a range chosen with a specific # netmask. # # Set to a # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) - # notation (e.g. +10.96.0.0/14+) from the RFC-1918 private networks (e.g. - # +10.0.0.0/8+, +172.16.0.0/12+, +192.168.0.0/16+) to pick a specific range + # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range # to use. class IPAllocationPolicy; end # A Google Container Engine cluster. # @!attribute [rw] name @@ -374,11 +374,11 @@ # "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. # @!attribute [rw] node_config # @return [Google::Container::V1::NodeConfig] # Parameters used in creating the cluster's nodes. - # See +nodeConfig+ for the description of its properties. + # 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 @@ -391,33 +391,33 @@ # @!attribute [rw] logging_service # @return [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. + # * `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. # @!attribute [rw] monitoring_service # @return [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. + # * `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. # @!attribute [rw] network # @return [String] # The name of the Google Compute Engine # [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the - # cluster is connected. If left unspecified, the +default+ network + # cluster is connected. If left unspecified, the `default` network # will be used. # @!attribute [rw] cluster_ipv4_cidr # @return [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+. + # 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`. # @!attribute [rw] addons_config # @return [Google::Container::V1::AddonsConfig] # Configurations for the various addons available to run in the cluster. # @!attribute [rw] subnetwork # @return [String] @@ -475,13 +475,13 @@ # resides. # @!attribute [rw] endpoint # @return [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/+. + # `https://username:password@endpoint/`. # - # See the +masterAuth+ property of this resource for username and + # See the `masterAuth` property of this resource for username and # password information. # @!attribute [rw] initial_cluster_version # @return [String] # The initial Kubernetes version for this cluster. Valid versions are those # found in validMasterVersions returned by getServerConfig. The version can @@ -507,19 +507,19 @@ # [Output only] Additional information about the current status of this # cluster, if available. # @!attribute [rw] node_ipv4_cidr_size # @return [Integer] # [Output only] The size of the address space on each node for hosting - # containers. This is provisioned from within the +container_ipv4_cidr+ + # containers. This is provisioned from within the `container_ipv4_cidr` # range. # @!attribute [rw] services_ipv4_cidr # @return [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. + # notation (e.g. `1.2.3.4/29`). Service addresses are + # typically put in the last `/16` from the container CIDR. # @!attribute [rw] instance_group_urls # @return [Array<String>] # Deprecated. Use node_pools.instance_group_urls. # @!attribute [rw] current_node_count # @return [Integer] @@ -541,29 +541,29 @@ # 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. + # 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. + # can be found in the `statusMessage` field. ERROR = 5 end end # 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. # @!attribute [rw] desired_node_version # @return [String] # The Kubernetes version to change the nodes to (typically an - # upgrade). Use +-+ to upgrade to the latest version supported by + # upgrade). Use `-` to upgrade to the latest version supported by # the server. # @!attribute [rw] desired_monitoring_service # @return [String] # The monitoring service the cluster should use to write metrics. # Currently available options: @@ -785,11 +785,11 @@ # @return [String] # The name of the node pool to upgrade. # @!attribute [rw] node_version # @return [String] # The Kubernetes version to change the nodes to (typically an - # upgrade). Use +-+ to upgrade to the latest version supported by + # upgrade). Use `-` to upgrade to the latest version supported by # the server. # @!attribute [rw] image_type # @return [String] # The desired image type for the node pool. class UpdateNodePoolRequest; end @@ -1009,22 +1009,22 @@ # The name of the Google Compute Engine # [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster # resides. # @!attribute [rw] operation_id # @return [String] - # The server-assigned +name+ of the operation. + # The server-assigned `name` of the operation. class GetOperationRequest; end # ListOperationsRequest lists operations. # @!attribute [rw] project_id # @return [String] # The Google Developers Console [project ID or project # number](https://support.google.com/cloud/answer/6158840). # @!attribute [rw] zone # @return [String] # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) - # to return operations for, or +-+ for all zones. + # to return operations for, or `-` for all zones. class ListOperationsRequest; end # CancelOperationRequest cancels a single operation. # @!attribute [rw] project_id # @return [String] @@ -1034,11 +1034,11 @@ # @return [String] # The name of the Google Compute Engine # [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. # @!attribute [rw] operation_id # @return [String] - # The server-assigned +name+ of the operation. + # The server-assigned `name` of the operation. class CancelOperationRequest; end # ListOperationsResponse is the result of ListOperationsRequest. # @!attribute [rw] operations # @return [Array<Google::Container::V1::Operation>] @@ -1209,17 +1209,17 @@ # or trigger a new update. RUNNING_WITH_ERROR = 3 # The RECONCILING state indicates that some work is actively being done on # the node pool, such as upgrading node software. Details can - # be found in the +statusMessage+ field. + # be found in the `statusMessage` field. RECONCILING = 4 # The STOPPING state indicates the node pool is being deleted. STOPPING = 5 # The ERROR state indicates the node pool may be unusable. Details - # can be found in the +statusMessage+ field. + # can be found in the `statusMessage` field. ERROR = 6 end end # NodeManagement defines the set of node management services turned on for the \ No newline at end of file