Skip to content

Commit c1f6c3d

Browse files
the-technatthe-technat
authored
feat: migrate tfplugindocs to newest format (#648)
Signed-off-by: Nathanael Liechti <[email protected]>
1 parent 187153e commit c1f6c3d

36 files changed

+22907
-1828
lines changed

‎docs/data-sources/application.md‎

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ data "argocd_application" "foo" {
2222
```
2323

2424
<!-- schema generated by tfplugindocs -->
25+
2526
## Schema
2627

2728
### Required
@@ -35,6 +36,7 @@ data "argocd_application" "foo" {
3536
- `status` (Attributes) Status information for the application. (see [below for nested schema](#nestedatt--status))
3637

3738
<a id="nestedatt--metadata"></a>
39+
3840
### Nested Schema for `metadata`
3941

4042
Required:
@@ -53,8 +55,8 @@ Read-Only:
5355
- `resource_version` (String) An opaque value that represents the internal version of this applications.argoproj.io that can be used by clients to determine when applications.argoproj.io has changed. Read more: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
5456
- `uid` (String) The unique in time and space value for this applications.argoproj.io. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
5557

56-
5758
<a id="nestedatt--spec"></a>
59+
5860
### Nested Schema for `spec`
5961

6062
Read-Only:
@@ -68,6 +70,7 @@ Read-Only:
6870
- `sync_policy` (Attributes) Controls when and how a sync will be performed. (see [below for nested schema](#nestedatt--spec--sync_policy))
6971

7072
<a id="nestedatt--spec--destination"></a>
73+
7174
### Nested Schema for `spec.destination`
7275

7376
Read-Only:
@@ -76,8 +79,8 @@ Read-Only:
7679
- `namespace` (String) Target namespace for the application's resources. The namespace will only be set for namespace-scoped resources that have not set a value for .metadata.namespace.
7780
- `server` (String) URL of the target cluster and must be set to the Kubernetes control plane API.
7881

79-
8082
<a id="nestedatt--spec--ignore_differences"></a>
83+
8184
### Nested Schema for `spec.ignore_differences`
8285

8386
Read-Only:
@@ -89,17 +92,17 @@ Read-Only:
8992
- `name` (String) The Kubernetes resource Name to match for.
9093
- `namespace` (String) The Kubernetes resource Namespace to match for.
9194

92-
9395
<a id="nestedatt--spec--infos"></a>
96+
9497
### Nested Schema for `spec.infos`
9598

9699
Read-Only:
97100

98101
- `name` (String) Name of the information.
99102
- `value` (String) Value of the information.
100103

101-
102104
<a id="nestedatt--spec--sources"></a>
105+
103106
### Nested Schema for `spec.sources`
104107

105108
Read-Only:
@@ -115,6 +118,7 @@ Read-Only:
115118
- `target_revision` (String) Revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.
116119

117120
<a id="nestedatt--spec--sources--directory"></a>
121+
118122
### Nested Schema for `spec.sources.directory`
119123

120124
Read-Only:
@@ -125,6 +129,7 @@ Read-Only:
125129
- `recurse` (Boolean) Whether to scan a directory recursively for manifests.
126130

127131
<a id="nestedatt--spec--sources--directory--jsonnet"></a>
132+
128133
### Nested Schema for `spec.sources.directory.jsonnet`
129134

130135
Read-Only:
@@ -134,6 +139,7 @@ Read-Only:
134139
- `tlas` (Attributes List) List of Jsonnet Top-level Arguments (see [below for nested schema](#nestedatt--spec--sources--directory--jsonnet--tlas))
135140

136141
<a id="nestedatt--spec--sources--directory--jsonnet--ext_vars"></a>
142+
137143
### Nested Schema for `spec.sources.directory.jsonnet.ext_vars`
138144

139145
Read-Only:
@@ -142,8 +148,8 @@ Read-Only:
142148
- `name` (String) Name of Jsonnet variable.
143149
- `value` (String) Value of Jsonnet variable.
144150

145-
146151
<a id="nestedatt--spec--sources--directory--jsonnet--tlas"></a>
152+
147153
### Nested Schema for `spec.sources.directory.jsonnet.tlas`
148154

149155
Read-Only:
@@ -152,10 +158,8 @@ Read-Only:
152158
- `name` (String) Name of Jsonnet variable.
153159
- `value` (String) Value of Jsonnet variable.
154160

155-
156-
157-
158161
<a id="nestedatt--spec--sources--helm"></a>
162+
159163
### Nested Schema for `spec.sources.helm`
160164

161165
Read-Only:
@@ -170,15 +174,16 @@ Read-Only:
170174
- `values` (String) Helm values to be passed to 'helm template', typically defined as a Attribute.
171175

172176
<a id="nestedatt--spec--sources--helm--file_parameters"></a>
177+
173178
### Nested Schema for `spec.sources.helm.file_parameters`
174179

175180
Read-Only:
176181

177182
- `name` (String) Name of the Helm parameters.
178183
- `path` (String) Path to the file containing the values for the Helm parameters.
179184

180-
181185
<a id="nestedatt--spec--sources--helm--parameters"></a>
186+
182187
### Nested Schema for `spec.sources.helm.parameters`
183188

184189
Read-Only:
@@ -187,9 +192,8 @@ Read-Only:
187192
- `name` (String) Name of the Helm parameters.
188193
- `value` (String) Value of the Helm parameters.
189194

190-
191-
192195
<a id="nestedatt--spec--sources--kustomize"></a>
196+
193197
### Nested Schema for `spec.sources.kustomize`
194198

195199
Read-Only:
@@ -201,8 +205,8 @@ Read-Only:
201205
- `name_suffix` (String) Suffix appended to resources for Kustomize apps.
202206
- `version` (String) Version of Kustomize to use for rendering manifests.
203207

204-
205208
<a id="nestedatt--spec--sources--plugin"></a>
209+
206210
### Nested Schema for `spec.sources.plugin`
207211

208212
Read-Only:
@@ -212,15 +216,16 @@ Read-Only:
212216
- `parameters` (Attributes List) Parameters to supply to config management plugin. (see [below for nested schema](#nestedatt--spec--sources--plugin--parameters))
213217

214218
<a id="nestedatt--spec--sources--plugin--env"></a>
219+
215220
### Nested Schema for `spec.sources.plugin.env`
216221

217222
Read-Only:
218223

219224
- `name` (String) Name of the environment variable.
220225
- `value` (String) Value of the environment variable.
221226

222-
223227
<a id="nestedatt--spec--sources--plugin--parameters"></a>
228+
224229
### Nested Schema for `spec.sources.plugin.parameters`
225230

226231
Read-Only:
@@ -230,10 +235,8 @@ Read-Only:
230235
- `name` (String) Name identifying a parameters.
231236
- `string` (String) Value of a string type parameters.
232237

233-
234-
235-
236238
<a id="nestedatt--spec--sync_policy"></a>
239+
237240
### Nested Schema for `spec.sync_policy`
238241

239242
Read-Only:
@@ -243,6 +246,7 @@ Read-Only:
243246
- `sync_options` (Set of String) List of sync options. More info: https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/.
244247

245248
<a id="nestedatt--spec--sync_policy--automated"></a>
249+
246250
### Nested Schema for `spec.sync_policy.automated`
247251

248252
Read-Only:
@@ -251,8 +255,8 @@ Read-Only:
251255
- `prune` (Boolean) Whether to delete resources from the cluster that are not found in the sources anymore as part of automated sync.
252256
- `self_heal` (Boolean) Whether to revert resources back to their desired state upon modification in the cluster.
253257

254-
255258
<a id="nestedatt--spec--sync_policy--retry"></a>
259+
256260
### Nested Schema for `spec.sync_policy.retry`
257261

258262
Read-Only:
@@ -261,6 +265,7 @@ Read-Only:
261265
- `limit` (Number) Maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
262266

263267
<a id="nestedatt--spec--sync_policy--retry--backoff"></a>
268+
264269
### Nested Schema for `spec.sync_policy.retry.backoff`
265270

266271
Read-Only:
@@ -269,11 +274,8 @@ Read-Only:
269274
- `factor` (Number) Factor to multiply the base duration after each failed retry.
270275
- `max_duration` (String) Maximum amount of time allowed for the backoff strategy. Default unit is seconds, but could also be a duration (e.g. `2m`, `1h`), as a string.
271276

272-
273-
274-
275-
276277
<a id="nestedatt--status"></a>
278+
277279
### Nested Schema for `status`
278280

279281
Read-Only:
@@ -287,6 +289,7 @@ Read-Only:
287289
- `sync` (Attributes) Application's current sync status (see [below for nested schema](#nestedatt--status--sync))
288290

289291
<a id="nestedatt--status--conditions"></a>
292+
290293
### Nested Schema for `status.conditions`
291294

292295
Read-Only:
@@ -295,17 +298,17 @@ Read-Only:
295298
- `message` (String) Human-readable message indicating details about condition.
296299
- `type` (String) Application condition type.
297300

298-
299301
<a id="nestedatt--status--health"></a>
302+
300303
### Nested Schema for `status.health`
301304

302305
Read-Only:
303306

304307
- `message` (String) Human-readable informational message describing the health status.
305308
- `status` (String) Status code of the application or resource.
306309

307-
308310
<a id="nestedatt--status--operation_state"></a>
311+
309312
### Nested Schema for `status.operation_state`
310313

311314
Read-Only:
@@ -316,8 +319,8 @@ Read-Only:
316319
- `retry_count` (Number) Count of operation retries.
317320
- `started_at` (String) Time of operation start.
318321

319-
320322
<a id="nestedatt--status--resources"></a>
323+
321324
### Nested Schema for `status.resources`
322325

323326
Read-Only:
@@ -334,25 +337,25 @@ Read-Only:
334337
- `version` (String) The Kubernetes resource Version.
335338

336339
<a id="nestedatt--status--resources--health"></a>
340+
337341
### Nested Schema for `status.resources.health`
338342

339343
Read-Only:
340344

341345
- `message` (String) Human-readable informational message describing the health status.
342346
- `status` (String) Status code of the application or resource.
343347

344-
345-
346348
<a id="nestedatt--status--summary"></a>
349+
347350
### Nested Schema for `status.summary`
348351

349352
Read-Only:
350353

351354
- `external_urls` (List of String) All external URLs of application child resources.
352355
- `images` (List of String) All images of application child resources.
353356

354-
355357
<a id="nestedatt--status--sync"></a>
358+
356359
### Nested Schema for `status.sync`
357360

358361
Read-Only:

‎docs/index.md‎

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,22 @@ description: |-
66

77
# ArgoCD Provider
88

9-
The ArgoCD Provider provides lifecycle management of
10-
[ArgoCD](https://argo-cd.readthedocs.io/en/stable/) resources.
9+
The ArgoCD Provider provides lifecycle management of [ArgoCD](https://argo-cd.readthedocs.io/en/stable/) resources.
1110

12-
**NB**: The provider is not concerned with the installation/configuration of
13-
ArgoCD itself. To make use of the provider, you will need to have an existing
14-
ArgoCD installation.
11+
**NB**: The provider is not concerned with the installation/configuration of ArgoCD itself. To make use of the provider, you will need to have an existing ArgoCD installation.
1512

16-
The correct provider configuration largely depends on whether or not your
17-
ArgoCD API server is exposed or not.
13+
The correct provider configuration largely depends on whether or not your ArgoCD API server is exposed or not.
1814

1915
If your ArgoCD API server is exposed, then:
20-
- use `server_addr` along with a `username`/`password` or `auth_token`.
21-
- use `use_local_config` if you have (pre)authenticated via the ArgoCD CLI (E.g.
22-
via SSO using `argocd login --sso`.
23-
24-
If you have not exposed your ArgoCD API server or have not deployed the API
25-
server ([ArgoCD
26-
core](https://argo-cd.readthedocs.io/en/stable/operator-manual/installation/#core)),
27-
see below for options. **Note**: in both these cases, you need sufficient access
28-
to the Kubernetes API to perform any actions.
29-
- use `port_forward_with_namespace` and optionally `kubernetes` configuration
30-
(to temporarily expose the ArgoCD API server using port forwarding) along with
31-
a `username`/`password` or `auth_token`.
32-
- if you use port-forwarding and your argo-cd-server is running on plain HTTP you need to add the flag `plain_text = true` to the provider configuration as well
33-
- use `core` to run a local ArgoCD API server that communicates directly with
34-
the Kubernetes API. **NB**: When using `core`, take note of the warning in
35-
the docs below.
36-
37-
If you are struggling to determine the correct configuration for the provider or
38-
the provider is behaving strangely and failing to connect for whatever reason,
39-
then we would suggest that you first figure out what combination of parameters
40-
work to log in using the ArgoCD CLI (`argocd login`) and then set the provider
41-
configuration to match what you used in the CLI. See also the ArgoCD [Getting
42-
Started](https://argo-cd.readthedocs.io/en/stable/getting_started/#3-access-the-argo-cd-api-server)
43-
docs.
16+
- use `server_addr` along with a `username`/`password` or `auth_token`.
17+
- use `use_local_config` if you have (pre)authenticated via the ArgoCD CLI (E.g. via SSO using `argocd login --sso`.
18+
19+
If you have not exposed your ArgoCD API server or have not deployed the API server ([ArgoCD core](https://argo-cd.readthedocs.io/en/stable/operator-manual/installation/#core)), see below for options. **Note**: in both these cases, you need sufficient access to the Kubernetes API to perform any actions.
20+
- use `port_forward_with_namespace` and optionally `kubernetes` configuration (to temporarily expose the ArgoCD API server using port forwarding) along with a `username`/`password` or `auth_token`.
21+
- if you use port-forwarding and your argo-cd-server is running on plain HTTP you need to add the flag `plain_text = true` to the provider configuration as well
22+
- use `core` to run a local ArgoCD API server that communicates directly with the Kubernetes API. **NB**: When using `core`, take note of the warning in the docs below.
23+
24+
If you are struggling to determine the correct configuration for the provider or the provider is behaving strangely and failing to connect for whatever reason, then we would suggest that you first figure out what combination of parameters work to log in using the ArgoCD CLI (`argocd login`) and then set the provider configuration to match what you used in the CLI. See also the ArgoCD [Getting Started](https://argo-cd.readthedocs.io/en/stable/getting_started/#3-access-the-argo-cd-api-server) docs.
4425

4526
## Example Usage
4627

@@ -91,6 +72,7 @@ provider "argocd" {
9172
```
9273

9374
<!-- schema generated by tfplugindocs -->
75+
9476
## Schema
9577

9678
### Optional
@@ -106,14 +88,15 @@ provider "argocd" {
10688
**Warning**: this feature works by starting a local ArgoCD API server that talks directly to the Kubernetes API using the **current context in the default kubeconfig** (`~/.kube/config`). This behavior cannot be overridden using either environment variables or the `kubernetes` block in the provider configuration at present).
10789

10890
If the server fails to start (e.g. your kubeconfig is misconfigured) then the provider will fail as a result of the `argocd` module forcing it to exit and no logs will be available to help you debug this. The error message will be similar to
91+
10992
> `The plugin encountered an error, and failed to respond to the plugin.(*GRPCProvider).ReadResource call. The plugin logs may contain more details.`
11093
11194
To debug this, you will need to login via the ArgoCD CLI using `argocd login --core` and then running an operation. E.g. `argocd app list`.
11295
- `grpc_web` (Boolean) Whether to use gRPC web proxy client. Useful if Argo CD server is behind proxy which does not support HTTP2.
11396
- `grpc_web_root_path` (String) Use the gRPC web proxy client and set the web root, e.g. `argo-cd`. Useful if the Argo CD server is behind a proxy at a non-root path.
11497
- `headers` (Set of String) Additional headers to add to each request to the ArgoCD server.
11598
- `insecure` (Boolean) Whether to skip TLS server certificate. Can be set through the `ARGOCD_INSECURE` environment variable.
116-
- `kubernetes` (Block List, Max: 1) Kubernetes configuration overrides. Only relevant when `port_forward = true` or `port_forward_with_namespace = "foo"`. The kubeconfig file that is used can be overridden using the [`KUBECONFIG` environment variable](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable)). (see [below for nested schema](#nestedblock--kubernetes))
99+
- `kubernetes` (Block List, Max: 1) Kubernetes configuration overrides. Only relevant when `port_forward = true` or `port_forward_with_namespace = "foo"`. The kubeconfig file that is used can be overridden using the [`KUBECONFIG` environment variable](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable)). (see [below for nested schema](#nestedblock--kubernetes))
117100
- `password` (String, Sensitive) Authentication password. Can be set through the `ARGOCD_AUTH_PASSWORD` environment variable.
118101
- `plain_text` (Boolean) Whether to initiate an unencrypted connection to ArgoCD server.
119102
- `port_forward` (Boolean) Connect to a random argocd-server port using port forwarding.
@@ -124,6 +107,7 @@ provider "argocd" {
124107
- `username` (String) Authentication username. Can be set through the `ARGOCD_AUTH_USERNAME` environment variable.
125108

126109
<a id="nestedblock--kubernetes"></a>
110+
127111
### Nested Schema for `kubernetes`
128112

129113
Optional:
@@ -142,6 +126,7 @@ Optional:
142126
- `username` (String) The username to use for HTTP basic authentication when accessing the Kubernetes API. Can be sourced from `KUBE_USER`.
143127

144128
<a id="nestedblock--kubernetes--exec"></a>
129+
145130
### Nested Schema for `kubernetes.exec`
146131

147132
Required:
@@ -152,4 +137,4 @@ Required:
152137
Optional:
153138

154139
- `args` (List of String) Map of environment variables to set when executing the plugin.
155-
- `env` (Map of String) List of arguments to pass when executing the plugin.
140+
- `env` (Map of String) List of arguments to pass when executing the plugin.

0 commit comments

Comments
 (0)