Skip to content

Commit

Permalink
auto-generated tools
Browse files Browse the repository at this point in the history
  • Loading branch information
rasschaert committed Oct 12, 2024
1 parent f85965e commit b800abb
Show file tree
Hide file tree
Showing 6 changed files with 173 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/data-sources/cluster.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: "pomeriumzero_cluster Data Source - terraform-provider-pomeriumzero"
subcategory: ""
description: |-
Pomerium Zero Cluster data source
---

# pomeriumzero_cluster (Data Source)

Pomerium Zero Cluster data source



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

### Required

- `name` (String) Cluster name

### Read-Only

- `auto_detect_ip_address` (String) Auto-detected IP address
- `created_at` (String) Creation timestamp
- `domain` (String) Cluster domain
- `fqdn` (String) Cluster FQDN
- `id` (String) Cluster identifier
- `namespace_id` (String) Cluster namespace ID
- `updated_at` (String) Last update timestamp
21 changes: 21 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomeriumzero Provider"
subcategory: ""
description: |-
---

# pomeriumzero Provider





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

### Required

- `api_token` (String, Sensitive) The API token for authenticating with Pomerium Zero
- `organization_name` (String) The name of the organization in Pomerium Zero
43 changes: 43 additions & 0 deletions docs/resources/cluster_settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomeriumzero_cluster_settings Resource - terraform-provider-pomeriumzero"
subcategory: ""
description: |-
Manages Pomerium Zero Cluster Settings.
---

# pomeriumzero_cluster_settings (Resource)

Manages Pomerium Zero Cluster Settings.



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

### Optional

- `address` (String) The address of the Pomerium Zero cluster.
- `authenticate_service_url` (String) The URL of the authentication service.
- `auto_apply_changesets` (Boolean) Whether to automatically apply changesets.
- `cookie_expire` (String) The expiration time for cookies.
- `cookie_http_only` (Boolean) Whether cookies should be HTTP only.
- `cookie_name` (String) The name of the cookie used for authentication.
- `default_upstream_timeout` (String) The default timeout for upstream requests.
- `dns_lookup_family` (String) The DNS lookup family to use (e.g., 'v4', 'v6').
- `identity_provider` (String) The identity provider to use for authentication.
- `identity_provider_client_id` (String) The client ID for the identity provider.
- `identity_provider_client_secret` (String, Sensitive) The client secret for the identity provider.
- `identity_provider_url` (String) The URL of the identity provider.
- `log_level` (String) The log level for the Pomerium Zero cluster.
- `pass_identity_headers` (Boolean) Whether to pass identity headers to upstream services.
- `proxy_log_level` (String) The log level for the proxy component.
- `skip_xff_append` (Boolean) Whether to skip appending X-Forwarded-For headers.
- `timeout_idle` (String) The idle timeout for connections.
- `timeout_read` (String) The read timeout for connections.
- `timeout_write` (String) The write timeout for connections.
- `tracing_sample_rate` (Number) The sampling rate for tracing.

### Read-Only

- `id` (String) The unique identifier of the cluster settings.
30 changes: 30 additions & 0 deletions docs/resources/policy.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: "pomeriumzero_policy Resource - terraform-provider-pomeriumzero"
subcategory: ""
description: |-
Manages a Pomerium Zero Policy.
---

# pomeriumzero_policy (Resource)

Manages a Pomerium Zero Policy.



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

### Required

- `description` (String) A description of the policy.
- `enforced` (Boolean) Whether the policy is enforced or not.
- `explanation` (String) An explanation of the policy.
- `name` (String) The name of the policy.
- `namespace_id` (String) The ID of the namespace this policy belongs to.
- `ppl` (String) The Pomerium Policy Language (PPL) definition for this policy.
- `remediation` (String) Instructions for remediating policy violations.

### Read-Only

- `id` (String) The unique identifier of the policy.
41 changes: 41 additions & 0 deletions docs/resources/route.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pomeriumzero_route Resource - terraform-provider-pomeriumzero"
subcategory: ""
description: |-
Manages a route resource in Pomerium Zero.
---

# pomeriumzero_route (Resource)

Manages a route resource in Pomerium Zero.



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

### Required

- `from` (String) The source URL for the route. This is the URL that Pomerium will listen on.
- `name` (String) The name of the route. Must be unique within the namespace.
- `namespace_id` (String) The ID of the namespace where the route will be created.
- `to` (List of String) A list of destination URLs for the route. These are the backend servers that Pomerium will forward requests to.

### Optional

- `allow_spdy` (Boolean) If set to `true`, allows the use of the SPDY protocol for this route.
- `allow_websockets` (Boolean) If set to `true`, allows WebSocket connections for this route.
- `enable_google_cloud_serverless_authentication` (Boolean) If set to `true`, enables Google Cloud Serverless Authentication for this route.
- `pass_identity_headers` (Boolean) If set to `true`, passes identity headers to the upstream service.
- `policy_ids` (List of String) A list of policy IDs to associate with this route. These policies will be applied to requests matching this route.
- `prefix` (String) The URL prefix for the route. If specified, only requests with this prefix will be matched.
- `prefix_rewrite` (String) If specified, rewrites the URL prefix before forwarding the request to the upstream service.
- `preserve_host_header` (Boolean) If set to `true`, preserves the original host header when proxying requests.
- `show_error_details` (Boolean) If set to `true`, shows detailed error messages when errors occur.
- `tls_skip_verify` (Boolean) If set to `true`, skips TLS verification for upstream connections. Use with caution.
- `tls_upstream_allow_renegotiation` (Boolean) If set to `true`, allows TLS renegotiation for upstream connections.

### Read-Only

- `id` (String) The unique identifier of the route.
8 changes: 8 additions & 0 deletions tools/tools.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//go:build tools

package tools

import (
// Documentation generation
_ "github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs"
)

0 comments on commit b800abb

Please sign in to comment.