Contents

# RancherApi::Cluster

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | (Read-only) The Cluster identifier. | [optional][readonly] |
| **name** | **String** | Cluster name. This field is autogenerated if not provided. | [optional] |
| **description** | **String** | Cluster description. | [optional] |
| **location** | **String** | Deployment location. Cannot be changed once a cluster is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. |  |
| **initial_cluster_version** | **String** | (Read-only) The Rancher version that was installed on the cluster during the first creation process. | [optional][readonly] |
| **node_pools** | [**Array<NodePool>**](NodePool.md) | The node pools associated with the cluster. | [optional] |
| **configuration** | [**ClusterConfiguration**](ClusterConfiguration.md) |  | [optional] |
| **metadata** | [**RancherServerMetadata**](RancherServerMetadata.md) |  | [optional][readonly] |
| **workload_configuration** | [**ClusterWorkloadConfiguration**](ClusterWorkloadConfiguration.md) |  | [optional] |
| **status_description** | **String** | The cluster status | [optional][readonly] |

## Example

```ruby
require 'pnap_rancher_api'

instance = RancherApi::Cluster.new(
  id: 6047127fed34ecc3ba8402d2,
  name: Rancher Management Cluster,
  description: My first Rancher Server Cluster.,
  location: PHX,
  initial_cluster_version: v2.5.9,
  node_pools: null,
  configuration: null,
  metadata: null,
  workload_configuration: null,
  status_description: Creating
)
```

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
pnap_rancher_api-1.0.6	docs/Cluster.md
pnap_rancher_api-1.0.5	docs/Cluster.md
pnap_rancher_api-1.0.4	docs/Cluster.md
pnap_rancher_api-1.0.3	docs/Cluster.md
pnap_rancher_api-1.0.2	docs/Cluster.md