|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "mgc_kubernetes_cluster Data Source - terraform-provider-mgc" |
| 4 | +subcategory: "Kubernetes" |
| 5 | +description: |- |
| 6 | + Data source for Kubernetes cluster in MGC |
| 7 | +--- |
| 8 | + |
| 9 | +# mgc_kubernetes_cluster (Data Source) |
| 10 | + |
| 11 | +Data source for Kubernetes cluster in MGC |
| 12 | + |
| 13 | +```hcl |
| 14 | +data "mgc_kubernetes_cluster" "cluster" { |
| 15 | + id = {cluster_ID} |
| 16 | +} |
| 17 | +``` |
| 18 | + |
| 19 | +<!-- schema generated by tfplugindocs --> |
| 20 | + |
| 21 | +## Schema |
| 22 | + |
| 23 | +### Required |
| 24 | + |
| 25 | +- `id` (String) Cluster's UUID. |
| 26 | + |
| 27 | +### Read-Only |
| 28 | + |
| 29 | +- `addons_loadbalance` (String) Flag indicating whether the load balancer service is enabled/disabled in the cluster. |
| 30 | +- `addons_secrets` (String) Native Kubernetes secret to be included in the cluster during provisioning. |
| 31 | +- `addons_volume` (String) Flag indicating whether the storage class service is configured by default. |
| 32 | +- `allowed_cidrs` (List of String) List of allowed CIDR blocks for API server access. |
| 33 | +- `cidr` (String) Available IP addresses used for provisioning nodes in the cluster. |
| 34 | +- `cluster_name` (String) Name of the node pool. |
| 35 | +- `controlplane` (Attributes) Object of the node pool response. (see [below for nested schema](#nestedatt--controlplane)) |
| 36 | +- `created_at` (String) Creation date of the Kubernetes cluster. |
| 37 | +- `description` (String) A brief description of the Kubernetes cluster. |
| 38 | +- `enabled_bastion` (Boolean) Indicates if a bastion host is enabled for secure access to the cluster. |
| 39 | +- `enabled_server_group` (Boolean) Indicates if a server group with anti-affinity policy is used for the cluster and its node pools. |
| 40 | +- `kube_api_disable_api_server_fip` (Boolean) Enables or disables the use of Floating IP on the API Server. |
| 41 | +- `kube_api_fixed_ip` (String) Fixed IP configured for the Kubernetes API Server. |
| 42 | +- `kube_api_floating_ip` (String) Floating IP created for the Kubernetes API Server. |
| 43 | +- `kube_api_port` (Number) Port used by the Kubernetes API Server. |
| 44 | +- `message` (String) Detailed message about the status of the cluster or node. |
| 45 | +- `name` (String) Kubernetes cluster name. |
| 46 | +- `node_pools` (Attributes List) An array representing a set of nodes within a Kubernetes cluster. (see [below for nested schema](#nestedatt--node_pools)) |
| 47 | +- `project_id` (String, Deprecated) (Deprecated) Unique identifier of the project where the cluster was provisioned. |
| 48 | +- `region` (String) Identifier of the region where the Kubernetes cluster is located. |
| 49 | +- `state` (String) Current state of the cluster or node. |
| 50 | +- `subnet_id` (String) Identifier of the internal subnet where the cluster will be provisioned. |
| 51 | +- `updated_at` (String) Date of the last modification of the Kubernetes cluster. |
| 52 | +- `version` (String) The native Kubernetes version of the cluster. |
| 53 | +- `zone` (String) Identifier of the zone where the Kubernetes cluster is located. |
| 54 | + |
| 55 | +<a id="nestedatt--controlplane"></a> |
| 56 | + |
| 57 | +### Nested Schema for `controlplane` |
| 58 | + |
| 59 | +Read-Only: |
| 60 | + |
| 61 | +- `created_at` (String) Date of creation of the Kubernetes cluster. |
| 62 | +- `disk_size` (Number) Size of the disk attached to each node. |
| 63 | +- `disk_type` (String) Type of disk attached to each node. |
| 64 | +- `flavor_id` (String) Unique identifier for the Flavor. |
| 65 | +- `flavor_name` (String) Name of the Flavor. |
| 66 | +- `id` (String) Node pool's UUID. |
| 67 | +- `labels` (Map of String) Key/value pairs attached to the object and used for specification. |
| 68 | +- `max_replicas` (Number) Maximum number of replicas for autoscaling. |
| 69 | +- `min_replicas` (Number) Minimum number of replicas for autoscaling. |
| 70 | +- `name` (String) Node pool name |
| 71 | +- `node_image` (String) Operating system image running on each node. |
| 72 | +- `replicas` (Number) Number of replicas of the nodes in the node pool. |
| 73 | +- `security_groups` (List of String) Name of the security group to define rules allowing network traffic in the worker node pool. |
| 74 | +- `state` (String) Current state of the node pool or control plane. |
| 75 | +- `status_messages` (List of String) Detailed message about the status of the node pool or control plane. |
| 76 | +- `tags` (List of String) List of tags applied to the node pool. |
| 77 | +- `taints` (Attributes List) Property for associating a set of nodes. (see [below for nested schema](#nestedatt--controlplane--taints)) |
| 78 | +- `updated_at` (String) Date of the last change to the Kubernetes cluster. |
| 79 | +- `zone` (List of String) Availability zone for creating the Kubernetes cluster. |
| 80 | + |
| 81 | +<a id="nestedatt--controlplane--taints"></a> |
| 82 | + |
| 83 | +### Nested Schema for `controlplane.taints` |
| 84 | + |
| 85 | +Read-Only: |
| 86 | + |
| 87 | +- `effect` (String) The effect of the taint on pods that do not tolerate the taint. |
| 88 | +- `key` (String) Key of the taint to be applied to the node. |
| 89 | +- `value` (String) Value corresponding to the taint key. |
| 90 | + |
| 91 | +<a id="nestedatt--node_pools"></a> |
| 92 | + |
| 93 | +### Nested Schema for `node_pools` |
| 94 | + |
| 95 | +Read-Only: |
| 96 | + |
| 97 | +- `created_at` (String) Date of creation of the Kubernetes Node. |
| 98 | +- `flavor_name` (String) Definition of the CPU, RAM, and storage capacity of the nodes. |
| 99 | +- `id` (String) Node pool's UUID. |
| 100 | +- `max_replicas` (Number) Maximum number of replicas for autoscaling. |
| 101 | +- `min_replicas` (Number) Minimum number of replicas for autoscaling. |
| 102 | +- `name` (String) Name of the node pool. |
| 103 | +- `replicas` (Number) Number of replicas of the nodes in the node pool. |
| 104 | +- `tags` (List of String) List of tags applied to the node pool. |
| 105 | +- `taints` (Attributes List) Property associating a set of nodes. (see [below for nested schema](#nestedatt--node_pools--taints)) |
| 106 | +- `updated_at` (String) Date of the last change to the Kubernetes Node. |
| 107 | + |
| 108 | +<a id="nestedatt--node_pools--taints"></a> |
| 109 | + |
| 110 | +### Nested Schema for `node_pools.taints` |
| 111 | + |
| 112 | +Read-Only: |
| 113 | + |
| 114 | +- `effect` (String) The effect of the taint on pods that do not tolerate the taint. |
| 115 | +- `key` (String) Key of the taint to be applied to the node. |
| 116 | +- `value` (String) Value corresponding to the taint key. |
0 commit comments