Skip to content

Commit 85b6ce4

Browse files
gaurdrogaurdro
authored
Fix name and Add tooling to generate docs (#13)
1 parent 81c5cd5 commit 85b6ce4

16 files changed

+468
-1
lines changed

‎Makefile

+4
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,7 @@ lint:
99
build:
1010
@echo "@==> $@"
1111
@go build -o bin/terraform-provider-pomerium
12+
13+
.PHONY: docs
14+
docs:
15+
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest generate --provider-dir . -provider-name pomerium

‎docs/data-sources/namespace.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_namespace Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Namespace for Pomerium.
7+
---
8+
9+
# pomerium_namespace (Data Source)
10+
11+
Namespace for Pomerium.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `id` (String) Unique identifier for the namespace.
21+
22+
### Read-Only
23+
24+
- `name` (String) Name of the namespace.
25+
- `parent_id` (String) ID of the parent namespace.

‎docs/data-sources/namespaces.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_namespaces Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
List all namespaces
7+
---
8+
9+
# pomerium_namespaces (Data Source)
10+
11+
List all namespaces
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Read-Only
19+
20+
- `namespaces` (Attributes List) (see [below for nested schema](#nestedatt--namespaces))
21+
22+
<a id="nestedatt--namespaces"></a>
23+
### Nested Schema for `namespaces`
24+
25+
Read-Only:
26+
27+
- `id` (String) Unique identifier for the namespace.
28+
- `name` (String) Name of the namespace.
29+
- `parent_id` (String) ID of the parent namespace.

‎docs/data-sources/policies.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_policies Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
List all policies
7+
---
8+
9+
# pomerium_policies (Data Source)
10+
11+
List all policies
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Read-Only
19+
20+
- `policies` (Attributes List) (see [below for nested schema](#nestedatt--policies))
21+
22+
<a id="nestedatt--policies"></a>
23+
### Nested Schema for `policies`
24+
25+
Read-Only:
26+
27+
- `id` (String) Unique identifier for the policy.
28+
- `name` (String) Name of the policy.
29+
- `namespace_id` (String) ID of the namespace the policy belongs to.
30+
- `ppl` (String) Policy Policy Language (PPL) string.

‎docs/data-sources/policy.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_policy Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Policy for Pomerium.
7+
---
8+
9+
# pomerium_policy (Data Source)
10+
11+
Policy for Pomerium.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `id` (String) Unique identifier for the policy.
21+
22+
### Read-Only
23+
24+
- `name` (String) Name of the policy.
25+
- `namespace_id` (String) ID of the namespace the policy belongs to.
26+
- `ppl` (String) Policy Policy Language (PPL) string.

‎docs/data-sources/route.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_route Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Route data source
7+
---
8+
9+
# pomerium_route (Data Source)
10+
11+
Route data source
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `id` (String) Unique identifier for the route.
21+
22+
### Read-Only
23+
24+
- `from` (String) From URL.
25+
- `name` (String) Name of the route.
26+
- `namespace_id` (String) ID of the namespace the route belongs to.
27+
- `policies` (List of String) List of policy IDs associated with the route.
28+
- `to` (List of String) To URLs.

‎docs/data-sources/routes.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_routes Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
List all routes
7+
---
8+
9+
# pomerium_routes (Data Source)
10+
11+
List all routes
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Read-Only
19+
20+
- `routes` (Attributes List) (see [below for nested schema](#nestedatt--routes))
21+
22+
<a id="nestedatt--routes"></a>
23+
### Nested Schema for `routes`
24+
25+
Read-Only:
26+
27+
- `from` (String) From URL.
28+
- `id` (String) Unique identifier for the route.
29+
- `name` (String) Name of the route.
30+
- `namespace_id` (String) ID of the namespace the route belongs to.
31+
- `policies` (List of String) List of policy IDs associated with the route.
32+
- `to` (List of String) To URLs.

‎docs/data-sources/service_account.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_service_account Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Service Account for Pomerium.
7+
---
8+
9+
# pomerium_service_account (Data Source)
10+
11+
Service Account for Pomerium.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `id` (String) Unique identifier for the service account.
21+
22+
### Read-Only
23+
24+
- `description` (String) Description of the service account.
25+
- `expires_at` (String) Timestamp when the service account expires.
26+
- `name` (String) Name of the service account.
27+
- `namespace_id` (String) ID of the namespace the service account belongs to.
28+
- `user_id` (String) User ID associated with the service account.

‎docs/data-sources/service_accounts.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_service_accounts Data Source - pomerium"
4+
subcategory: ""
5+
description: |-
6+
List all service accounts
7+
---
8+
9+
# pomerium_service_accounts (Data Source)
10+
11+
List all service accounts
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Read-Only
19+
20+
- `service_accounts` (Attributes List) (see [below for nested schema](#nestedatt--service_accounts))
21+
22+
<a id="nestedatt--service_accounts"></a>
23+
### Nested Schema for `service_accounts`
24+
25+
Read-Only:
26+
27+
- `description` (String) Description of the service account.
28+
- `expires_at` (String) Timestamp when the service account expires.
29+
- `id` (String) Unique identifier for the service account.
30+
- `name` (String) Name of the service account.
31+
- `namespace_id` (String) ID of the namespace the service account belongs to.
32+
- `user_id` (String) User ID associated with the service account.

‎docs/index.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium Provider"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# pomerium Provider
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `api_url` (String) Pomerium Enterprise API URL
21+
22+
### Optional
23+
24+
- `service_account_token` (String, Sensitive) Pomerium Enterprise Service Account Token
25+
- `shared_secret_b64` (String, Sensitive) Pomerium Shared Secret (base64 encoded)
26+
- `tls_insecure_skip_verify` (Boolean) Skip TLS server certificate verification (for testing only)

‎docs/resources/namespace.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_namespace Resource - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Namespace for Pomerium.
7+
---
8+
9+
# pomerium_namespace (Resource)
10+
11+
Namespace for Pomerium.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) Name of the namespace.
21+
22+
### Optional
23+
24+
- `parent_id` (String) ID of the parent namespace (optional).
25+
26+
### Read-Only
27+
28+
- `id` (String) Unique identifier for the namespace.

‎docs/resources/policy.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_policy Resource - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Policy for Pomerium.
7+
---
8+
9+
# pomerium_policy (Resource)
10+
11+
Policy for Pomerium.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) Name of the policy.
21+
- `namespace_id` (String) ID of the namespace the policy belongs to.
22+
- `ppl` (String) Policy Policy Language (PPL) string.
23+
24+
### Read-Only
25+
26+
- `id` (String) Unique identifier for the policy.

‎docs/resources/route.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_route Resource - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Route for Pomerium.
7+
---
8+
9+
# pomerium_route (Resource)
10+
11+
Route for Pomerium.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `from` (String) From URL.
21+
- `name` (String) Name of the route.
22+
- `namespace_id` (String) ID of the namespace the route belongs to.
23+
- `to` (List of String) To URLs.
24+
25+
### Optional
26+
27+
- `policies` (List of String) List of policy IDs associated with the route.
28+
29+
### Read-Only
30+
31+
- `id` (String) Unique identifier for the route.

‎docs/resources/service_account.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "pomerium_service_account Resource - pomerium"
4+
subcategory: ""
5+
description: |-
6+
Service Account for Pomerium.
7+
---
8+
9+
# pomerium_service_account (Resource)
10+
11+
Service Account for Pomerium.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) Name of the service account.
21+
- `namespace_id` (String) ID of the namespace the service account belongs to.
22+
23+
### Optional
24+
25+
- `description` (String) Description of the service account.
26+
27+
### Read-Only
28+
29+
- `expires_at` (String) Timestamp when the service account expires.
30+
- `id` (String) Unique identifier for the service account.
31+
- `user_id` (String) User ID associated with the service account.

0 commit comments

Comments
 (0)