You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/cluster.md
+57-20Lines changed: 57 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,14 +17,15 @@ A representation of a cluster you can deploy to.
17
17
18
18
### Required
19
19
20
-
-`cloud` (String) The cloud provider used to create this cluster.
21
-
-`cloud_settings` (Attributes) Cloud-specific settings for this cluster. (see [below for nested schema](#nestedatt--cloud_settings))
22
20
-`name` (String) Human-readable name of this cluster, that also translates to cloud resource name.
23
21
24
22
### Optional
25
23
26
24
-`bindings` (Attributes) Read and write policies of this cluster. (see [below for nested schema](#nestedatt--bindings))
25
+
-`cloud` (String) The cloud provider used to create this cluster.
26
+
-`cloud_settings` (Attributes) Cloud-specific settings for this cluster. (see [below for nested schema](#nestedatt--cloud_settings))
27
27
-`handle` (String) A short, unique human-readable name used to identify this cluster. Does not necessarily map to the cloud resource name.
28
+
-`kubeconfig` (Attributes) (see [below for nested schema](#nestedatt--kubeconfig))
28
29
-`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))
29
30
-`protect` (Boolean) If set to `true` then this cluster cannot be deleted.
30
31
-`provider_id` (String) Provider used to create this cluster. Leave empty for bring your own cluster.
@@ -37,6 +38,35 @@ A representation of a cluster you can deploy to.
37
38
-`id` (String) Internal identifier of this cluster.
38
39
-`inserted_at` (String) Creation date of this cluster.
39
40
41
+
<aid="nestedatt--bindings"></a>
42
+
### Nested Schema for `bindings`
43
+
44
+
Optional:
45
+
46
+
-`read` (Attributes Set) Read policies of this cluster. (see [below for nested schema](#nestedatt--bindings--read))
47
+
-`write` (Attributes Set) Write policies of this cluster. (see [below for nested schema](#nestedatt--bindings--write))
48
+
49
+
<aid="nestedatt--bindings--read"></a>
50
+
### Nested Schema for `bindings.read`
51
+
52
+
Optional:
53
+
54
+
-`group_id` (String)
55
+
-`id` (String)
56
+
-`user_id` (String)
57
+
58
+
59
+
<aid="nestedatt--bindings--write"></a>
60
+
### Nested Schema for `bindings.write`
61
+
62
+
Optional:
63
+
64
+
-`group_id` (String)
65
+
-`id` (String)
66
+
-`user_id` (String)
67
+
68
+
69
+
40
70
<aid="nestedatt--cloud_settings"></a>
41
71
### Nested Schema for `cloud_settings`
42
72
@@ -71,7 +101,7 @@ Required:
71
101
72
102
Optional:
73
103
74
-
-`kubeconfig` (Attributes) (see [below for nested schema](#nestedatt--cloud_settings--byok--kubeconfig))
104
+
-`kubeconfig` (Attributes, Deprecated) (see [below for nested schema](#nestedatt--cloud_settings--byok--kubeconfig))
### Nested Schema for `cloud_settings.byok.kubeconfig`
@@ -121,32 +151,39 @@ Required:
121
151
122
152
123
153
124
-
<aid="nestedatt--bindings"></a>
125
-
### Nested Schema for `bindings`
154
+
<aid="nestedatt--kubeconfig"></a>
155
+
### Nested Schema for `kubeconfig`
126
156
127
157
Optional:
128
158
129
-
-`read` (Attributes Set) Read policies of this cluster. (see [below for nested schema](#nestedatt--bindings--read))
130
-
-`write` (Attributes Set) Write policies of this cluster. (see [below for nested schema](#nestedatt--bindings--write))
131
-
132
-
<aid="nestedatt--bindings--read"></a>
133
-
### Nested Schema for `bindings.read`
134
-
135
-
Optional:
159
+
-`client_certificate` (String) The path to a client cert file for TLS. Can be sourced from `PLURAL_KUBE_CLIENT_CERT_DATA`.
160
+
-`client_key` (String, Sensitive) The path to a client key file for TLS. Can be sourced from `PLURAL_KUBE_CLIENT_KEY_DATA`.
161
+
-`cluster_ca_certificate` (String) The path to a cert file for the certificate authority. Can be sourced from `PLURAL_KUBE_CLUSTER_CA_CERT_DATA`.
162
+
-`config_context` (String) kubeconfig context to use. Can be sourced from `PLURAL_KUBE_CTX`.
163
+
-`config_context_auth_info` (String) Can be sourced from `PLURAL_KUBE_CTX_AUTH_INFO`.
164
+
-`config_context_cluster` (String) Can be sourced from `PLURAL_KUBE_CTX_CLUSTER`.
165
+
-`config_path` (String) Path to the kubeconfig file. Can be sourced from `PLURAL_KUBE_CONFIG_PATH`.
166
+
-`exec` (Attributes List) Specifies a command to provide client credentials (see [below for nested schema](#nestedatt--kubeconfig--exec))
167
+
-`host` (String) The complete address of the Kubernetes cluster, using scheme://hostname:port format. Can be sourced from `PLURAL_KUBE_HOST`.
168
+
-`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`.
169
+
-`password` (String, Sensitive) The password for basic authentication to the Kubernetes cluster. Can be sourced from `PLURAL_KUBE_PASSWORD`.
170
+
-`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`.
171
+
-`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`.
172
+
-`token` (String, Sensitive) Token is the bearer token for authentication to the Kubernetes cluster. Can be sourced from `PLURAL_KUBE_TOKEN`.
173
+
-`username` (String) The username for basic authentication to the Kubernetes cluster. Can be sourced from `PLURAL_KUBE_USER`.
136
174
137
-
-`group_id` (String)
138
-
-`id` (String)
139
-
-`user_id` (String)
175
+
<aid="nestedatt--kubeconfig--exec"></a>
176
+
### Nested Schema for `kubeconfig.exec`
140
177
178
+
Required:
141
179
142
-
<aid="nestedatt--bindings--write"></a>
143
-
### Nested Schema for `bindings.write`
180
+
-`api_version` (String) Preferred input version.
181
+
-`command` (String) Command to execute.
144
182
145
183
Optional:
146
184
147
-
-`group_id` (String)
148
-
-`id` (String)
149
-
-`user_id` (String)
185
+
-`args` (List of String) Arguments to pass to the command when executing it.
186
+
-`env` (Map of String) Defines environment variables to expose to the process.
Copy file name to clipboardExpand all lines: docs/resources/service_deployment.md
+1-10Lines changed: 1 addition & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ description: |-
24
24
### Optional
25
25
26
26
-`bindings` (Attributes) Read and write policies of this ServiceDeployment. (see [below for nested schema](#nestedatt--bindings))
27
-
-`configuration` (Attributes Set) List of [name, value] secrets used to alter this ServiceDeployment configuration. (see [below for nested schema](#nestedatt--configuration))
27
+
-`configuration` (Map of String) Key-value configuration used to parameterize this service (stored securely by default).
28
28
-`docs_path` (String) Path to the documentation in the target git repository.
29
29
-`helm` (Attributes) Settings defining how Helm charts should be applied. (see [below for nested schema](#nestedatt--helm))
30
30
-`kustomize` (Attributes) Kustomize related service metadata. (see [below for nested schema](#nestedatt--kustomize))
0 commit comments