Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix name and Add tooling to generate docs #13

Merged
merged 7 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ lint:
build:
@echo "@==> $@"
@go build -o bin/terraform-provider-pomerium

.PHONY: docs
docs:
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest generate --provider-dir . -provider-name pomerium
25 changes: 25 additions & 0 deletions docs/data-sources/namespace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_namespace Data Source - pomerium"
subcategory: ""
description: |-
Namespace for Pomerium.
---

# pomerium_namespace (Data Source)

Namespace for Pomerium.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Unique identifier for the namespace.

### Read-Only

- `name` (String) Name of the namespace.
- `parent_id` (String) ID of the parent namespace.
29 changes: 29 additions & 0 deletions docs/data-sources/namespaces.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_namespaces Data Source - pomerium"
subcategory: ""
description: |-
List all namespaces
---

# pomerium_namespaces (Data Source)

List all namespaces



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `namespaces` (Attributes List) (see [below for nested schema](#nestedatt--namespaces))

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

Read-Only:

- `id` (String) Unique identifier for the namespace.
- `name` (String) Name of the namespace.
- `parent_id` (String) ID of the parent namespace.
30 changes: 30 additions & 0 deletions docs/data-sources/policies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_policies Data Source - pomerium"
subcategory: ""
description: |-
List all policies
---

# pomerium_policies (Data Source)

List all policies



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `policies` (Attributes List) (see [below for nested schema](#nestedatt--policies))

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

Read-Only:

- `id` (String) Unique identifier for the policy.
- `name` (String) Name of the policy.
- `namespace_id` (String) ID of the namespace the policy belongs to.
- `ppl` (String) Policy Policy Language (PPL) string.
26 changes: 26 additions & 0 deletions docs/data-sources/policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_policy Data Source - pomerium"
subcategory: ""
description: |-
Policy for Pomerium.
---

# pomerium_policy (Data Source)

Policy for Pomerium.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Unique identifier for the policy.

### Read-Only

- `name` (String) Name of the policy.
- `namespace_id` (String) ID of the namespace the policy belongs to.
- `ppl` (String) Policy Policy Language (PPL) string.
28 changes: 28 additions & 0 deletions docs/data-sources/route.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_route Data Source - pomerium"
subcategory: ""
description: |-
Route data source
---

# pomerium_route (Data Source)

Route data source



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Unique identifier for the route.

### Read-Only

- `from` (String) From URL.
- `name` (String) Name of the route.
- `namespace_id` (String) ID of the namespace the route belongs to.
- `policies` (List of String) List of policy IDs associated with the route.
- `to` (List of String) To URLs.
32 changes: 32 additions & 0 deletions docs/data-sources/routes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_routes Data Source - pomerium"
subcategory: ""
description: |-
List all routes
---

# pomerium_routes (Data Source)

List all routes



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `routes` (Attributes List) (see [below for nested schema](#nestedatt--routes))

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

Read-Only:

- `from` (String) From URL.
- `id` (String) Unique identifier for the route.
- `name` (String) Name of the route.
- `namespace_id` (String) ID of the namespace the route belongs to.
- `policies` (List of String) List of policy IDs associated with the route.
- `to` (List of String) To URLs.
28 changes: 28 additions & 0 deletions docs/data-sources/service_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_service_account Data Source - pomerium"
subcategory: ""
description: |-
Service Account for Pomerium.
---

# pomerium_service_account (Data Source)

Service Account for Pomerium.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Unique identifier for the service account.

### Read-Only

- `description` (String) Description of the service account.
- `expires_at` (String) Timestamp when the service account expires.
- `name` (String) Name of the service account.
- `namespace_id` (String) ID of the namespace the service account belongs to.
- `user_id` (String) User ID associated with the service account.
32 changes: 32 additions & 0 deletions docs/data-sources/service_accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_service_accounts Data Source - pomerium"
subcategory: ""
description: |-
List all service accounts
---

# pomerium_service_accounts (Data Source)

List all service accounts



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `service_accounts` (Attributes List) (see [below for nested schema](#nestedatt--service_accounts))

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

Read-Only:

- `description` (String) Description of the service account.
- `expires_at` (String) Timestamp when the service account expires.
- `id` (String) Unique identifier for the service account.
- `name` (String) Name of the service account.
- `namespace_id` (String) ID of the namespace the service account belongs to.
- `user_id` (String) User ID associated with the service account.
26 changes: 26 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium Provider"
subcategory: ""
description: |-

---

# pomerium Provider





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `api_url` (String) Pomerium Enterprise API URL

### Optional

- `service_account_token` (String, Sensitive) Pomerium Enterprise Service Account Token
- `shared_secret_b64` (String, Sensitive) Pomerium Shared Secret (base64 encoded)
- `tls_insecure_skip_verify` (Boolean) Skip TLS server certificate verification (for testing only)
28 changes: 28 additions & 0 deletions docs/resources/namespace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_namespace Resource - pomerium"
subcategory: ""
description: |-
Namespace for Pomerium.
---

# pomerium_namespace (Resource)

Namespace for Pomerium.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the namespace.

### Optional

- `parent_id` (String) ID of the parent namespace (optional).

### Read-Only

- `id` (String) Unique identifier for the namespace.
26 changes: 26 additions & 0 deletions docs/resources/policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_policy Resource - pomerium"
subcategory: ""
description: |-
Policy for Pomerium.
---

# pomerium_policy (Resource)

Policy for Pomerium.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the policy.
- `namespace_id` (String) ID of the namespace the policy belongs to.
- `ppl` (String) Policy Policy Language (PPL) string.

### Read-Only

- `id` (String) Unique identifier for the policy.
31 changes: 31 additions & 0 deletions docs/resources/route.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_route Resource - pomerium"
subcategory: ""
description: |-
Route for Pomerium.
---

# pomerium_route (Resource)

Route for Pomerium.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `from` (String) From URL.
- `name` (String) Name of the route.
- `namespace_id` (String) ID of the namespace the route belongs to.
- `to` (List of String) To URLs.

### Optional

- `policies` (List of String) List of policy IDs associated with the route.

### Read-Only

- `id` (String) Unique identifier for the route.
31 changes: 31 additions & 0 deletions docs/resources/service_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomerium_service_account Resource - pomerium"
subcategory: ""
description: |-
Service Account for Pomerium.
---

# pomerium_service_account (Resource)

Service Account for Pomerium.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the service account.
- `namespace_id` (String) ID of the namespace the service account belongs to.

### Optional

- `description` (String) Description of the service account.

### Read-Only

- `expires_at` (String) Timestamp when the service account expires.
- `id` (String) Unique identifier for the service account.
- `user_id` (String) User ID associated with the service account.
Loading
Loading