Skip to content

Commit

Permalink
fix provider docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeljguarino committed Jun 2, 2024
1 parent a55a0a8 commit aebf17d
Showing 1 changed file with 0 additions and 133 deletions.
133 changes: 0 additions & 133 deletions docs/resources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,16 @@ A representation of a cluster you can deploy to.
### Optional

- `bindings` (Attributes) Read and write policies of this cluster. (see [below for nested schema](#nestedatt--bindings))
- `cloud` (String) The cloud provider used to create this cluster.
- `cloud_settings` (Attributes) Cloud-specific settings for this cluster. (see [below for nested schema](#nestedatt--cloud_settings))
- `handle` (String) A short, unique human-readable name used to identify this cluster. Does not necessarily map to the cloud resource name.
- `helm_repo_url` (String) Helm repository URL you'd like to use in deployment agent Helm install.
- `helm_values` (String) Additional Helm values you'd like to use in deployment agent Helm installs. This is useful for BYOK clusters that need to use custom images or other constructs.
- `kubeconfig` (Attributes) (see [below for nested schema](#nestedatt--kubeconfig))
- `metadata` (String) Arbitrary JSON metadata to store user-specific state of this cluster (e.g. IAM roles for add-ons).
- `node_pools` (Attributes Map) **Experimental, not ready for production use.** Map of node pool specs managed by this cluster, where the key is name of the node pool and value contains the spec. Leave empty for bring your own cluster. (see [below for nested schema](#nestedatt--node_pools))
- `protect` (Boolean) If set to `true` then this cluster cannot be deleted.
- `provider_id` (String) Provider used to create this cluster. Leave empty for bring your own cluster.
- `tags` (Map of String) Key-value tags used to filter clusters.
- `version` (String) Kubernetes version to use for this cluster. Leave empty for bring your own cluster. Supported version ranges can be found at https://github.com/pluralsh/console/tree/master/static/k8s-versions.

### Read-Only

- `desired_version` (String) Desired Kubernetes version for this cluster.
- `id` (String) Internal identifier of this cluster.
- `inserted_at` (String) Creation date of this cluster.

Expand Down Expand Up @@ -70,90 +64,6 @@ Optional:



<a id="nestedatt--cloud_settings"></a>
### Nested Schema for `cloud_settings`

Optional:

- `aws` (Attributes) (see [below for nested schema](#nestedatt--cloud_settings--aws))
- `azure` (Attributes) (see [below for nested schema](#nestedatt--cloud_settings--azure))
- `byok` (Attributes) (see [below for nested schema](#nestedatt--cloud_settings--byok))
- `gcp` (Attributes) (see [below for nested schema](#nestedatt--cloud_settings--gcp))

<a id="nestedatt--cloud_settings--aws"></a>
### Nested Schema for `cloud_settings.aws`

Required:

- `region` (String) AWS region to deploy the cluster to.


<a id="nestedatt--cloud_settings--azure"></a>
### Nested Schema for `cloud_settings.azure`

Required:

- `location` (String) String matching one of the canonical Azure region names, i.e. eastus.
- `network` (String) Name of the Azure virtual network for this cluster.
- `resource_group` (String) Name of the Azure resource group for this cluster.
- `subscription_id` (String) GUID of the Azure subscription to hold this cluster.


<a id="nestedatt--cloud_settings--byok"></a>
### Nested Schema for `cloud_settings.byok`

Optional:

- `kubeconfig` (Attributes, Deprecated) (see [below for nested schema](#nestedatt--cloud_settings--byok--kubeconfig))

<a id="nestedatt--cloud_settings--byok--kubeconfig"></a>
### Nested Schema for `cloud_settings.byok.kubeconfig`

Optional:

- `client_certificate` (String) The path to a client cert file for TLS. Can be sourced from `PLURAL_KUBE_CLIENT_CERT_DATA`.
- `client_key` (String, Sensitive) The path to a client key file for TLS. Can be sourced from `PLURAL_KUBE_CLIENT_KEY_DATA`.
- `cluster_ca_certificate` (String) The path to a cert file for the certificate authority. Can be sourced from `PLURAL_KUBE_CLUSTER_CA_CERT_DATA`.
- `config_context` (String) kubeconfig context to use. Can be sourced from `PLURAL_KUBE_CTX`.
- `config_context_auth_info` (String) Can be sourced from `PLURAL_KUBE_CTX_AUTH_INFO`.
- `config_context_cluster` (String) Can be sourced from `PLURAL_KUBE_CTX_CLUSTER`.
- `config_path` (String) Path to the kubeconfig file. Can be sourced from `PLURAL_KUBE_CONFIG_PATH`.
- `exec` (Attributes List) Specifies a command to provide client credentials (see [below for nested schema](#nestedatt--cloud_settings--byok--kubeconfig--exec))
- `host` (String) The complete address of the Kubernetes cluster, using scheme://hostname:port format. Can be sourced from `PLURAL_KUBE_HOST`.
- `insecure` (Boolean) Skips the validity check for the server's certificate. This will make your HTTPS connections insecure. Can be sourced from `PLURAL_KUBE_INSECURE`.
- `password` (String, Sensitive) The password for basic authentication to the Kubernetes cluster. Can be sourced from `PLURAL_KUBE_PASSWORD`.
- `proxy_url` (String) The URL to the proxy to be used for all requests made by this client. Can be sourced from `PLURAL_KUBE_PROXY_URL`.
- `tls_server_name` (String) TLS server name is used to check server certificate. If it is empty, the hostname used to contact the server is used. Can be sourced from `PLURAL_KUBE_TLS_SERVER_NAME`.
- `token` (String, Sensitive) Token is the bearer token for authentication to the Kubernetes cluster. Can be sourced from `PLURAL_KUBE_TOKEN`.
- `username` (String) The username for basic authentication to the Kubernetes cluster. Can be sourced from `PLURAL_KUBE_USER`.

<a id="nestedatt--cloud_settings--byok--kubeconfig--exec"></a>
### Nested Schema for `cloud_settings.byok.kubeconfig.username`

Required:

- `api_version` (String) Preferred input version.
- `command` (String) Command to execute.

Optional:

- `args` (List of String) Arguments to pass to the command when executing it.
- `env` (Map of String) Defines environment variables to expose to the process.




<a id="nestedatt--cloud_settings--gcp"></a>
### Nested Schema for `cloud_settings.gcp`

Required:

- `network` (String) GCP network id to use when creating the cluster.
- `project` (String) GCP project id to deploy cluster to.
- `region` (String) GCP region to deploy cluster to.



<a id="nestedatt--kubeconfig"></a>
### Nested Schema for `kubeconfig`

Expand Down Expand Up @@ -187,46 +97,3 @@ Optional:

- `args` (List of String) Arguments to pass to the command when executing it.
- `env` (Map of String) Defines environment variables to expose to the process.



<a id="nestedatt--node_pools"></a>
### Nested Schema for `node_pools`

Required:

- `instance_type` (String) The type of node to use. Usually cloud-specific.
- `max_size` (Number) Maximum number of instances in this node pool.
- `min_size` (Number) Minimum number of instances in this node pool.
- `name` (String) Node pool name. Must be unique.

Optional:

- `cloud_settings` (Attributes) Cloud-specific settings for this node pool. (see [below for nested schema](#nestedatt--node_pools--cloud_settings))
- `labels` (Map of String) Kubernetes labels to apply to the nodes in this pool. Useful for node selectors.
- `taints` (Attributes Set) Any taints you'd want to apply to a node, i.e. for preventing scheduling on spot instances. See [Kubernetes docs](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) for more information. (see [below for nested schema](#nestedatt--node_pools--taints))

<a id="nestedatt--node_pools--cloud_settings"></a>
### Nested Schema for `node_pools.cloud_settings`

Optional:

- `aws` (Attributes) AWS node pool customizations. (see [below for nested schema](#nestedatt--node_pools--cloud_settings--aws))

<a id="nestedatt--node_pools--cloud_settings--aws"></a>
### Nested Schema for `node_pools.cloud_settings.aws`

Optional:

- `launch_template_id` (String) Custom launch template for your nodes. Useful for Golden AMI setups.



<a id="nestedatt--node_pools--taints"></a>
### Nested Schema for `node_pools.taints`

Required:

- `effect` (String) Taint effect, allowed values include `NoExecute`, `NoSchedule` and `PreferNoSchedule`.
- `key` (String) Taint key.
- `value` (String) Taint value.

0 comments on commit aebf17d

Please sign in to comment.