From 5ffe60f2e41a9a6bd5dced2c5652402f2403792c Mon Sep 17 00:00:00 2001 From: Denis Mishin Date: Thu, 2 Jan 2025 13:30:52 -0500 Subject: [PATCH] update docs --- docs/resources/key_pair.md | 30 ++++++++++++++++++++++++++++++ docs/resources/policy.md | 8 ++++++++ docs/resources/route.md | 29 +++++++++++++++++++++++++++++ 3 files changed, 67 insertions(+) create mode 100644 docs/resources/key_pair.md diff --git a/docs/resources/key_pair.md b/docs/resources/key_pair.md new file mode 100644 index 0000000..c40d213 --- /dev/null +++ b/docs/resources/key_pair.md @@ -0,0 +1,30 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "pomerium_key_pair Resource - pomerium" +subcategory: "" +description: |- + KeyPairs managed by Pomerium. +--- + +# pomerium_key_pair (Resource) + +KeyPairs managed by Pomerium. + + + + +## Schema + +### Required + +- `certificate` (String) PEM encoded certificate +- `name` (String) Name of the key pair +- `namespace_id` (String) ID of the namespace this key pair belongs to + +### Optional + +- `key` (String, Sensitive) PEM encoded private key + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/docs/resources/policy.md b/docs/resources/policy.md index 2cb4782..415c6c6 100644 --- a/docs/resources/policy.md +++ b/docs/resources/policy.md @@ -21,6 +21,14 @@ Policy for Pomerium. - `namespace_id` (String) ID of the namespace the policy belongs to. - `ppl` (String) Policy Policy Language (PPL) string. +### Optional + +- `description` (String) Description of the policy. +- `enforced` (Boolean) Whether the policy is enforced within the namespace hierarchy. +- `explanation` (String) Explanation of the policy. +- `rego` (List of String) Rego policies. +- `remediation` (String) Remediation of the policy. + ### Read-Only - `id` (String) Unique identifier for the policy. diff --git a/docs/resources/route.md b/docs/resources/route.md index c988aa7..eb8f395 100644 --- a/docs/resources/route.md +++ b/docs/resources/route.md @@ -24,7 +24,36 @@ Route for Pomerium. ### Optional +- `allow_spdy` (Boolean) Allow SPDY. +- `allow_websockets` (Boolean) Allow websockets. +- `host_path_regex_rewrite_pattern` (String) Host path regex rewrite pattern. +- `host_path_regex_rewrite_substitution` (String) Host path regex rewrite substitution. +- `host_rewrite` (String) Host rewrite. +- `host_rewrite_header` (String) Host rewrite header. +- `idle_timeout` (String) Idle timeout. +- `idp_client_id` (String) IDP client ID. +- `idp_client_secret` (String) IDP client secret. +- `kubernetes_service_account_token` (String) Kubernetes service account token. +- `pass_identity_headers` (Boolean) Pass identity headers. +- `path` (String) Path. - `policies` (List of String) List of policy IDs associated with the route. +- `prefix` (String) Prefix. +- `prefix_rewrite` (String) Prefix rewrite. +- `preserve_host_header` (Boolean) Preserve host header. +- `regex` (String) Regex. +- `regex_priority_order` (Number) Regex priority order. +- `regex_rewrite_pattern` (String) Regex rewrite pattern. +- `regex_rewrite_substitution` (String) Regex rewrite substitution. +- `remove_request_headers` (List of String) Remove request headers. +- `set_request_headers` (Map of String) Set request headers. +- `set_response_headers` (Map of String) Set response headers. +- `show_error_details` (Boolean) Show error details. +- `stat_name` (String) Name of the stat. +- `timeout` (String) Timeout. +- `tls_downstream_server_name` (String) TLS downstream server name. +- `tls_skip_verify` (Boolean) TLS skip verify. +- `tls_upstream_allow_renegotiation` (Boolean) TLS upstream allow renegotiation. +- `tls_upstream_server_name` (String) TLS upstream server name. ### Read-Only