From df4f3ffb7c3f404d2fddb863ad7e2b02c143b907 Mon Sep 17 00:00:00 2001 From: Svetlana Rekuts Date: Wed, 26 Mar 2025 19:50:48 +0000 Subject: [PATCH 1/6] Add `Terrafom` configuration (tab) for each element in the Global Settings --- content/docs/reference/access-log-fields.mdx | 21 + content/docs/reference/address.mdx | 12 + .../reference/authenticate-callback-path.mdx | 13 + .../docs/reference/authorize-log-fields.mdx | 12 + content/docs/reference/autocert.mdx | 58 ++ content/docs/reference/certificates.mdx | 29 + content/docs/reference/cookies.mdx | 72 ++ content/docs/reference/dns-lookup-family.mdx | 11 + content/docs/reference/global-timeouts.mdx | 36 + ...verless-authentication-service-account.mdx | 11 + content/docs/reference/grpc.mdx | 22 + .../docs/reference/http-redirect-address.mdx | 11 + .../reference/identity-provider-settings.mdx | 66 ++ content/docs/reference/insecure-server.mdx | 11 + content/docs/reference/jwt-claim-headers.mdx | 13 + content/docs/reference/log-level.mdx | 13 + content/docs/reference/metrics.mdx | 13 + .../docs/reference/pass-identity-headers.mdx | 12 + content/docs/reference/proxy-log-level.mdx | 13 + content/docs/reference/service-urls.md | 38 +- .../docs/reference/set-response-headers.mdx | 13 + .../reference/x-forwarded-for-settings.mdx | 13 + package.json | 10 +- yarn.lock | 792 +++++++++--------- 24 files changed, 909 insertions(+), 406 deletions(-) diff --git a/content/docs/reference/access-log-fields.mdx b/content/docs/reference/access-log-fields.mdx index bb6fc1428..c65524698 100644 --- a/content/docs/reference/access-log-fields.mdx +++ b/content/docs/reference/access-log-fields.mdx @@ -87,6 +87,27 @@ accessLogFields: - headers.content-type ``` + + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings#access_log_fields-1)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `accessLogFields` | Set of strings | See [Access Fields and Defaults](#access-fields-and-defaults) | + +### Examples + +```yaml +access_log_fields = ["authority", "duration", "path"] +``` + + +**Custom headers example** + +```yaml +access_log_fields = ["headers.user-agent", "headers.content-type"] +``` + diff --git a/content/docs/reference/address.mdx b/content/docs/reference/address.mdx index b61d34969..b3d88f633 100644 --- a/content/docs/reference/address.mdx +++ b/content/docs/reference/address.mdx @@ -55,5 +55,17 @@ ADDRESS=:8443 `address` is included in the deployment manifest and not customizable. + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings#address-1)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `address` | String | `:443` | + +### Examples + +```yaml +address = ":8433" +``` diff --git a/content/docs/reference/authenticate-callback-path.mdx b/content/docs/reference/authenticate-callback-path.mdx index 60102bc12..be4f14558 100644 --- a/content/docs/reference/authenticate-callback-path.mdx +++ b/content/docs/reference/authenticate-callback-path.mdx @@ -75,5 +75,18 @@ authenticate: callbackPath: /custom/callback ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | +| :-- | :-- | :-- | :-- | +| `authenticate_callback_path` | `string` | **optional** | `/oauth2/callback` | + +### Examples + +```yaml +authenticate_callback_path = "/custom/callback" +``` + diff --git a/content/docs/reference/authorize-log-fields.mdx b/content/docs/reference/authorize-log-fields.mdx index d87efc146..eaafa4c91 100644 --- a/content/docs/reference/authorize-log-fields.mdx +++ b/content/docs/reference/authorize-log-fields.mdx @@ -91,6 +91,18 @@ authorizeLogFields: - ip ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `authorize_log_fields` | Set of string | See [Authorize Fields and Defaults](#authorize-log-fields-and-defaults) | + +### Examples + +```yaml +authorize_log_fields = ["request-id", "path", "ip"] +``` diff --git a/content/docs/reference/autocert.mdx b/content/docs/reference/autocert.mdx index b5b3598b1..3d3c06af2 100644 --- a/content/docs/reference/autocert.mdx +++ b/content/docs/reference/autocert.mdx @@ -12,6 +12,8 @@ keywords: pagination_prev: null pagination_next: null --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; # Autocert Settings @@ -54,6 +56,9 @@ If you use Let's Encrypt as your CA, you agree to the [Let's Encrypt Subscriber ### How to configure {#autocert-how-to-configure} + + + | **Config file keys** | **Environment variables** | **Type** | **Usage** | | :------------------- | :------------------------ | :-------- | :----------- | | `autocert` | `AUTOCERT` | `boolean` | **optional** | @@ -67,6 +72,20 @@ autocert: true ```bash AUTOCERT=TRUE ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `autocert` | Boolean | **optional** | + +### Examples + +```yaml +autocert = true +``` + + ## Autocert CA {#autocert-ca} @@ -99,6 +118,8 @@ AUTOCERT_CA=https://acme.zerossl.com/v2/DV90 **Autocert Directory** is the path where [Autocert](/docs/reference/autocert) stores X.509 certificate data. ### How to configure {#autocert-directory-how-to-configure} + + | **Config file keys** | **Environment variables** | **Type** | **Usage** | | :-- | :-- | :-- | :-- | @@ -130,6 +151,43 @@ autocert_dir: gs://your-bucket/some/prefix Credentials are sourced from [Google Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials). + + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `autocert_dir` | \*`String` | \*\* **optional** | + +\* `String` must point to the directory path or URL of an S3 or GCS bucket. + +\*\* If you don't specify an Autocert directory, Pomerium will generate a directory by default based on your runtime environment. See [Defaults](#autocert-directory-defaults) for more information. + +#### Examples {#autocert-directory-examples} + +##### S3 bucket + +An S3 bucket can be used as storage by using a URL like: + +```yaml +autocert_dir = "s3://your-bucket.s3.us-east-1.amazonaws.com/some/prefix" +``` + +Credentials are sourced from [the environment](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/config#EnvConfig). + +##### GCS bucket + +A Google Cloud Storage bucket can be used as storage by using a URL like: + +```yaml +autocert_dir = "gs://your-bucket/some/prefix" +``` + +Credentials are sourced from [Google Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials). + + + + ### Defaults {#autocert-directory-defaults} | **Default paths** | **Value** | diff --git a/content/docs/reference/certificates.mdx b/content/docs/reference/certificates.mdx index 7a354b19e..69a640f0f 100644 --- a/content/docs/reference/certificates.mdx +++ b/content/docs/reference/certificates.mdx @@ -94,6 +94,21 @@ certificates: pomerium/wildcard-localhost See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for more information. + + +```yaml +resource "pomerium_key_pair" "wildcard-localhost" { + namespace_id = pomerium_namespace.test_namespace.id + name = "wildcard-localhost-key-pair" + certificate = file("wildcard.localhost.pomerium.io.pem") + key = file("wildcard.localhost.pomerium.io-key.pem") +} +``` + +See Pomerium Terraform Provider [pomerium_key_pair](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/key_pair) for more information. + + + :::note @@ -150,5 +165,19 @@ Configure **Certificate Authority** in the Enterprise Console: Kubernetes does not support `certificate_authority` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `certificate_authority` | String | **optional** | +| `certificate_authority_file` | String | **optional** | + +### Examples + +```yaml +certificate_authority = "base64-encoded-string" +certificate_authority_file = "/relative/file/location" +``` diff --git a/content/docs/reference/cookies.mdx b/content/docs/reference/cookies.mdx index 64608d0f7..eec51225e 100644 --- a/content/docs/reference/cookies.mdx +++ b/content/docs/reference/cookies.mdx @@ -64,6 +64,18 @@ cookie: name: cookie_name ``` + + + +| **[Parameter name](/docs/deploy/k8s/reference#cookie)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `cookie_name` | `string` | `_pomerium` | + +#### Examples {#cookie-name-examples} + +```yaml +cookie_name = "cookie_name" +``` @@ -108,6 +120,18 @@ COOKIE_SECRET=tdkuWzUelRukP/6VYzopfh6kis7y5u5Ldl3MrIq9ZR0= See Kubernetes [bootstrap secrets](/docs/deploy/k8s/configure#bootstrap-secrets) for more information. + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `cookie_secret` | `String` | **optional** | + +#### Examples {#cookie-name-examples} + +```yaml +cookie_secret = "tdkuWzUelRukP/6VYzopfh6kis7y5u5Ldl3MrIq9ZR0=" +``` @@ -155,6 +179,18 @@ cookie: domain: localhost.pomerium.io ``` + + + +| **[Parameter name](/docs/deploy/k8s/reference#cookie)** | **Type** | **Usage** | **Default** | +| :-- | :-- | :-- | :-- | +| `cookie_domain` | `String` | **optional** | The host that set the cookie | + +#### Examples {#cookie-domain-examples} + +```yaml +cookie_domain = "localhost.pomerium.io" +``` @@ -205,7 +241,18 @@ Configure **Cookie HTTP Only** with the **Javascript Security** toggle button in cookie: httpOnly: false ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `cookie_http_only ` | `boolean` | `true` | +#### Examples {#cookie-http-only-examples} + +```yaml +cookie_http_only = false +``` @@ -251,6 +298,18 @@ cookie: expire: 13h15m0.5s ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `cookie_expire ` | `string` ([Go Duration](https://golang.org/pkg/time/#Duration.String) formatting) | `14h` | + +#### Examples {#cookie-expiration-examples} + +```yaml +cookie_expire = "13h15m0.5s" +``` @@ -300,6 +359,19 @@ cookie: sameSite: None ``` + + + +| **[Parameter name](/docs/deploy/k8s/reference#cookie)** | **Type** | **Usage** | **Default** | **Options** | +| :-- | :-- | :-- | :-- | :-- | +| `cookie_same_site` | `String` | **optional** | ` Lax` (if unset) | See [Cookie SameSite Options](#cookie-samesite-options) | + +#### Examples {#cookie-samesite-examples} + +```yaml +cookie_same_site = "Lax" +``` + diff --git a/content/docs/reference/dns-lookup-family.mdx b/content/docs/reference/dns-lookup-family.mdx index 67ca72f4f..157711cbc 100644 --- a/content/docs/reference/dns-lookup-family.mdx +++ b/content/docs/reference/dns-lookup-family.mdx @@ -51,6 +51,17 @@ Set **DNS Lookup Family** in the Console: Kubernetes does not support `dns_lookup_family` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `dns_lookup_family` | String | `V4_PREFERRED` | +### Examples + +```yaml +default_lookup_family = "AUTO" +``` diff --git a/content/docs/reference/global-timeouts.mdx b/content/docs/reference/global-timeouts.mdx index 231d1efe3..57de5a6db 100644 --- a/content/docs/reference/global-timeouts.mdx +++ b/content/docs/reference/global-timeouts.mdx @@ -67,6 +67,18 @@ timeouts: read: 30s ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Defaults** | +| :-- | :-- | :-- | +| `timeout_read ` | [Go Duration] string | `30s` | + +### Examples + +```yaml +timeout_read = "30s" +``` @@ -114,6 +126,18 @@ timeouts: write: 0 ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `timeout_write` | [Go Duration] string | `0` (no timeout) | + +### Examples + +```yaml +timeout_write = "0" +``` @@ -161,6 +185,18 @@ timeouts: idle: 5m ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `timeout_idle ` | [Go Duration] string | `5m` | + +### Examples + +```yaml +timeout_idle = "5m" +``` diff --git a/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx b/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx index a567143c6..decfc35f4 100644 --- a/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx +++ b/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx @@ -52,5 +52,16 @@ GOOGLE_CLOUD_SERVERLESS_AUTHENTICATION_SERVICE_ACCOUNT=base64-encoded-service-ac Kubernetes does not support `google_cloud_serverless_authentication_service_account` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `google_cloud_serverless_authentication_service_account ` | String | **optional** | +### Examples + +```yaml +google_cloud_serverless_authentication_service_account = "base64-encoded-service-account-credentials" +``` diff --git a/content/docs/reference/grpc.mdx b/content/docs/reference/grpc.mdx index 8e78fe343..a8989cb32 100644 --- a/content/docs/reference/grpc.mdx +++ b/content/docs/reference/grpc.mdx @@ -57,6 +57,17 @@ GRPC_ADDRESS=:8443 **gRPC Address** is not customizable with Kubernetes + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `grpc_address` | String | `:5443` in all-in-one mode
`:443` in [split service mode] | +### Examples + +```yaml +grpc_address = ":8443" +``` @@ -129,6 +140,17 @@ GRPC_INSECURE=false **gRPC Insecure** is not customizable in Kubernetes + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `grpc_insecure` | Boolean | `true` in all-in-one mode
`false` in [split service mode] | +### Examples + +```yaml +grpc_insecure = false +``` diff --git a/content/docs/reference/http-redirect-address.mdx b/content/docs/reference/http-redirect-address.mdx index 2cc6c0a32..0c99881b9 100644 --- a/content/docs/reference/http-redirect-address.mdx +++ b/content/docs/reference/http-redirect-address.mdx @@ -49,5 +49,16 @@ Set **HTTP Redirect Address** in the Console: ![Set HTTP redirect address in the **HTTP Redirect Address** is not customizable in Kubernetes + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `http_redirect_addr` | String | **optional** | +### Examples + +```yaml +http_redirect_addr = ":80" +``` diff --git a/content/docs/reference/identity-provider-settings.mdx b/content/docs/reference/identity-provider-settings.mdx index 84bd064d3..3183e623c 100644 --- a/content/docs/reference/identity-provider-settings.mdx +++ b/content/docs/reference/identity-provider-settings.mdx @@ -72,6 +72,17 @@ Configure **Identity Provider Client ID** under **IDP Options** in the Console: See [`identityProvider.secret`](/docs/deploy/k8s/reference#identityprovider) + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `idp_client_id` | String | **required** (if self-hosting) | +### Examples + +```yaml +idp_client_id = idp_client_id +``` @@ -110,6 +121,17 @@ Configure **Identity Provider Client Secret** under **IDP Settings** in the Cons See [`identityProvider.secret`](/docs/deploy/k8s/reference#identityprovider) for more information + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `idp_client_secret` | String | **required** (unless using [idp_client_secret_file](#identity-provider-client-secret-file)) | +### Examples + +```yaml +idp_client_secret = idp_client_secret +``` @@ -202,6 +224,17 @@ Set **Identity Provider Name** under the **Identity Provider** options in the Co See [`identityProvider.provider`](/docs/deploy/k8s/reference#identityprovider) for more information + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `idp_provider` | String | **required** (if [self-hosting](/docs/capabilities/authentication)) | +### Examples + +```yaml +idp_provider = "auth0" +``` @@ -243,6 +276,17 @@ Configure **Identity Provider Request Params** under **Authenticate** settings i See Kubernetes [`identityProvider.requestParams` and `identityProvider.requestParamsSecret`](/docs/deploy/k8s/reference#identityprovider) for more information + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `request_params` | Map of String | **optional** | +### Examples + +```yaml +request_params = {"client_id": "client_id", "response_type": "response_type", "redirect_uri": "redirect_uri"} +``` @@ -314,6 +358,17 @@ Configure **Identity Provider Scopes** under **Authenticate** settings in the Co See Kubernetes [`identityProvider.scopes`](/docs/deploy/k8s/reference#identityprovider) for more information + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `scopes` | Set of String | **optional** | +### Examples + +```yaml +scopes = ["openid", "profile", "offline_access", "email"] +``` @@ -363,6 +418,17 @@ Set the **Identity Provider URL** under **IDP Options** settings in the Console: See Kubernetes [`identityProvider.url`](/docs/deploy/k8s/reference#identityprovider) for more information + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `idp_provider_url` | String | **required** (depending on identity provider) | +### Examples + +```yaml +idp_provider_url = "https://awesome-company.auth0.com" +``` diff --git a/content/docs/reference/insecure-server.mdx b/content/docs/reference/insecure-server.mdx index e21e4ea1c..98578083a 100644 --- a/content/docs/reference/insecure-server.mdx +++ b/content/docs/reference/insecure-server.mdx @@ -57,5 +57,16 @@ INSECURE_SERVER=true Kubernetes does not support **Insecure Server** + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `insecure_server` | Boolean | **required** (if [certificates](/docs/reference/certificates) unset) | +### Examples + +```yaml +insecure_server = true +``` diff --git a/content/docs/reference/jwt-claim-headers.mdx b/content/docs/reference/jwt-claim-headers.mdx index 9907d9125..e39fef353 100644 --- a/content/docs/reference/jwt-claim-headers.mdx +++ b/content/docs/reference/jwt-claim-headers.mdx @@ -62,6 +62,19 @@ jwtClaimHeaders: X-Username: user ``` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `jwt_claims_headers` | Map of String | **optional** | + +### Examples + +```yaml +jwt_claims_headers = {"X-Email": "email", "X-Username": "user"} +``` + diff --git a/content/docs/reference/log-level.mdx b/content/docs/reference/log-level.mdx index 539384b8a..3f6f95e6c 100644 --- a/content/docs/reference/log-level.mdx +++ b/content/docs/reference/log-level.mdx @@ -59,5 +59,18 @@ Set **Log Level** under **Global** settings in the Console: Kubernetes does not support `log_level` + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `log_level` | String | `debug` | + +### Examples + +```yaml +log_level = "error" +``` + diff --git a/content/docs/reference/metrics.mdx b/content/docs/reference/metrics.mdx index 8dfa08dfc..986b44a1b 100644 --- a/content/docs/reference/metrics.mdx +++ b/content/docs/reference/metrics.mdx @@ -58,6 +58,19 @@ METRICS_ADDRESS: 127.0.0.1:9090 See Kubernetes [Metrics](/docs/deploy/k8s/install#metrics) + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `metrics_address` | String | `disabled` | + +### Examples + +```yaml +metrics_address = ":9090" +``` + diff --git a/content/docs/reference/pass-identity-headers.mdx b/content/docs/reference/pass-identity-headers.mdx index 737794bd7..bc2f010ce 100644 --- a/content/docs/reference/pass-identity-headers.mdx +++ b/content/docs/reference/pass-identity-headers.mdx @@ -72,6 +72,18 @@ passIdentityHeaders: true See [Kubernetes - Global Configuration](/docs/deploy/k8s/configure) for more information. + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | +| :-- | :-- | :-- | :-- | +| `pass_identity_headers` | `Boolean` | **optional** | \*`false` | + +### Examples + +```yaml +pass_identity_headers = true +``` diff --git a/content/docs/reference/proxy-log-level.mdx b/content/docs/reference/proxy-log-level.mdx index e452d446d..8c4e92402 100644 --- a/content/docs/reference/proxy-log-level.mdx +++ b/content/docs/reference/proxy-log-level.mdx @@ -51,6 +51,19 @@ Set **Proxy Log Level** under **Global** settings in the Console: Kubernetes does not support **Proxy Log Level** + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `proxy_log_level` | String | `debug` or value of [`log_level`](/docs/reference/log-level) if set | + +### Examples + +```yaml +proxy_log_level = "error" +``` + diff --git a/content/docs/reference/service-urls.md b/content/docs/reference/service-urls.md index c108fd731..a44f3d4b9 100644 --- a/content/docs/reference/service-urls.md +++ b/content/docs/reference/service-urls.md @@ -92,6 +92,18 @@ authenticate: See the [Kubernetes - Global Configuration](/docs/deploy/k8s/configure#authenticate-endpoint) for more information. + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings) | **Type** | **Usage** | +| :-- | :-- | :-- | +| `authenticate_service_url` | `URL` | **optional** | + +### Examples + +```yaml +authenticate_service_url = "https://authenticate.corp.example.com" +``` @@ -181,6 +193,18 @@ AUTHORIZE_SERVICE_URL=https://pomerium-authorize-service.default.svc.cluster.loc The `authorize_service_url` is not customizable in all-in-one mode with the CRD + + + +| [Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings) | **Type** | **Usage** | +| :-- | :-- | :-- | +| `authorize_service_url` | `URL` | **optional** | + +### Examples + +```yaml +authorize_service_url = "https://localhost:5443" +``` @@ -197,7 +221,7 @@ If included, Authorize Internal Service URL will override Authorize Service URL. | **Config file keys** | **Environment variables** | **Type** | **Usage** | | :-- | :-- | :-- | :-- | -| `authorize_internal_service_url` | `AUTHORIZE_INTERNAL_SERVICE_URL` | `URL` | **required** (Inferred in all-in-one mode to be localhost) | +| `authorize_internal_service_url` | `AUTHORIZE_INTERNAL_SERVICE_URL` | `URL` | **required** (Inferred in all-in-one mode to be localhost)| ### Examples @@ -258,6 +282,18 @@ DATABROKER_SERVICE_URL=https://databroker.corp.example.com `databroker_service_url` is not customizable in Kubernetes for all-in-one mode deployments + + + +| [Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings) | **Type** | **Usage** | +| :-- | :-- | :-- | +| `databroker_service_url` | `String` | **optional** | + +### Examples + +```yaml +databroker_service_url = "http://databroker.corp.example1.com" +``` diff --git a/content/docs/reference/set-response-headers.mdx b/content/docs/reference/set-response-headers.mdx index 3cb6181c5..e20580cc5 100644 --- a/content/docs/reference/set-response-headers.mdx +++ b/content/docs/reference/set-response-headers.mdx @@ -67,6 +67,19 @@ ingress.pomerium.io/set_response_headers: | X-Test: X-Value ``` + + + +| **[Annotation name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `set_response_headers` | Map of String | see [Default headers](#default) | + +### Examples + +```yaml +set_response_headers = {"X-Test": "X-Value", "X-Test2": "X-Value2"} +``` + diff --git a/content/docs/reference/x-forwarded-for-settings.mdx b/content/docs/reference/x-forwarded-for-settings.mdx index 318484e01..6ced5229b 100644 --- a/content/docs/reference/x-forwarded-for-settings.mdx +++ b/content/docs/reference/x-forwarded-for-settings.mdx @@ -67,6 +67,19 @@ Configure **X-Forward-For HTTP Header** with the toggle button in the Console. T Kubernetes does not support `skip_xff_append` + + + +| **[Annotation name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | +| :-- | :-- | :-- | +| `skip_xff_append` | Boolean | `false` | + +### Examples + +```yaml +skip_xff_append = true +``` + diff --git a/package.json b/package.json index c50968e9d..6d0b8be37 100644 --- a/package.json +++ b/package.json @@ -17,11 +17,11 @@ "format-check": "prettier --check ." }, "dependencies": { - "@docusaurus/core": "^3.6.3", - "@docusaurus/preset-classic": "^3.6.3", - "@docusaurus/theme-common": "^3.6.0", - "@docusaurus/theme-mermaid": "^3.6.0", - "@docusaurus/types": "^3.4.0", + "@docusaurus/core": "^3.7.0", + "@docusaurus/preset-classic": "^3.7.0", + "@docusaurus/theme-common": "^3.7.0", + "@docusaurus/theme-mermaid": "^3.7.0", + "@docusaurus/types": "^3.7.0", "@emotion/react": "^11.11.3", "@emotion/styled": "^11.11.0", "@mdx-js/react": "^3.0.0", diff --git a/yarn.lock b/yarn.lock index cb966b606..f134adafd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2,51 +2,32 @@ # yarn lockfile v1 -"@algolia/autocomplete-core@1.17.7": - version "1.17.7" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.17.7.tgz#2c410baa94a47c5c5f56ed712bb4a00ebe24088b" - integrity sha512-BjiPOW6ks90UKl7TwMv7oNQMnzU+t/wk9mgIDi6b1tXpUek7MW0lbNOUHpvam9pe3lVCf4xPFT+lK7s+e+fs7Q== +"@algolia/autocomplete-core@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.17.9.tgz#83374c47dc72482aa45d6b953e89377047f0dcdc" + integrity sha512-O7BxrpLDPJWWHv/DLA9DRFWs+iY1uOJZkqUwjS5HSZAGcl0hIVCQ97LTLewiZmZ402JYUrun+8NqFP+hCknlbQ== dependencies: - "@algolia/autocomplete-plugin-algolia-insights" "1.17.7" - "@algolia/autocomplete-shared" "1.17.7" + "@algolia/autocomplete-plugin-algolia-insights" "1.17.9" + "@algolia/autocomplete-shared" "1.17.9" -"@algolia/autocomplete-plugin-algolia-insights@1.17.7": - version "1.17.7" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.17.7.tgz#7d2b105f84e7dd8f0370aa4c4ab3b704e6760d82" - integrity sha512-Jca5Ude6yUOuyzjnz57og7Et3aXjbwCSDf/8onLHSQgw1qW3ALl9mrMWaXb5FmPVkV3EtkD2F/+NkT6VHyPu9A== +"@algolia/autocomplete-plugin-algolia-insights@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.17.9.tgz#74c86024d09d09e8bfa3dd90b844b77d9f9947b6" + integrity sha512-u1fEHkCbWF92DBeB/KHeMacsjsoI0wFhjZtlCq2ddZbAehshbZST6Hs0Avkc0s+4UyBGbMDnSuXHLuvRWK5iDQ== dependencies: - "@algolia/autocomplete-shared" "1.17.7" + "@algolia/autocomplete-shared" "1.17.9" -"@algolia/autocomplete-preset-algolia@1.17.7": - version "1.17.7" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.17.7.tgz#c9badc0d73d62db5bf565d839d94ec0034680ae9" - integrity sha512-ggOQ950+nwbWROq2MOCIL71RE0DdQZsceqrg32UqnhDz8FlO9rL8ONHNsI2R1MH0tkgVIDKI/D0sMiUchsFdWA== +"@algolia/autocomplete-preset-algolia@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.17.9.tgz#911f3250544eb8ea4096fcfb268f156b085321b5" + integrity sha512-Na1OuceSJeg8j7ZWn5ssMu/Ax3amtOwk76u4h5J4eK2Nx2KB5qt0Z4cOapCsxot9VcEN11ADV5aUSlQF4RhGjQ== dependencies: - "@algolia/autocomplete-shared" "1.17.7" + "@algolia/autocomplete-shared" "1.17.9" -"@algolia/autocomplete-shared@1.17.7": - version "1.17.7" - resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.17.7.tgz#105e84ad9d1a31d3fb86ba20dc890eefe1a313a0" - integrity sha512-o/1Vurr42U/qskRSuhBH+VKxMvkkUVTLU6WZQr+L5lGZZLYWyhdzWjW0iGXY7EkwRTjBqvN2EsR81yCTGV/kmg== - -"@algolia/cache-browser-local-storage@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.24.0.tgz#97bc6d067a9fd932b9c922faa6b7fd6e546e1348" - integrity sha512-t63W9BnoXVrGy9iYHBgObNXqYXM3tYXCjDSHeNwnsc324r4o5UiVKUiAB4THQ5z9U5hTj6qUvwg/Ez43ZD85ww== - dependencies: - "@algolia/cache-common" "4.24.0" - -"@algolia/cache-common@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/cache-common/-/cache-common-4.24.0.tgz#81a8d3a82ceb75302abb9b150a52eba9960c9744" - integrity sha512-emi+v+DmVLpMGhp0V9q9h5CdkURsNmFC+cOS6uK9ndeJm9J4TiqSvPYVu+THUP8P/S08rxf5x2P+p3CfID0Y4g== - -"@algolia/cache-in-memory@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/cache-in-memory/-/cache-in-memory-4.24.0.tgz#ffcf8872f3a10cb85c4f4641bdffd307933a6e44" - integrity sha512-gDrt2so19jW26jY3/MkFg5mEypFIPbPoXsQGQWAi6TrCPsNOSEYepBMPlucqWigsmEy/prp5ug2jy/N3PVG/8w== - dependencies: - "@algolia/cache-common" "4.24.0" +"@algolia/autocomplete-shared@1.17.9": + version "1.17.9" + resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.17.9.tgz#5f38868f7cb1d54b014b17a10fc4f7e79d427fa8" + integrity sha512-iDf05JDQ7I0b7JEA/9IektxN/80a2MZ1ToohfmNS3rfeuQnIKI3IJlIafD0xu4StbtQTghx9T3Maa97ytkXenQ== "@algolia/client-abtesting@5.18.0": version "5.18.0" @@ -58,24 +39,15 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" -"@algolia/client-account@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/client-account/-/client-account-4.24.0.tgz#eba7a921d828e7c8c40a32d4add21206c7fe12f1" - integrity sha512-adcvyJ3KjPZFDybxlqnf+5KgxJtBjwTPTeyG2aOyoJvx0Y8dUQAEOEVOJ/GBxX0WWNbmaSrhDURMhc+QeevDsA== - dependencies: - "@algolia/client-common" "4.24.0" - "@algolia/client-search" "4.24.0" - "@algolia/transporter" "4.24.0" - -"@algolia/client-analytics@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-4.24.0.tgz#9d2576c46a9093a14e668833c505ea697a1a3e30" - integrity sha512-y8jOZt1OjwWU4N2qr8G4AxXAzaa8DBvyHTWlHzX/7Me1LX8OayfgHexqrsL4vSBcoMmVw2XnVW9MhL+Y2ZDJXg== +"@algolia/client-abtesting@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.20.0.tgz#984472e4ae911285a8e3be2b81c121108f87a179" + integrity sha512-YaEoNc1Xf2Yk6oCfXXkZ4+dIPLulCx8Ivqj0OsdkHWnsI3aOJChY5qsfyHhDBNSOhqn2ilgHWxSfyZrjxBcAww== dependencies: - "@algolia/client-common" "4.24.0" - "@algolia/client-search" "4.24.0" - "@algolia/requester-common" "4.24.0" - "@algolia/transporter" "4.24.0" + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" "@algolia/client-analytics@5.18.0": version "5.18.0" @@ -87,19 +59,26 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" -"@algolia/client-common@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-4.24.0.tgz#77c46eee42b9444a1d1c1583a83f7df4398a649d" - integrity sha512-bc2ROsNL6w6rqpl5jj/UywlIYC21TwSSoFHKl01lYirGMW+9Eek6r02Tocg4gZ8HAw3iBvu6XQiM3BEbmEMoiA== +"@algolia/client-analytics@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.20.0.tgz#25944c8c7bcc06a16ae3b26ddf86d0d18f984349" + integrity sha512-CIT9ni0+5sYwqehw+t5cesjho3ugKQjPVy/iPiJvtJX4g8Cdb6je6SPt2uX72cf2ISiXCAX9U3cY0nN0efnRDw== dependencies: - "@algolia/requester-common" "4.24.0" - "@algolia/transporter" "4.24.0" + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" "@algolia/client-common@5.18.0": version "5.18.0" resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.18.0.tgz#8de3991b25ff3c9bbf5ef06c19f6a4a4fa64f328" integrity sha512-X1WMSC+1ve2qlMsemyTF5bIjwipOT+m99Ng1Tyl36ZjQKTa54oajBKE0BrmM8LD8jGdtukAgkUhFoYOaRbMcmQ== +"@algolia/client-common@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.20.0.tgz#0b6b96c779d30afada68cf36f20f0c280e3f1273" + integrity sha512-iSTFT3IU8KNpbAHcBUJw2HUrPnMXeXLyGajmCL7gIzWOsYM4GabZDHXOFx93WGiXMti1dymz8k8R+bfHv1YZmA== + "@algolia/client-insights@5.18.0": version "5.18.0" resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.18.0.tgz#2c6f158e57265fd0888f5b84fe7302d6d659c0ff" @@ -110,14 +89,15 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" -"@algolia/client-personalization@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-4.24.0.tgz#8b47789fb1cb0f8efbea0f79295b7c5a3850f6ae" - integrity sha512-l5FRFm/yngztweU0HdUzz1rC4yoWCFo3IF+dVIVTfEPg906eZg5BOd1k0K6rZx5JzyyoP4LdmOikfkfGsKVE9w== +"@algolia/client-insights@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/client-insights/-/client-insights-5.20.0.tgz#37b59043a86423dd283d05909faea06e4eff026b" + integrity sha512-w9RIojD45z1csvW1vZmAko82fqE/Dm+Ovsy2ElTsjFDB0HMAiLh2FO86hMHbEXDPz6GhHKgGNmBRiRP8dDPgJg== dependencies: - "@algolia/client-common" "4.24.0" - "@algolia/requester-common" "4.24.0" - "@algolia/transporter" "4.24.0" + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" "@algolia/client-personalization@5.18.0": version "5.18.0" @@ -129,6 +109,16 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" +"@algolia/client-personalization@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.20.0.tgz#d10da6d798f9a5f6cf239c57b9a850deb29e5683" + integrity sha512-p/hftHhrbiHaEcxubYOzqVV4gUqYWLpTwK+nl2xN3eTrSW9SNuFlAvUBFqPXSVBqc6J5XL9dNKn3y8OA1KElSQ== + dependencies: + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" + "@algolia/client-query-suggestions@5.18.0": version "5.18.0" resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.18.0.tgz#9911560aa2dd26984a6d3f9803f14aecc2f1d10e" @@ -139,14 +129,15 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" -"@algolia/client-search@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-4.24.0.tgz#75e6c02d33ef3e0f34afd9962c085b856fc4a55f" - integrity sha512-uRW6EpNapmLAD0mW47OXqTP8eiIx5F6qN9/x/7HHO6owL3N1IXqydGwW5nhDFBrV+ldouro2W1VX3XlcUXEFCA== +"@algolia/client-query-suggestions@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/client-query-suggestions/-/client-query-suggestions-5.20.0.tgz#1d4f1d638f857fad202cee7feecd3ffc270d9c60" + integrity sha512-m4aAuis5vZi7P4gTfiEs6YPrk/9hNTESj3gEmGFgfJw3hO2ubdS4jSId1URd6dGdt0ax2QuapXufcrN58hPUcw== dependencies: - "@algolia/client-common" "4.24.0" - "@algolia/requester-common" "4.24.0" - "@algolia/transporter" "4.24.0" + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" "@algolia/client-search@5.18.0": version "5.18.0" @@ -158,6 +149,16 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" +"@algolia/client-search@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.20.0.tgz#4b847bda4bef2eee8ba72ef3ce59be612319e8d0" + integrity sha512-KL1zWTzrlN4MSiaK1ea560iCA/UewMbS4ZsLQRPoDTWyrbDKVbztkPwwv764LAqgXk0fvkNZvJ3IelcK7DqhjQ== + dependencies: + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" + "@algolia/events@^4.0.1": version "4.0.1" resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950" @@ -173,17 +174,15 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" -"@algolia/logger-common@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/logger-common/-/logger-common-4.24.0.tgz#28d439976019ec0a46ba7a1a739ef493d4ef8123" - integrity sha512-LLUNjkahj9KtKYrQhFKCzMx0BY3RnNP4FEtO+sBybCjJ73E8jNdaKJ/Dd8A/VA4imVHP5tADZ8pn5B8Ga/wTMA== - -"@algolia/logger-console@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/logger-console/-/logger-console-4.24.0.tgz#c6ff486036cd90b81d07a95aaba04461da7e1c65" - integrity sha512-X4C8IoHgHfiUROfoRCV+lzSy+LHMgkoEEU1BbKcsfnV0i0S20zyy0NLww9dwVHUWNfPPxdMU+/wKmLGYf96yTg== +"@algolia/ingestion@1.20.0": + version "1.20.0" + resolved "https://registry.yarnpkg.com/@algolia/ingestion/-/ingestion-1.20.0.tgz#b91849fe4a8efed21c048a0a69ad77934d2fc3fd" + integrity sha512-shj2lTdzl9un4XJblrgqg54DoK6JeKFO8K8qInMu4XhE2JuB8De6PUuXAQwiRigZupbI0xq8aM0LKdc9+qiLQA== dependencies: - "@algolia/logger-common" "4.24.0" + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" "@algolia/monitoring@1.18.0": version "1.18.0" @@ -195,22 +194,15 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" -"@algolia/recommend@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-4.24.0.tgz#8a3f78aea471ee0a4836b78fd2aad4e9abcaaf34" - integrity sha512-P9kcgerfVBpfYHDfVZDvvdJv0lEoCvzNlOy2nykyt5bK8TyieYyiD0lguIJdRZZYGre03WIAFf14pgE+V+IBlw== - dependencies: - "@algolia/cache-browser-local-storage" "4.24.0" - "@algolia/cache-common" "4.24.0" - "@algolia/cache-in-memory" "4.24.0" - "@algolia/client-common" "4.24.0" - "@algolia/client-search" "4.24.0" - "@algolia/logger-common" "4.24.0" - "@algolia/logger-console" "4.24.0" - "@algolia/requester-browser-xhr" "4.24.0" - "@algolia/requester-common" "4.24.0" - "@algolia/requester-node-http" "4.24.0" - "@algolia/transporter" "4.24.0" +"@algolia/monitoring@1.20.0": + version "1.20.0" + resolved "https://registry.yarnpkg.com/@algolia/monitoring/-/monitoring-1.20.0.tgz#5b3a7964b08a91b1c71466bf5adb8a1597e3134b" + integrity sha512-aF9blPwOhKtWvkjyyXh9P5peqmhCA1XxLBRgItT+K6pbT0q4hBDQrCid+pQZJYy4HFUKjB/NDDwyzFhj/rwKhw== + dependencies: + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" "@algolia/recommend@5.18.0": version "5.18.0" @@ -222,12 +214,15 @@ "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" -"@algolia/requester-browser-xhr@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.24.0.tgz#313c5edab4ed73a052e75803855833b62dd19c16" - integrity sha512-Z2NxZMb6+nVXSjF13YpjYTdvV3032YTBSGm2vnYvYPA6mMxzM3v5rsCiSspndn9rzIW4Qp1lPHBvuoKJV6jnAA== +"@algolia/recommend@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.20.0.tgz#49f8f8d31f815b107c8ebd1c35220d90b22fd876" + integrity sha512-T6B/WPdZR3b89/F9Vvk6QCbt/wrLAtrGoL8z4qPXDFApQ8MuTFWbleN/4rHn6APWO3ps+BUePIEbue2rY5MlRw== dependencies: - "@algolia/requester-common" "4.24.0" + "@algolia/client-common" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" "@algolia/requester-browser-xhr@5.18.0": version "5.18.0" @@ -236,10 +231,12 @@ dependencies: "@algolia/client-common" "5.18.0" -"@algolia/requester-common@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-common/-/requester-common-4.24.0.tgz#1c60c198031f48fcdb9e34c4057a3ea987b9a436" - integrity sha512-k3CXJ2OVnvgE3HMwcojpvY6d9kgKMPRxs/kVohrwF5WMr2fnqojnycZkxPoEg+bXm8fi5BBfFmOqgYztRtHsQA== +"@algolia/requester-browser-xhr@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.20.0.tgz#998fd5c1123fbc49b664c484c6b0cd7cefc6a1fa" + integrity sha512-t6//lXsq8E85JMenHrI6mhViipUT5riNhEfCcvtRsTV+KIBpC6Od18eK864dmBhoc5MubM0f+sGpKOqJIlBSCg== + dependencies: + "@algolia/client-common" "5.20.0" "@algolia/requester-fetch@5.18.0": version "5.18.0" @@ -248,12 +245,12 @@ dependencies: "@algolia/client-common" "5.18.0" -"@algolia/requester-node-http@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-4.24.0.tgz#4461593714031d02aa7da221c49df675212f482f" - integrity sha512-JF18yTjNOVYvU/L3UosRcvbPMGT9B+/GQWNWnenIImglzNVGpyzChkXLnrSf6uxwVNO6ESGu6oN8MqcGQcjQJw== +"@algolia/requester-fetch@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-fetch/-/requester-fetch-5.20.0.tgz#fed4f135f22c246ce40cf23c9d6518884be43e5e" + integrity sha512-FHxYGqRY+6bgjKsK4aUsTAg6xMs2S21elPe4Y50GB0Y041ihvw41Vlwy2QS6K9ldoftX4JvXodbKTcmuQxywdQ== dependencies: - "@algolia/requester-common" "4.24.0" + "@algolia/client-common" "5.20.0" "@algolia/requester-node-http@5.18.0": version "5.18.0" @@ -262,14 +259,12 @@ dependencies: "@algolia/client-common" "5.18.0" -"@algolia/transporter@4.24.0": - version "4.24.0" - resolved "https://registry.yarnpkg.com/@algolia/transporter/-/transporter-4.24.0.tgz#226bb1f8af62430374c1972b2e5c8580ab275102" - integrity sha512-86nI7w6NzWxd1Zp9q3413dRshDqAzSbsQjhcDhPIatEFiZrL1/TjnHL8S7jVKFePlIMzDsZWXAXwXzcok9c5oA== +"@algolia/requester-node-http@5.20.0": + version "5.20.0" + resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.20.0.tgz#920a9488be07c0521951da92f36be61f47c4d0e0" + integrity sha512-kmtQClq/w3vtPteDSPvaW9SPZL/xrIgMrxZyAgsFwrJk0vJxqyC5/hwHmrCraDnStnGSADnLpBf4SpZnwnkwWw== dependencies: - "@algolia/cache-common" "4.24.0" - "@algolia/logger-common" "4.24.0" - "@algolia/requester-common" "4.24.0" + "@algolia/client-common" "5.20.0" "@ampproject/remapping@^2.2.0": version "2.3.0" @@ -1560,25 +1555,25 @@ resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70" integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw== -"@docsearch/css@3.8.2": - version "3.8.2" - resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.8.2.tgz#7973ceb6892c30f154ba254cd05c562257a44977" - integrity sha512-y05ayQFyUmCXze79+56v/4HpycYF3uFqB78pLPrSV5ZKAlDuIAAJNhaRi8tTdRNXh05yxX/TyNnzD6LwSM89vQ== +"@docsearch/css@3.8.3": + version "3.8.3" + resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.8.3.tgz#12f377cf8c14b687042273f920efdfdb794e9fcf" + integrity sha512-1nELpMV40JDLJ6rpVVFX48R1jsBFIQ6RnEQDsLFGmzOjPWTOMlZqUcXcvRx8VmYV/TqnS1l784Ofz+ZEb+wEOQ== -"@docsearch/react@^3.5.2": - version "3.8.2" - resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.8.2.tgz#7b11d39b61c976c0aa9fbde66e6b73b30f3acd42" - integrity sha512-xCRrJQlTt8N9GU0DG4ptwHRkfnSnD/YpdeaXe02iKfqs97TkZJv60yE+1eq/tjPcVnTW8dP5qLP7itifFVV5eg== +"@docsearch/react@^3.8.1": + version "3.8.3" + resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.8.3.tgz#72f6bcbbda6cd07f23398af641e483c27d16e00a" + integrity sha512-6UNrg88K7lJWmuS6zFPL/xgL+n326qXqZ7Ybyy4E8P/6Rcblk3GE8RXxeol4Pd5pFpKMhOhBhzABKKwHtbJCIg== dependencies: - "@algolia/autocomplete-core" "1.17.7" - "@algolia/autocomplete-preset-algolia" "1.17.7" - "@docsearch/css" "3.8.2" + "@algolia/autocomplete-core" "1.17.9" + "@algolia/autocomplete-preset-algolia" "1.17.9" + "@docsearch/css" "3.8.3" algoliasearch "^5.14.2" -"@docusaurus/babel@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.6.3.tgz#016714fe7a8807d0fc2f7180eace5e82bebbb8a6" - integrity sha512-7dW9Hat9EHYCVicFXYA4hjxBY38+hPuCURL8oRF9fySRm7vzNWuEOghA1TXcykuXZp0HLG2td4RhDxCvGG7tNw== +"@docusaurus/babel@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/babel/-/babel-3.7.0.tgz#770dd5da525a9d6a2fee7d3212ec62040327f776" + integrity sha512-0H5uoJLm14S/oKV3Keihxvh8RV+vrid+6Gv+2qhuzbqHanawga8tYnsdpjEyt36ucJjqlby2/Md2ObWjA02UXQ== dependencies: "@babel/core" "^7.25.9" "@babel/generator" "^7.25.9" @@ -1590,23 +1585,23 @@ "@babel/runtime" "^7.25.9" "@babel/runtime-corejs3" "^7.25.9" "@babel/traverse" "^7.25.9" - "@docusaurus/logger" "3.6.3" - "@docusaurus/utils" "3.6.3" + "@docusaurus/logger" "3.7.0" + "@docusaurus/utils" "3.7.0" babel-plugin-dynamic-import-node "^2.3.3" fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/bundler@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.6.3.tgz#f09c2e29613f988b874a4be2247708e121b7fc5c" - integrity sha512-47JLuc8D4wA+6VOvmMd5fUC9rFppBQpQOnxDYiVXffm/DeV/wmm3sbpNd5Y+O+G2+nevLTRnvCm/qyancv0Y3A== +"@docusaurus/bundler@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/bundler/-/bundler-3.7.0.tgz#d8e7867b3b2c43a1e320ed429f8dfe873c38506d" + integrity sha512-CUUT9VlSGukrCU5ctZucykvgCISivct+cby28wJwCC/fkQFgAHRp/GKv2tx38ZmXb7nacrKzFTcp++f9txUYGg== dependencies: "@babel/core" "^7.25.9" - "@docusaurus/babel" "3.6.3" - "@docusaurus/cssnano-preset" "3.6.3" - "@docusaurus/logger" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils" "3.6.3" + "@docusaurus/babel" "3.7.0" + "@docusaurus/cssnano-preset" "3.7.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" babel-loader "^9.2.1" clean-css "^5.3.2" copy-webpack-plugin "^11.0.0" @@ -1627,18 +1622,18 @@ webpack "^5.95.0" webpackbar "^6.0.1" -"@docusaurus/core@3.6.3", "@docusaurus/core@^3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.6.3.tgz#6bf968ee26a36d71387bab293f27ccffc0e428b6" - integrity sha512-xL7FRY9Jr5DWqB6pEnqgKqcMPJOX5V0pgWXi5lCiih11sUBmcFKM7c3+GyxcVeeWFxyYSDP3grLTWqJoP4P9Vw== - dependencies: - "@docusaurus/babel" "3.6.3" - "@docusaurus/bundler" "3.6.3" - "@docusaurus/logger" "3.6.3" - "@docusaurus/mdx-loader" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-common" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" +"@docusaurus/core@3.7.0", "@docusaurus/core@^3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-3.7.0.tgz#e871586d099093723dfe6de81c1ce610aeb20292" + integrity sha512-b0fUmaL+JbzDIQaamzpAFpTviiaU4cX3Qz8cuo14+HGBCwa0evEK0UYCBFY3n4cLzL8Op1BueeroUD2LYAIHbQ== + dependencies: + "@docusaurus/babel" "3.7.0" + "@docusaurus/bundler" "3.7.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/mdx-loader" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-common" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" boxen "^6.2.1" chalk "^4.1.2" chokidar "^3.5.3" @@ -1659,13 +1654,12 @@ p-map "^4.0.0" prompts "^2.4.2" react-dev-utils "^12.0.1" - react-helmet-async "^1.3.0" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" react-loadable "npm:@docusaurus/react-loadable@6.0.0" react-loadable-ssr-addon-v5-slorber "^1.0.1" react-router "^5.3.4" react-router-config "^5.1.1" react-router-dom "^5.3.4" - rtl-detect "^1.0.4" semver "^7.5.4" serve-handler "^6.1.6" shelljs "^0.8.5" @@ -1676,32 +1670,32 @@ webpack-dev-server "^4.15.2" webpack-merge "^6.0.1" -"@docusaurus/cssnano-preset@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.6.3.tgz#ea19b307183ec20dea4927efc4ddf249150b8c6a" - integrity sha512-qP7SXrwZ+23GFJdPN4aIHQrZW+oH/7tzwEuc/RNL0+BdZdmIjYQqUxdXsjE4lFxLNZjj0eUrSNYIS6xwfij+5Q== +"@docusaurus/cssnano-preset@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/cssnano-preset/-/cssnano-preset-3.7.0.tgz#8fe8f2c3acbd32384b69e14983b9a63c98cae34e" + integrity sha512-X9GYgruZBSOozg4w4dzv9uOz8oK/EpPVQXkp0MM6Tsgp/nRIU9hJzJ0Pxg1aRa3xCeEQTOimZHcocQFlLwYajQ== dependencies: cssnano-preset-advanced "^6.1.2" postcss "^8.4.38" postcss-sort-media-queries "^5.2.0" tslib "^2.6.0" -"@docusaurus/logger@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.6.3.tgz#c6e514c9429487ef38be2f2129b2b842740d92fd" - integrity sha512-xSubJixcNyMV9wMV4q0s47CBz3Rlc5jbcCCuij8pfQP8qn/DIpt0ks8W6hQWzHAedg/J/EwxxUOUrnEoKzJo8g== +"@docusaurus/logger@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/logger/-/logger-3.7.0.tgz#07ecc2f460c4d2382df4991f9ce4e348e90af04c" + integrity sha512-z7g62X7bYxCYmeNNuO9jmzxLQG95q9QxINCwpboVcNff3SJiHJbGrarxxOVMVmAh1MsrSfxWkVGv4P41ktnFsA== dependencies: chalk "^4.1.2" tslib "^2.6.0" -"@docusaurus/mdx-loader@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.6.3.tgz#127babc7cdb26d37c723bc3ae518bda17ce40160" - integrity sha512-3iJdiDz9540ppBseeI93tWTDtUGVkxzh59nMq4ignylxMuXBLK8dFqVeaEor23v1vx6TrGKZ2FuLaTB+U7C0QQ== +"@docusaurus/mdx-loader@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/mdx-loader/-/mdx-loader-3.7.0.tgz#5890c6e7a5b68cb1d066264ac5290cdcd59d4ecc" + integrity sha512-OFBG6oMjZzc78/U3WNPSHs2W9ZJ723ewAcvVJaqS0VgyeUfmzUV8f1sv+iUHA0DtwiR5T5FjOxj6nzEE8LY6VA== dependencies: - "@docusaurus/logger" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" + "@docusaurus/logger" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" "@mdx-js/mdx" "^3.0.0" "@slorber/remark-comment" "^1.0.0" escape-html "^1.0.3" @@ -1724,32 +1718,32 @@ vfile "^6.0.1" webpack "^5.88.1" -"@docusaurus/module-type-aliases@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.6.3.tgz#1f7030b1cf1f658cf664d41b6eadba93bbe51d87" - integrity sha512-MjaXX9PN/k5ugNvfRZdWyKWq4FsrhN4LEXaj0pEmMebJuBNlFeGyKQUa9DRhJHpadNaiMLrbo9m3U7Ig5YlsZg== +"@docusaurus/module-type-aliases@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/module-type-aliases/-/module-type-aliases-3.7.0.tgz#15c0745b829c6966c5b3b2c2527c72b54830b0e5" + integrity sha512-g7WdPqDNaqA60CmBrr0cORTrsOit77hbsTj7xE2l71YhBn79sxdm7WMK7wfhcaafkbpIh7jv5ef5TOpf1Xv9Lg== dependencies: - "@docusaurus/types" "3.6.3" + "@docusaurus/types" "3.7.0" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" "@types/react-router-dom" "*" - react-helmet-async "*" + react-helmet-async "npm:@slorber/react-helmet-async@*" react-loadable "npm:@docusaurus/react-loadable@6.0.0" -"@docusaurus/plugin-content-blog@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.6.3.tgz#d6a597e4bfdeb3f1f6ce06d2ac86207296988cc9" - integrity sha512-k0ogWwwJU3pFRFfvW1kRVHxzf2DutLGaaLjAnHVEU6ju+aRP0Z5ap/13DHyPOfHeE4WKpn/M0TqjdwZAcY3kAw== - dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/logger" "3.6.3" - "@docusaurus/mdx-loader" "3.6.3" - "@docusaurus/theme-common" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-common" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" +"@docusaurus/plugin-content-blog@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.7.0.tgz#7bd69de87a1f3adb652e1473ef5b7ccc9468f47e" + integrity sha512-EFLgEz6tGHYWdPU0rK8tSscZwx+AsyuBW/r+tNig2kbccHYGUJmZtYN38GjAa3Fda4NU+6wqUO5kTXQSRBQD3g== + dependencies: + "@docusaurus/core" "3.7.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/mdx-loader" "3.7.0" + "@docusaurus/theme-common" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-common" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" cheerio "1.0.0-rc.12" feed "^4.2.2" fs-extra "^11.1.1" @@ -1761,20 +1755,20 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-docs@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.6.3.tgz#aae044d2af6996d1a6de8d815aca8a83b485e0a5" - integrity sha512-r2wS8y/fsaDcxkm20W5bbYJFPzdWdEaTWVYjNxlHlcmX086eqQR1Fomlg9BHTJ0dLXPzAlbC8EN4XqMr3QzNCQ== - dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/logger" "3.6.3" - "@docusaurus/mdx-loader" "3.6.3" - "@docusaurus/module-type-aliases" "3.6.3" - "@docusaurus/theme-common" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-common" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" +"@docusaurus/plugin-content-docs@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.7.0.tgz#297a549e926ee2b1147b5242af6f21532c7b107c" + integrity sha512-GXg5V7kC9FZE4FkUZA8oo/NrlRb06UwuICzI6tcbzj0+TVgjq/mpUXXzSgKzMS82YByi4dY2Q808njcBCyy6tQ== + dependencies: + "@docusaurus/core" "3.7.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/mdx-loader" "3.7.0" + "@docusaurus/module-type-aliases" "3.7.0" + "@docusaurus/theme-common" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-common" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" "@types/react-router-config" "^5.0.7" combine-promises "^1.1.0" fs-extra "^11.1.1" @@ -1784,115 +1778,130 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@docusaurus/plugin-content-pages@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.6.3.tgz#0a5a43d1677ee519f63a54634653c54ddf41f475" - integrity sha512-eHrmTgjgLZsuqfsYr5X2xEwyIcck0wseSofWrjTwT9FLOWp+KDmMAuVK+wRo7sFImWXZk3oV/xX/g9aZrhD7OA== +"@docusaurus/plugin-content-pages@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.7.0.tgz#c4a8f7237872236aacb77665822c474c0a00e91a" + integrity sha512-YJSU3tjIJf032/Aeao8SZjFOrXJbz/FACMveSMjLyMH4itQyZ2XgUIzt4y+1ISvvk5zrW4DABVT2awTCqBkx0Q== dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/mdx-loader" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" + "@docusaurus/core" "3.7.0" + "@docusaurus/mdx-loader" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" fs-extra "^11.1.1" tslib "^2.6.0" webpack "^5.88.1" -"@docusaurus/plugin-debug@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.6.3.tgz#4e62ddfbae4d597b073f8e3c632cc12d012339e3" - integrity sha512-zB9GXfIZNPRfzKnNjU6xGVrqn9bPXuGhpjgsuc/YtcTDjnjhasg38NdYd5LEqXex5G/zIorQgWB3n6x/Ut62vQ== +"@docusaurus/plugin-debug@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-debug/-/plugin-debug-3.7.0.tgz#a4fd45132e40cffe96bb51f48e89982a1cb8e194" + integrity sha512-Qgg+IjG/z4svtbCNyTocjIwvNTNEwgRjSXXSJkKVG0oWoH0eX/HAPiu+TS1HBwRPQV+tTYPWLrUypYFepfujZA== dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils" "3.6.3" + "@docusaurus/core" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" fs-extra "^11.1.1" react-json-view-lite "^1.2.0" tslib "^2.6.0" -"@docusaurus/plugin-google-analytics@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.6.3.tgz#63648d469b1e3c50fad8878e7a7db9856e503d5f" - integrity sha512-rCDNy1QW8Dag7nZq67pcum0bpFLrwvxJhYuVprhFh8BMBDxV0bY+bAkGHbSf68P3Bk9C3hNOAXX1srGLIDvcTA== +"@docusaurus/plugin-google-analytics@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.7.0.tgz#d20f665e810fb2295d1c1bbfe13398c5ff42eb24" + integrity sha512-otIqiRV/jka6Snjf+AqB360XCeSv7lQC+DKYW+EUZf6XbuE8utz5PeUQ8VuOcD8Bk5zvT1MC4JKcd5zPfDuMWA== dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" + "@docusaurus/core" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" tslib "^2.6.0" -"@docusaurus/plugin-google-gtag@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.6.3.tgz#8a1388b4123904be17e661ea7aa71d798d0c046e" - integrity sha512-+OyDvhM6rqVkQOmLVkQWVJAizEEfkPzVWtIHXlWPOCFGK9X4/AWeBSrU0WG4iMg9Z4zD4YDRrU+lvI4s6DSC+w== +"@docusaurus/plugin-google-gtag@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.7.0.tgz#a48638dfd132858060458b875a440b6cbda6bf8f" + integrity sha512-M3vrMct1tY65ModbyeDaMoA+fNJTSPe5qmchhAbtqhDD/iALri0g9LrEpIOwNaoLmm6lO88sfBUADQrSRSGSWA== dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" + "@docusaurus/core" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" "@types/gtag.js" "^0.0.12" tslib "^2.6.0" -"@docusaurus/plugin-google-tag-manager@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.6.3.tgz#38cbe416803f29782807cebf3ebf240cb47c3c74" - integrity sha512-1M6UPB13gWUtN2UHX083/beTn85PlRI9ABItTl/JL1FJ5dJTWWFXXsHf9WW/6hrVwthwTeV/AGbGKvLKV+IlCA== +"@docusaurus/plugin-google-tag-manager@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.7.0.tgz#0a4390f4b0e760d073bdb1905436bfa7bd71356b" + integrity sha512-X8U78nb8eiMiPNg3jb9zDIVuuo/rE1LjGDGu+5m5CX4UBZzjMy+klOY2fNya6x8ACyE/L3K2erO1ErheP55W/w== dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" + "@docusaurus/core" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" tslib "^2.6.0" -"@docusaurus/plugin-sitemap@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.6.3.tgz#0458e6f7476ab6fd1466e01b153a3211d3223c53" - integrity sha512-94qOO4M9Fwv9KfVQJsgbe91k+fPJ4byf1L3Ez8TUa6TAFPo/BrLwQ80zclHkENlL1824TuxkcMKv33u6eydQCg== - dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/logger" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-common" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" +"@docusaurus/plugin-sitemap@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.7.0.tgz#2c1bf9de26aeda455df6f77748e5887ace39b2d7" + integrity sha512-bTRT9YLZ/8I/wYWKMQke18+PF9MV8Qub34Sku6aw/vlZ/U+kuEuRpQ8bTcNOjaTSfYsWkK4tTwDMHK2p5S86cA== + dependencies: + "@docusaurus/core" "3.7.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-common" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" fs-extra "^11.1.1" sitemap "^7.1.1" tslib "^2.6.0" -"@docusaurus/preset-classic@^3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.6.3.tgz#072298b5b6d0de7d0346b1e9b550a30ef2add56d" - integrity sha512-VHSYWROT3flvNNI1SrnMOtW1EsjeHNK9dhU6s9eY5hryZe79lUqnZJyze/ymDe2LXAqzyj6y5oYvyBoZZk6ErA== - dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/plugin-content-blog" "3.6.3" - "@docusaurus/plugin-content-docs" "3.6.3" - "@docusaurus/plugin-content-pages" "3.6.3" - "@docusaurus/plugin-debug" "3.6.3" - "@docusaurus/plugin-google-analytics" "3.6.3" - "@docusaurus/plugin-google-gtag" "3.6.3" - "@docusaurus/plugin-google-tag-manager" "3.6.3" - "@docusaurus/plugin-sitemap" "3.6.3" - "@docusaurus/theme-classic" "3.6.3" - "@docusaurus/theme-common" "3.6.3" - "@docusaurus/theme-search-algolia" "3.6.3" - "@docusaurus/types" "3.6.3" - -"@docusaurus/theme-classic@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.6.3.tgz#00599a9de5fd5c122fd1b8c59d3b755878f2a72c" - integrity sha512-1RRLK1tSArI2c00qugWYO3jRocjOZwGF1mBzPPylDVRwWCS/rnWWR91ChdbbaxIupRJ+hX8ZBYrwr5bbU0oztQ== - dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/logger" "3.6.3" - "@docusaurus/mdx-loader" "3.6.3" - "@docusaurus/module-type-aliases" "3.6.3" - "@docusaurus/plugin-content-blog" "3.6.3" - "@docusaurus/plugin-content-docs" "3.6.3" - "@docusaurus/plugin-content-pages" "3.6.3" - "@docusaurus/theme-common" "3.6.3" - "@docusaurus/theme-translations" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-common" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" +"@docusaurus/plugin-svgr@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/plugin-svgr/-/plugin-svgr-3.7.0.tgz#018e89efd615d5fde77b891a8c2aadf203013f5d" + integrity sha512-HByXIZTbc4GV5VAUkZ2DXtXv1Qdlnpk3IpuImwSnEzCDBkUMYcec5282hPjn6skZqB25M1TYCmWS91UbhBGxQg== + dependencies: + "@docusaurus/core" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" + "@svgr/core" "8.1.0" + "@svgr/webpack" "^8.1.0" + tslib "^2.6.0" + webpack "^5.88.1" + +"@docusaurus/preset-classic@^3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/preset-classic/-/preset-classic-3.7.0.tgz#f6656a04ae6a4877523dbd04f7c491632e4003b9" + integrity sha512-nPHj8AxDLAaQXs+O6+BwILFuhiWbjfQWrdw2tifOClQoNfuXDjfjogee6zfx6NGHWqshR23LrcN115DmkHC91Q== + dependencies: + "@docusaurus/core" "3.7.0" + "@docusaurus/plugin-content-blog" "3.7.0" + "@docusaurus/plugin-content-docs" "3.7.0" + "@docusaurus/plugin-content-pages" "3.7.0" + "@docusaurus/plugin-debug" "3.7.0" + "@docusaurus/plugin-google-analytics" "3.7.0" + "@docusaurus/plugin-google-gtag" "3.7.0" + "@docusaurus/plugin-google-tag-manager" "3.7.0" + "@docusaurus/plugin-sitemap" "3.7.0" + "@docusaurus/plugin-svgr" "3.7.0" + "@docusaurus/theme-classic" "3.7.0" + "@docusaurus/theme-common" "3.7.0" + "@docusaurus/theme-search-algolia" "3.7.0" + "@docusaurus/types" "3.7.0" + +"@docusaurus/theme-classic@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-3.7.0.tgz#b483bd8e2923b6994b5f47238884b9f8984222c5" + integrity sha512-MnLxG39WcvLCl4eUzHr0gNcpHQfWoGqzADCly54aqCofQX6UozOS9Th4RK3ARbM9m7zIRv3qbhggI53dQtx/hQ== + dependencies: + "@docusaurus/core" "3.7.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/mdx-loader" "3.7.0" + "@docusaurus/module-type-aliases" "3.7.0" + "@docusaurus/plugin-content-blog" "3.7.0" + "@docusaurus/plugin-content-docs" "3.7.0" + "@docusaurus/plugin-content-pages" "3.7.0" + "@docusaurus/theme-common" "3.7.0" + "@docusaurus/theme-translations" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-common" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" "@mdx-js/react" "^3.0.0" clsx "^2.0.0" copy-text-to-clipboard "^3.2.0" @@ -1907,15 +1916,15 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-common@3.6.3", "@docusaurus/theme-common@^3.6.0": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.6.3.tgz#a8a6ebd2b0fd7a5cca4d0c6a2f9ccff905fa7438" - integrity sha512-b8ZkhczXHDxWWyvz+YJy4t/PlPbEogTTbgnHoflYnH7rmRtyoodTsu8WVM12la5LmlMJBclBXFl29OH8kPE7gg== +"@docusaurus/theme-common@3.7.0", "@docusaurus/theme-common@^3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-common/-/theme-common-3.7.0.tgz#18bf5c6b149a701f4bd865715ee8b595aa40b354" + integrity sha512-8eJ5X0y+gWDsURZnBfH0WabdNm8XMCXHv8ENy/3Z/oQKwaB/EHt5lP9VsTDTf36lKEp0V6DjzjFyFIB+CetL0A== dependencies: - "@docusaurus/mdx-loader" "3.6.3" - "@docusaurus/module-type-aliases" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-common" "3.6.3" + "@docusaurus/mdx-loader" "3.7.0" + "@docusaurus/module-type-aliases" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-common" "3.7.0" "@types/history" "^4.7.11" "@types/react" "*" "@types/react-router-config" "*" @@ -1925,34 +1934,34 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-mermaid@^3.6.0": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-mermaid/-/theme-mermaid-3.6.3.tgz#4bb0b4940b39cc855626a23190aa45928aa168b4" - integrity sha512-kIqpjNCP/9R2GGf8UmiDxD3CkOAEJuJIEFlaKMgQtjVxa/vH+9PLI1+DFbArGoG4+0ENTYUq8phHPW7SeL36uQ== +"@docusaurus/theme-mermaid@^3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-mermaid/-/theme-mermaid-3.7.0.tgz#1bc4307e09886186ed6e51607bf43c5089f35de5" + integrity sha512-7kNDvL7hm+tshjxSxIqYMtsLUPsEBYnkevej/ext6ru9xyLgCed+zkvTfGzTWNeq8rJIEe2YSS8/OV5gCVaPCw== dependencies: - "@docusaurus/core" "3.6.3" - "@docusaurus/module-type-aliases" "3.6.3" - "@docusaurus/theme-common" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" + "@docusaurus/core" "3.7.0" + "@docusaurus/module-type-aliases" "3.7.0" + "@docusaurus/theme-common" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" mermaid ">=10.4" tslib "^2.6.0" -"@docusaurus/theme-search-algolia@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.6.3.tgz#1a3331a489f392f5b032c4efc5f431e57eddf7ce" - integrity sha512-rt+MGCCpYgPyWCGXtbxlwFbTSobu15jWBTPI2LHsHNa5B0zSmOISX6FWYAPt5X1rNDOqMGM0FATnh7TBHRohVA== - dependencies: - "@docsearch/react" "^3.5.2" - "@docusaurus/core" "3.6.3" - "@docusaurus/logger" "3.6.3" - "@docusaurus/plugin-content-docs" "3.6.3" - "@docusaurus/theme-common" "3.6.3" - "@docusaurus/theme-translations" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-validation" "3.6.3" - algoliasearch "^4.18.0" - algoliasearch-helper "^3.13.3" +"@docusaurus/theme-search-algolia@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.7.0.tgz#2108ddf0b300b82de7c2b9ff9fcf62121b66ea37" + integrity sha512-Al/j5OdzwRU1m3falm+sYy9AaB93S1XF1Lgk9Yc6amp80dNxJVplQdQTR4cYdzkGtuQqbzUA8+kaoYYO0RbK6g== + dependencies: + "@docsearch/react" "^3.8.1" + "@docusaurus/core" "3.7.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/plugin-content-docs" "3.7.0" + "@docusaurus/theme-common" "3.7.0" + "@docusaurus/theme-translations" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-validation" "3.7.0" + algoliasearch "^5.17.1" + algoliasearch-helper "^3.22.6" clsx "^2.0.0" eta "^2.2.0" fs-extra "^11.1.1" @@ -1960,60 +1969,59 @@ tslib "^2.6.0" utility-types "^3.10.0" -"@docusaurus/theme-translations@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.6.3.tgz#6e473835ea016ce4acd7d2997f411811db8c4f6b" - integrity sha512-Gb0regclToVlngSIIwUCtBMQBq48qVUaN1XQNKW4XwlsgUyk0vP01LULdqbem7czSwIeBAFXFoORJ0RPX7ht/w== +"@docusaurus/theme-translations@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/theme-translations/-/theme-translations-3.7.0.tgz#0891aedc7c7040afcb3a1b34051d3a69096d0d25" + integrity sha512-Ewq3bEraWDmienM6eaNK7fx+/lHMtGDHQyd1O+4+3EsDxxUmrzPkV7Ct3nBWTuE0MsoZr3yNwQVKjllzCMuU3g== dependencies: fs-extra "^11.1.1" tslib "^2.6.0" -"@docusaurus/types@3.6.3", "@docusaurus/types@^3.4.0": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.6.3.tgz#e87592e31616da1b8dc473e4c8205c61885a1518" - integrity sha512-xD9oTGDrouWzefkhe9ogB2fDV96/82cRpNGx2HIvI5L87JHNhQVIWimQ/3JIiiX/TEd5S9s+VO6FFguwKNRVow== +"@docusaurus/types@3.7.0", "@docusaurus/types@^3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.7.0.tgz#3f5a68a60f80ecdcb085666da1d68f019afda943" + integrity sha512-kOmZg5RRqJfH31m+6ZpnwVbkqMJrPOG5t0IOl4i/+3ruXyNfWzZ0lVtVrD0u4ONc/0NOsS9sWYaxxWNkH1LdLQ== dependencies: "@mdx-js/mdx" "^3.0.0" "@types/history" "^4.7.11" "@types/react" "*" commander "^5.1.0" joi "^17.9.2" - react-helmet-async "^1.3.0" + react-helmet-async "npm:@slorber/react-helmet-async@1.3.0" utility-types "^3.10.0" webpack "^5.95.0" webpack-merge "^5.9.0" -"@docusaurus/utils-common@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.6.3.tgz#57f840bd6f0928cf10060198cb421f1b9212c8f5" - integrity sha512-v4nKDaANLgT3pMBewHYEMAl/ufY0LkXao1QkFWzI5huWFOmNQ2UFzv2BiKeHX5Ownis0/w6cAyoxPhVdDonlSQ== +"@docusaurus/utils-common@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-3.7.0.tgz#1bef52837d321db5dd2361fc07f3416193b5d029" + integrity sha512-IZeyIfCfXy0Mevj6bWNg7DG7B8G+S6o6JVpddikZtWyxJguiQ7JYr0SIZ0qWd8pGNuMyVwriWmbWqMnK7Y5PwA== dependencies: - "@docusaurus/types" "3.6.3" + "@docusaurus/types" "3.7.0" tslib "^2.6.0" -"@docusaurus/utils-validation@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.6.3.tgz#3eca7125235eb90983ff660b97a71f331e331f57" - integrity sha512-bhEGGiN5BE38h21vjqD70Gxg++j+PfYVddDUE5UFvLDup68QOcpD33CLr+2knPorlxRbEaNfz6HQDUMQ3HuqKw== +"@docusaurus/utils-validation@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/utils-validation/-/utils-validation-3.7.0.tgz#dc0786fb633ae5cef8e93337bf21c2a826c7ecbd" + integrity sha512-w8eiKk8mRdN+bNfeZqC4nyFoxNyI1/VExMKAzD9tqpJfLLbsa46Wfn5wcKH761g9WkKh36RtFV49iL9lh1DYBA== dependencies: - "@docusaurus/logger" "3.6.3" - "@docusaurus/utils" "3.6.3" - "@docusaurus/utils-common" "3.6.3" + "@docusaurus/logger" "3.7.0" + "@docusaurus/utils" "3.7.0" + "@docusaurus/utils-common" "3.7.0" fs-extra "^11.2.0" joi "^17.9.2" js-yaml "^4.1.0" lodash "^4.17.21" tslib "^2.6.0" -"@docusaurus/utils@3.6.3": - version "3.6.3" - resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.6.3.tgz#8dcb1969e4011a84dfb0a031da806dadddebf0ea" - integrity sha512-0R/FR3bKVl4yl8QwbL4TYFfR+OXBRpVUaTJdENapBGR3YMwfM6/JnhGilWQO8AOwPJGtGoDK7ib8+8UF9f3OZQ== +"@docusaurus/utils@3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.7.0.tgz#dfdebd63524c52b498f36b2907a3b2261930b9bb" + integrity sha512-e7zcB6TPnVzyUaHMJyLSArKa2AG3h9+4CfvKXKKWNx6hRs+p0a+u7HHTJBgo6KW2m+vqDnuIHK4X+bhmoghAFA== dependencies: - "@docusaurus/logger" "3.6.3" - "@docusaurus/types" "3.6.3" - "@docusaurus/utils-common" "3.6.3" - "@svgr/webpack" "^8.1.0" + "@docusaurus/logger" "3.7.0" + "@docusaurus/types" "3.7.0" + "@docusaurus/utils-common" "3.7.0" escape-string-regexp "^4.0.0" file-loader "^6.2.0" fs-extra "^11.1.1" @@ -3528,34 +3536,13 @@ ajv@^8.0.0, ajv@^8.9.0: json-schema-traverse "^1.0.0" require-from-string "^2.0.2" -algoliasearch-helper@^3.13.3: - version "3.22.6" - resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.22.6.tgz#6a31c67d277a32f3f7ae1b8a6e57ca73f1e1a0b0" - integrity sha512-F2gSb43QHyvZmvH/2hxIjbk/uFdO2MguQYTFP7J+RowMW1csjIODMobEnpLI8nbLQuzZnGZdIxl5Bpy1k9+CFQ== +algoliasearch-helper@^3.22.6: + version "3.23.1" + resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.23.1.tgz#1780ca624b5787dae3c62110d222750875c260ee" + integrity sha512-j/dF2ZELJBm4SJTK5ECsMuCDJpBB8ITiWKRjd3S15bK2bqrXKLWqDiA5A96WhVvCpZ2NmgNlUYmFbKOfcqivbg== dependencies: "@algolia/events" "^4.0.1" -algoliasearch@^4.18.0: - version "4.24.0" - resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.24.0.tgz#b953b3e2309ef8f25da9de311b95b994ac918275" - integrity sha512-bf0QV/9jVejssFBmz2HQLxUadxk574t4iwjCKp5E7NBzwKkrDEhKPISIIjAU/p6K5qDx3qoeh4+26zWN1jmw3g== - dependencies: - "@algolia/cache-browser-local-storage" "4.24.0" - "@algolia/cache-common" "4.24.0" - "@algolia/cache-in-memory" "4.24.0" - "@algolia/client-account" "4.24.0" - "@algolia/client-analytics" "4.24.0" - "@algolia/client-common" "4.24.0" - "@algolia/client-personalization" "4.24.0" - "@algolia/client-search" "4.24.0" - "@algolia/logger-common" "4.24.0" - "@algolia/logger-console" "4.24.0" - "@algolia/recommend" "4.24.0" - "@algolia/requester-browser-xhr" "4.24.0" - "@algolia/requester-common" "4.24.0" - "@algolia/requester-node-http" "4.24.0" - "@algolia/transporter" "4.24.0" - algoliasearch@^5.14.2: version "5.18.0" resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.18.0.tgz#2023232151f2ee9a580ea84d4a36676871979ce4" @@ -3575,6 +3562,25 @@ algoliasearch@^5.14.2: "@algolia/requester-fetch" "5.18.0" "@algolia/requester-node-http" "5.18.0" +algoliasearch@^5.17.1: + version "5.20.0" + resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.20.0.tgz#15f4eb6428f258d083d1cbc47d04a8d66eecba5f" + integrity sha512-groO71Fvi5SWpxjI9Ia+chy0QBwT61mg6yxJV27f5YFf+Mw+STT75K6SHySpP8Co5LsCrtsbCH5dJZSRtkSKaQ== + dependencies: + "@algolia/client-abtesting" "5.20.0" + "@algolia/client-analytics" "5.20.0" + "@algolia/client-common" "5.20.0" + "@algolia/client-insights" "5.20.0" + "@algolia/client-personalization" "5.20.0" + "@algolia/client-query-suggestions" "5.20.0" + "@algolia/client-search" "5.20.0" + "@algolia/ingestion" "1.20.0" + "@algolia/monitoring" "1.20.0" + "@algolia/recommend" "5.20.0" + "@algolia/requester-browser-xhr" "5.20.0" + "@algolia/requester-fetch" "5.20.0" + "@algolia/requester-node-http" "5.20.0" + ansi-align@^3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/ansi-align/-/ansi-align-3.0.1.tgz#0cdf12e111ace773a86e9a1fad1225c43cb19a59" @@ -9944,24 +9950,15 @@ react-error-overlay@^6.0.11: resolved "https://registry.yarnpkg.com/react-error-overlay/-/react-error-overlay-6.0.11.tgz#92835de5841c5cf08ba00ddd2d677b6d17ff9adb" integrity sha512-/6UZ2qgEyH2aqzYZgQPxEnz33NJ2gNsnHA2o5+o4wW9bLM/JYQitNP9xPhsXwC08hMMovfGe/8retsdDsczPRg== -react-fast-compare@^3.2.0, react-fast-compare@^3.2.2: +react-fast-compare@^3.2.0: version "3.2.2" resolved "https://registry.yarnpkg.com/react-fast-compare/-/react-fast-compare-3.2.2.tgz#929a97a532304ce9fee4bcae44234f1ce2c21d49" integrity sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ== -react-helmet-async@*: - version "2.0.5" - resolved "https://registry.yarnpkg.com/react-helmet-async/-/react-helmet-async-2.0.5.tgz#cfc70cd7bb32df7883a8ed55502a1513747223ec" - integrity sha512-rYUYHeus+i27MvFE+Jaa4WsyBKGkL6qVgbJvSBoX8mbsWoABJXdEO0bZyi0F6i+4f0NuIb8AvqPMj3iXFHkMwg== - dependencies: - invariant "^2.2.4" - react-fast-compare "^3.2.2" - shallowequal "^1.1.0" - -react-helmet-async@^1.3.0: +"react-helmet-async@npm:@slorber/react-helmet-async@*", "react-helmet-async@npm:@slorber/react-helmet-async@1.3.0": version "1.3.0" - resolved "https://registry.yarnpkg.com/react-helmet-async/-/react-helmet-async-1.3.0.tgz#7bd5bf8c5c69ea9f02f6083f14ce33ef545c222e" - integrity sha512-9jZ57/dAn9t3q6hneQS0wukqC2ENOBgMNVEhb/ZG9ZSxUetzVIw4iAmEU38IaVg3QGYauQPhSeUTuIUtFglWpg== + resolved "https://registry.yarnpkg.com/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz#11fbc6094605cf60aa04a28c17e0aab894b4ecff" + integrity sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A== dependencies: "@babel/runtime" "^7.12.5" invariant "^2.2.4" @@ -10479,11 +10476,6 @@ roughjs@^4.6.6: points-on-curve "^0.2.0" points-on-path "^0.2.1" -rtl-detect@^1.0.4: - version "1.1.2" - resolved "https://registry.yarnpkg.com/rtl-detect/-/rtl-detect-1.1.2.tgz#ca7f0330af5c6bb626c15675c642ba85ad6273c6" - integrity sha512-PGMBq03+TTG/p/cRB7HCLKJ1MgDIi07+QU1faSjiYRfmY5UsAttV9Hs08jDAHVwcOwmVLcSJkpwyfXszVjWfIQ== - rtlcss@^4.1.0: version "4.3.0" resolved "https://registry.yarnpkg.com/rtlcss/-/rtlcss-4.3.0.tgz#f8efd4d5b64f640ec4af8fa25b65bacd9e07cc97" From eb785960556221effd99b288810aeab373cf7a13 Mon Sep 17 00:00:00 2001 From: Svetlana Rekuts Date: Wed, 26 Mar 2025 23:04:13 +0000 Subject: [PATCH 2/6] Add Terraform configuration for Routes Settings --- content/docs/reference/cookies.mdx | 2 +- ...google-cloud-serverless-authentication.mdx | 13 ++++ content/docs/reference/routes/from.mdx | 18 ++++++ content/docs/reference/routes/headers.mdx | 16 +++++ .../identity-provider-client-id-per-route.mdx | 18 ++++++ ...ntity-provider-client-secret-per-route.mdx | 18 ++++++ .../reference/routes/jwt-issuer-format.mdx | 12 ++++ .../kubernetes-service-account-token.mdx | 16 +++++ .../routes/load-balancing-policy-config.mdx | 8 +++ .../docs/reference/routes/load-balancing.mdx | 19 ++++++ .../routes/pass-identity-headers.mdx | 16 +++++ .../docs/reference/routes/path-matching.mdx | 51 ++++++++++++++++ .../docs/reference/routes/path-rewriting.mdx | 35 +++++++++++ content/docs/reference/routes/policy.mdx | 19 ++++++ .../reference/routes/regex-priority-order.mdx | 14 +++++ .../reference/routes/show-error-details.mdx | 29 +++++++-- content/docs/reference/routes/timeouts.mdx | 60 +++++++++++++++++++ content/docs/reference/routes/tls.mdx | 54 +++++++++++++++++ content/docs/reference/routes/to.mdx | 17 ++++++ 19 files changed, 429 insertions(+), 6 deletions(-) diff --git a/content/docs/reference/cookies.mdx b/content/docs/reference/cookies.mdx index eec51225e..f344de1ee 100644 --- a/content/docs/reference/cookies.mdx +++ b/content/docs/reference/cookies.mdx @@ -362,7 +362,7 @@ cookie: -| **[Parameter name](/docs/deploy/k8s/reference#cookie)** | **Type** | **Usage** | **Default** | **Options** | +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | **Options** | | :-- | :-- | :-- | :-- | :-- | | `cookie_same_site` | `String` | **optional** | ` Lax` (if unset) | See [Cookie SameSite Options](#cookie-samesite-options) | diff --git a/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx b/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx index 58206e135..ca57966a3 100644 --- a/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx +++ b/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx @@ -51,5 +51,18 @@ Enable **Google Cloud Serverless Authentication** under **General** route settin Kubernetes does not support **Enable Google Cloud Serverless Authentication** + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | +| :-- | :-- | :-- | :-- | +| `enable_google_cloud_serverless_authentication` | Boolean | **optional** | `false` | + +#### Examples + +```yaml +enable_google_cloud_serverless_authentication = true +``` + diff --git a/content/docs/reference/routes/from.mdx b/content/docs/reference/routes/from.mdx index 983713687..d67e02e88 100644 --- a/content/docs/reference/routes/from.mdx +++ b/content/docs/reference/routes/from.mdx @@ -94,6 +94,24 @@ Define a **From** route under **General** route settings in the Console: See Kubernetes [Ingress](/docs/deploy/k8s/ingress) for more information. + + + +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/route)** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `from` | String | **required** | + +#### Examples + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] +} +``` + diff --git a/content/docs/reference/routes/headers.mdx b/content/docs/reference/routes/headers.mdx index 5dfd9d3e0..0dadd037a 100644 --- a/content/docs/reference/routes/headers.mdx +++ b/content/docs/reference/routes/headers.mdx @@ -75,6 +75,22 @@ Configure **Host Rewrite** settings in the route **Headers** settings in the Con ingress.pomerium.io/host_rewrite: 'example.com' ``` + + + +| **Parameter name** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `host_rewrite` | `String` | **optional** | +| `host_rewrite_header` | `String` | **optional** | +| `host_path_regex_rewrite_pattern` | `String` | **optional** | +| `host_path_regex_rewrite_substitution` | `String` | **optional** | + +### Examples + +```yaml +host_rewrite = "example.com" +``` + diff --git a/content/docs/reference/routes/identity-provider-client-id-per-route.mdx b/content/docs/reference/routes/identity-provider-client-id-per-route.mdx index 2dd94966c..4470ea26f 100644 --- a/content/docs/reference/routes/identity-provider-client-id-per-route.mdx +++ b/content/docs/reference/routes/identity-provider-client-id-per-route.mdx @@ -48,5 +48,23 @@ Set **Identity Provider Client ID (per route)** in the Console: Kubernetes does not support `idp_client_id` (per route) + + + +| **Parameter name** | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `idp_client_id` | `String` | **optional** | + +### Examples + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + idp_client_id = idp_client_id +} +``` diff --git a/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx b/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx index 9864904ee..1d695bc6f 100644 --- a/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx +++ b/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx @@ -48,5 +48,23 @@ Set **Identity Provider Client Secret (per route)** in the Console: Kubernetes does not support `idp_client_secret` (per route) + + + +| **Parameter name** | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `idp_client_secret` | `String` | **optional** | + +### Examples + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + idp_client_secret = idp_client_secret +} +``` diff --git a/content/docs/reference/routes/jwt-issuer-format.mdx b/content/docs/reference/routes/jwt-issuer-format.mdx index d857e1179..2b8515648 100644 --- a/content/docs/reference/routes/jwt-issuer-format.mdx +++ b/content/docs/reference/routes/jwt-issuer-format.mdx @@ -42,5 +42,17 @@ jwt_issuer_format: uri **JWT Issuer Format** is not currently supported in Ingress Controller. + + + +| **Parameter name** | **Type** | **Default** | +| :------------------------ | :------- | :----------- | +| `jwt_issuer_format` | String | `hostOnly` | + +### Examples + +```yaml +jwt_issuer_format = uri +``` diff --git a/content/docs/reference/routes/kubernetes-service-account-token.mdx b/content/docs/reference/routes/kubernetes-service-account-token.mdx index 4fe015d30..9445a8b1b 100644 --- a/content/docs/reference/routes/kubernetes-service-account-token.mdx +++ b/content/docs/reference/routes/kubernetes-service-account-token.mdx @@ -52,5 +52,21 @@ Set the **Kubernetes Service Account Token** under **General** route settings in This option is not supported in Kubernetes. + + + +| **Parameter name** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `kubernetes_service_account_token` | String | **optional** | +| `kubernetes_service_account_token_file` | String | **optional** | + +### Examples + +```yaml +kubernetes_service_account_token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJ..." + +kubernetes_service_account_token_file = "/var/run/secrets/kubernetes.io/serviceaccount/token" +``` + diff --git a/content/docs/reference/routes/load-balancing-policy-config.mdx b/content/docs/reference/routes/load-balancing-policy-config.mdx index 9706a10e2..4b16fc89f 100644 --- a/content/docs/reference/routes/load-balancing-policy-config.mdx +++ b/content/docs/reference/routes/load-balancing-policy-config.mdx @@ -42,6 +42,14 @@ When [`lb_policy`](/docs/reference/routes/load-balancing#load-balancing-policy) See Kubernetes [Ingress](/docs/deploy/k8s/ingress#load-balancing) for more information + + + +| **Config file keys** | **Type** | **Options** | +| :-- | :-- | :-- | +| `load_balancing_policy` | String | `least_request`, `ring_hash`, `maglev` | + + diff --git a/content/docs/reference/routes/load-balancing.mdx b/content/docs/reference/routes/load-balancing.mdx index 8bb673a32..f3ca6dc9e 100644 --- a/content/docs/reference/routes/load-balancing.mdx +++ b/content/docs/reference/routes/load-balancing.mdx @@ -69,6 +69,25 @@ ingress.pomerium.io/least_request_lb_config: '{"choice_count": 2}' See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more information. + + + +| **Config file keys** | **Type** | **Usage** | **Default** | +| :------------------- | :------- | :----------- | :------------ | +| `load_balancing_policy` | String | **optional** | `round_robin` | + +### Examples {#examples-load-balancing-policy} + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + load_balancing_policy = "least_request" +} +``` + diff --git a/content/docs/reference/routes/pass-identity-headers.mdx b/content/docs/reference/routes/pass-identity-headers.mdx index aa18281fd..f9d184d63 100644 --- a/content/docs/reference/routes/pass-identity-headers.mdx +++ b/content/docs/reference/routes/pass-identity-headers.mdx @@ -61,5 +61,21 @@ Set **Pass Identity Headers** under **General** route settings in the Console: ingress.pomerium.io/pass_identity_headers: 'true' ``` + + + +| **Parameter namespace_id** | **Type** | **Usage** | **Default** | +| :-- | :-- | :-- | :-- | +| `pass_identity_headers` | Boolean | **optional** | `false` | + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + pass_identity_headers = true +} +``` diff --git a/content/docs/reference/routes/path-matching.mdx b/content/docs/reference/routes/path-matching.mdx index fcf3f3ae4..783acba6b 100644 --- a/content/docs/reference/routes/path-matching.mdx +++ b/content/docs/reference/routes/path-matching.mdx @@ -53,6 +53,25 @@ Set **Path** under **Path Matching** settings in the Console: See Kubernetes [Ingress](/docs/deploy/k8s/ingress#regular-expressions-path-matching) for more information + + + +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `path` | String | **optional** | + +### Examples {#examples-path} + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + path = "/admin/some/exact/path" +} +``` + @@ -109,6 +128,25 @@ spec: See Kubernetes [Ingress](/docs/deploy/k8s/ingress#annotations) for more information + + + +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `prefix` | String | **optional** | + +### Examples {#examples-path} + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + prefix = "/admin" +} +``` + @@ -165,5 +203,18 @@ spec: pathType: ImplementationSpecific ``` + + + +| **Parameter name** | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `regex` | String | **optional** | + +### Examples {#examples-regex} + +```yaml +regex = "^/(admin|superuser)/.*$" +``` + diff --git a/content/docs/reference/routes/path-rewriting.mdx b/content/docs/reference/routes/path-rewriting.mdx index dcf7622f9..c0d6f175b 100644 --- a/content/docs/reference/routes/path-rewriting.mdx +++ b/content/docs/reference/routes/path-rewriting.mdx @@ -85,6 +85,26 @@ Configure **Prefix Rewrite** in the Console: | :-- | :-- | :-- | | `prefix_rewrite` | `string` | **optional** | + + + +| **Parameter name** | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `prefix_rewrite` | String | **optional** | + +### Examples {#examples-prefix-rewrite} + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + prefix = "/admin" + prefix_rewrite = "/" +} +``` + @@ -123,5 +143,20 @@ Set **Regex Rewrite** pattern and substitution in the Console: Kubernetes does not support **Regex Rewrite** + + + +| **Parameter name** | **Type** | **Usage** | +| :--------------------------- | :------- | :----------- | +| `host_path_regex_rewrite_pattern` | String | **optional** | +| `host_path_regex_rewrite_substitution ` | String | **optional** | + +### Examples {#examples-regex-rewrite} + +```yaml +host_path_regex_rewrite_pattern = "^/service/([^/]+)(/.*)$" +host_path_regex_rewrite_substitution = "\\2/instance/\\1" +``` + diff --git a/content/docs/reference/routes/policy.mdx b/content/docs/reference/routes/policy.mdx index 5da51f732..ff73d7dfb 100644 --- a/content/docs/reference/routes/policy.mdx +++ b/content/docs/reference/routes/policy.mdx @@ -79,5 +79,24 @@ ingress.pomerium.io/policy: | is: user ``` + + + +| **Parameter name** | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `policies ` | Set of String | **optional** | + +### Examples + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + policies = [pomerium_policy.test_policy.id] +} +``` + diff --git a/content/docs/reference/routes/regex-priority-order.mdx b/content/docs/reference/routes/regex-priority-order.mdx index 774aa06f2..7a27a200f 100644 --- a/content/docs/reference/routes/regex-priority-order.mdx +++ b/content/docs/reference/routes/regex-priority-order.mdx @@ -48,5 +48,19 @@ Set **Regex Priority Order** in the Console: Kubernetes does not support **Regex Priority Order** + + + +| **Parameter name**| **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `regex_priority_order` | Number | **optional** | + +### Examples + +```yaml +regex = "^/(admin|superuser)/.*$" +regex_priority_order = 1 +``` + diff --git a/content/docs/reference/routes/show-error-details.mdx b/content/docs/reference/routes/show-error-details.mdx index 7effdfeee..0f35a1ec2 100644 --- a/content/docs/reference/routes/show-error-details.mdx +++ b/content/docs/reference/routes/show-error-details.mdx @@ -17,13 +17,32 @@ import TabItem from '@theme/TabItem'; If true, **Show Error Details** allows you apply your custom [error message header](/docs/reference/branding) to a route. ## How to configure - -| **Type** | **Default** | -| :-------- | :---------- | -| `boolean` | `false` | - + + ### Examples Enable **Show Error Details** on a route in the Console: ![Show error details](../branding/img/branding-show-error-details.png) + + + + +| **Parameter name**| **Type** | **Default** | +| :------------------------ | :------- | :----------- | +| `show_error_details ` | Boolean | `false`| + +### Examples + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + policies = [pomerium_policy.test_policy.id] + show_error_details = true +} +``` + + \ No newline at end of file diff --git a/content/docs/reference/routes/timeouts.mdx b/content/docs/reference/routes/timeouts.mdx index bea944dca..97f81cefe 100644 --- a/content/docs/reference/routes/timeouts.mdx +++ b/content/docs/reference/routes/timeouts.mdx @@ -65,6 +65,19 @@ Enable **Allow Websockets** in the Console: ingress.pomerium.io/allow_websockets: 'true' ``` + + + +| **Parameter name** | **Type** | **Default** | +| :------------------------ | :-------- | :---------- | +| `allow_websockets` | Boolean | `false` | + +### Examples {#examples-websocket-connections} + +```yaml +allow_websockets = true +``` + @@ -109,6 +122,19 @@ ingress.pomerium.io/allow_spdy: 'true' See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more information. + + + +| **YAML**/**JSON** setting | **Type** | **Default** | +| :------------------------ | :-------- | :---------- | +| `allow_spdy` | Boolean | `false` | + +### Examples {#examples-spdy} + +```YAML +allow_spdy = true +``` + @@ -151,6 +177,19 @@ Set the **Route Timeout** in the Console: ingress.pomerium.io/timeout: '30s' ``` + + + +| **Parameter name** | **Type** | **Usage** | **Default** | +| :-- | :-- | :-- | :-- | +| `timeout` | String | **optional** | `30s` | + +### Examples {#examples-route-timeout} + +```yaml +timeout = 30s +``` + @@ -200,5 +239,26 @@ ingress.pomerium.io/timeout: '1m' ingress.pomerium.io/idle_timeout: '5m' ``` + + + +| **Parameter name** | **Type** | **Usage** | **Default** | +| :-- | :-- | :-- | :-- | +| `idle_timeout` | String | **optional** | `5m` | + +### Examples + +```yaml +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + policies = [pomerium_policy.test_policy.id] + idle_timeout = 5m +} + +``` + diff --git a/content/docs/reference/routes/tls.mdx b/content/docs/reference/routes/tls.mdx index 8acdd9d38..a682c9d39 100644 --- a/content/docs/reference/routes/tls.mdx +++ b/content/docs/reference/routes/tls.mdx @@ -62,6 +62,13 @@ Set the **TLS Client Certificate** under **TLS Settings** in the Console: See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for more information + + + +| **Paameter name** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `tls_client_key_pair_id ` | String | **optional** | + @@ -99,6 +106,13 @@ Set **TLS Custom Certificate Authority** in the Console: See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for more information + + + +| **Parameter name** | **Type** | **Usage** | +| :-------------------------------------- | :------- | :----------- | +| `tls_custom_ca_key_pair_id` | String | **optional** | + @@ -176,6 +190,13 @@ Set **TLS Downstream Server Name** in the Console: Kubernetes does not support `tls_downstream_server_name` + + + +| **Parameter name** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `tls_downstream_server_name` | String | **optional** | + @@ -222,6 +243,19 @@ Enable **TLS Skip Verify** in the Console: ingress.pomerium.io/tls_skip_verify: 'true' ``` + + + +| **Parameter name** | **Type** | **Default** | +| :------------------------ | :-------- | :---------- | +| `tls_skip_verify` | Boolean | `false` | + +### Examples {#examples-tls-skip-verification} + +```yaml +tls_skip_verify = true +``` + @@ -262,6 +296,19 @@ Enable **TLS Upstream Allow Renegotiation** in the Console: Kubernetes does not support **TLS Upstream Allow Renegotiation** + + + +| **Parameter name** | **Type** | **Default** | +| :--------------------------------- | :-------- | :---------- | +| `tls_upstream_allow_renegotiation` | Boolean | `false` | + +### Examples {#examples-tls-upstream-allow-renegotiation} + +```yaml +tls_upstream_allow_renegotiation = true +``` + @@ -290,5 +337,12 @@ Set **TLS Upstream Server Name** in the Console: Kubernetes does not support `tls_upstream_server_name` + + + +| **Parameter name** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `tls_upstream_server_name` | String | **optional** | + diff --git a/content/docs/reference/routes/to.mdx b/content/docs/reference/routes/to.mdx index 008863071..b67912c84 100644 --- a/content/docs/reference/routes/to.mdx +++ b/content/docs/reference/routes/to.mdx @@ -55,6 +55,23 @@ Set **To** in the Console: See Kubernetes [Ingress](/docs/deploy/k8s/ingress) for more information. + + + +| **Parameter name** | **Type** | **Usage** | **Schemes** | +| :-- | :-- | :-- | :-- | +| `to` | Set of String | **optional** | `http`, `https`, `h2c`, `tcp`, `udp` | + +### Examples + +```yaml +resource "pomerium_route" "example_route" { + name = "example-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://example.com" + to = ["https://a.example.com", "https://b.example.com", "https://c.example.com"] +} +``` From 7cd22150a7c73ca3fbcdbd16b44269ce56544c23 Mon Sep 17 00:00:00 2001 From: Svetlana Rekuts Date: Wed, 26 Mar 2025 23:48:04 +0000 Subject: [PATCH 3/6] Fix spelling --- content/docs/reference/routes/timeouts.mdx | 34 +++++++++------------- content/docs/reference/routes/tls.mdx | 2 +- 2 files changed, 14 insertions(+), 22 deletions(-) diff --git a/content/docs/reference/routes/timeouts.mdx b/content/docs/reference/routes/timeouts.mdx index 97f81cefe..fcdde627b 100644 --- a/content/docs/reference/routes/timeouts.mdx +++ b/content/docs/reference/routes/timeouts.mdx @@ -68,9 +68,9 @@ ingress.pomerium.io/allow_websockets: 'true' -| **Parameter name** | **Type** | **Default** | -| :------------------------ | :-------- | :---------- | -| `allow_websockets` | Boolean | `false` | +| **Parameter name** | **Type** | **Default** | +| :----------------- | :------- | :---------- | +| `allow_websockets` | Boolean | `false` | ### Examples {#examples-websocket-connections} @@ -125,9 +125,9 @@ See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more info -| **YAML**/**JSON** setting | **Type** | **Default** | -| :------------------------ | :-------- | :---------- | -| `allow_spdy` | Boolean | `false` | +| **YAML**/**JSON** setting | **Type** | **Default** | +| :------------------------ | :------- | :---------- | +| `allow_spdy` | Boolean | `false` | ### Examples {#examples-spdy} @@ -180,9 +180,9 @@ ingress.pomerium.io/timeout: '30s' -| **Parameter name** | **Type** | **Usage** | **Default** | -| :-- | :-- | :-- | :-- | -| `timeout` | String | **optional** | `30s` | +| **Parameter name** | **Type** | **Usage** | **Default** | +| :----------------- | :------- | :----------- | :---------- | +| `timeout` | String | **optional** | `30s` | ### Examples {#examples-route-timeout} @@ -242,22 +242,14 @@ ingress.pomerium.io/idle_timeout: '5m' -| **Parameter name** | **Type** | **Usage** | **Default** | -| :-- | :-- | :-- | :-- | -| `idle_timeout` | String | **optional** | `5m` | +| **Parameter name** | **Type** | **Usage** | **Default** | +| :----------------- | :------- | :----------- | :---------- | +| `idle_timeout` | String | **optional** | `5m` | ### Examples ```yaml -resource "pomerium_route" "verify_route" { - name = "verify-route" - namespace_id = pomerium_namespace.test_namespace.id - from = "https://verify.localhost.pomerium.io" - to = ["https://verify.pomerium.com"] - policies = [pomerium_policy.test_policy.id] - idle_timeout = 5m -} - +resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id from = "https://verify.localhost.pomerium.io" to = ["https://verify.pomerium.com"] policies = [pomerium_policy.test_policy.id] idle_timeout = 5m } ``` diff --git a/content/docs/reference/routes/tls.mdx b/content/docs/reference/routes/tls.mdx index a682c9d39..79013eb9f 100644 --- a/content/docs/reference/routes/tls.mdx +++ b/content/docs/reference/routes/tls.mdx @@ -65,7 +65,7 @@ See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for -| **Paameter name** | **Type** | **Usage** | +| **Parameter name** | **Type** | **Usage** | | :-- | :-- | :-- | | `tls_client_key_pair_id ` | String | **optional** | From ea53a7ee89dd39a1a03361b7bb7dae891a131f46 Mon Sep 17 00:00:00 2001 From: Svetlana Rekuts Date: Thu, 27 Mar 2025 17:36:13 +0000 Subject: [PATCH 4/6] Rename `Terraform` into `Enterprise via Terraform` and add hcl tagin the examples --- content/docs/reference/access-log-fields.mdx | 6 +- content/docs/reference/address.mdx | 4 +- .../reference/authenticate-callback-path.mdx | 4 +- .../docs/reference/authorize-log-fields.mdx | 4 +- content/docs/reference/autocert.mdx | 10 +-- content/docs/reference/certificates.mdx | 8 +- content/docs/reference/cookies.mdx | 24 +++--- content/docs/reference/dns-lookup-family.mdx | 4 +- content/docs/reference/global-timeouts.mdx | 18 ++--- ...verless-authentication-service-account.mdx | 4 +- content/docs/reference/grpc.mdx | 8 +- .../docs/reference/http-redirect-address.mdx | 4 +- .../reference/identity-provider-settings.mdx | 24 +++--- content/docs/reference/insecure-server.mdx | 4 +- content/docs/reference/jwt-claim-headers.mdx | 4 +- content/docs/reference/log-level.mdx | 4 +- content/docs/reference/metrics.mdx | 4 +- .../docs/reference/pass-identity-headers.mdx | 4 +- content/docs/reference/proxy-log-level.mdx | 4 +- ...google-cloud-serverless-authentication.mdx | 4 +- content/docs/reference/routes/from.mdx | 4 +- content/docs/reference/routes/headers.mdx | 80 ++++++++++++++++++- .../identity-provider-client-id-per-route.mdx | 4 +- ...ntity-provider-client-secret-per-route.mdx | 4 +- .../reference/routes/jwt-issuer-format.mdx | 4 +- .../kubernetes-service-account-token.mdx | 4 +- .../routes/load-balancing-policy-config.mdx | 2 +- .../docs/reference/routes/load-balancing.mdx | 4 +- .../routes/pass-identity-headers.mdx | 4 +- .../docs/reference/routes/path-matching.mdx | 12 +-- .../docs/reference/routes/path-rewriting.mdx | 8 +- content/docs/reference/routes/policy.mdx | 4 +- .../reference/routes/regex-priority-order.mdx | 4 +- .../reference/routes/show-error-details.mdx | 4 +- content/docs/reference/routes/timeouts.mdx | 16 ++-- content/docs/reference/routes/tls.mdx | 16 ++-- content/docs/reference/routes/to.mdx | 4 +- content/docs/reference/service-urls.md | 21 ++--- .../docs/reference/set-response-headers.mdx | 4 +- .../reference/x-forwarded-for-settings.mdx | 4 +- 40 files changed, 218 insertions(+), 139 deletions(-) diff --git a/content/docs/reference/access-log-fields.mdx b/content/docs/reference/access-log-fields.mdx index c65524698..b50a2f49b 100644 --- a/content/docs/reference/access-log-fields.mdx +++ b/content/docs/reference/access-log-fields.mdx @@ -89,7 +89,7 @@ accessLogFields: - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings#access_log_fields-1)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -97,14 +97,14 @@ accessLogFields: ### Examples -```yaml +```hcl access_log_fields = ["authority", "duration", "path"] ``` **Custom headers example** -```yaml +```hcl access_log_fields = ["headers.user-agent", "headers.content-type"] ``` diff --git a/content/docs/reference/address.mdx b/content/docs/reference/address.mdx index b3d88f633..0161373c4 100644 --- a/content/docs/reference/address.mdx +++ b/content/docs/reference/address.mdx @@ -56,7 +56,7 @@ ADDRESS=:8443 `address` is included in the deployment manifest and not customizable. - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings#address-1)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -64,7 +64,7 @@ ADDRESS=:8443 ### Examples -```yaml +```hcl address = ":8433" ``` diff --git a/content/docs/reference/authenticate-callback-path.mdx b/content/docs/reference/authenticate-callback-path.mdx index be4f14558..b9e97f4f2 100644 --- a/content/docs/reference/authenticate-callback-path.mdx +++ b/content/docs/reference/authenticate-callback-path.mdx @@ -76,7 +76,7 @@ authenticate: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | | :-- | :-- | :-- | :-- | @@ -84,7 +84,7 @@ authenticate: ### Examples -```yaml +```hcl authenticate_callback_path = "/custom/callback" ``` diff --git a/content/docs/reference/authorize-log-fields.mdx b/content/docs/reference/authorize-log-fields.mdx index eaafa4c91..42175b21f 100644 --- a/content/docs/reference/authorize-log-fields.mdx +++ b/content/docs/reference/authorize-log-fields.mdx @@ -92,7 +92,7 @@ authorizeLogFields: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -100,7 +100,7 @@ authorizeLogFields: ### Examples -```yaml +```hcl authorize_log_fields = ["request-id", "path", "ip"] ``` diff --git a/content/docs/reference/autocert.mdx b/content/docs/reference/autocert.mdx index 3d3c06af2..6f76764dd 100644 --- a/content/docs/reference/autocert.mdx +++ b/content/docs/reference/autocert.mdx @@ -73,7 +73,7 @@ autocert: true AUTOCERT=TRUE ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -81,7 +81,7 @@ AUTOCERT=TRUE ### Examples -```yaml +```hcl autocert = true ``` @@ -153,7 +153,7 @@ Credentials are sourced from [Google Application Default Credentials](https://cl - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -169,7 +169,7 @@ Credentials are sourced from [Google Application Default Credentials](https://cl An S3 bucket can be used as storage by using a URL like: -```yaml +```hcl autocert_dir = "s3://your-bucket.s3.us-east-1.amazonaws.com/some/prefix" ``` @@ -179,7 +179,7 @@ Credentials are sourced from [the environment](https://pkg.go.dev/github.com/aws A Google Cloud Storage bucket can be used as storage by using a URL like: -```yaml +```hcl autocert_dir = "gs://your-bucket/some/prefix" ``` diff --git a/content/docs/reference/certificates.mdx b/content/docs/reference/certificates.mdx index 69a640f0f..a3879b28a 100644 --- a/content/docs/reference/certificates.mdx +++ b/content/docs/reference/certificates.mdx @@ -94,9 +94,9 @@ certificates: pomerium/wildcard-localhost See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for more information. - + -```yaml +```hcl resource "pomerium_key_pair" "wildcard-localhost" { namespace_id = pomerium_namespace.test_namespace.id name = "wildcard-localhost-key-pair" @@ -166,7 +166,7 @@ Configure **Certificate Authority** in the Enterprise Console: Kubernetes does not support `certificate_authority` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -175,7 +175,7 @@ Kubernetes does not support `certificate_authority` ### Examples -```yaml +```hcl certificate_authority = "base64-encoded-string" certificate_authority_file = "/relative/file/location" ``` diff --git a/content/docs/reference/cookies.mdx b/content/docs/reference/cookies.mdx index f344de1ee..b0c8f0b79 100644 --- a/content/docs/reference/cookies.mdx +++ b/content/docs/reference/cookies.mdx @@ -65,7 +65,7 @@ cookie: ``` - + | **[Parameter name](/docs/deploy/k8s/reference#cookie)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -73,7 +73,7 @@ cookie: #### Examples {#cookie-name-examples} -```yaml +```hcl cookie_name = "cookie_name" ``` @@ -121,7 +121,7 @@ COOKIE_SECRET=tdkuWzUelRukP/6VYzopfh6kis7y5u5Ldl3MrIq9ZR0= See Kubernetes [bootstrap secrets](/docs/deploy/k8s/configure#bootstrap-secrets) for more information. - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -129,7 +129,7 @@ See Kubernetes [bootstrap secrets](/docs/deploy/k8s/configure#bootstrap-secrets) #### Examples {#cookie-name-examples} -```yaml +```hcl cookie_secret = "tdkuWzUelRukP/6VYzopfh6kis7y5u5Ldl3MrIq9ZR0=" ``` @@ -180,7 +180,7 @@ cookie: ``` - + | **[Parameter name](/docs/deploy/k8s/reference#cookie)** | **Type** | **Usage** | **Default** | | :-- | :-- | :-- | :-- | @@ -188,7 +188,7 @@ cookie: #### Examples {#cookie-domain-examples} -```yaml +```hcl cookie_domain = "localhost.pomerium.io" ``` @@ -242,7 +242,7 @@ cookie: httpOnly: false ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -250,7 +250,7 @@ cookie: #### Examples {#cookie-http-only-examples} -```yaml +```hcl cookie_http_only = false ``` @@ -299,7 +299,7 @@ cookie: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -307,7 +307,7 @@ cookie: #### Examples {#cookie-expiration-examples} -```yaml +```hcl cookie_expire = "13h15m0.5s" ``` @@ -360,7 +360,7 @@ cookie: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | **Options** | | :-- | :-- | :-- | :-- | :-- | @@ -368,7 +368,7 @@ cookie: #### Examples {#cookie-samesite-examples} -```yaml +```hcl cookie_same_site = "Lax" ``` diff --git a/content/docs/reference/dns-lookup-family.mdx b/content/docs/reference/dns-lookup-family.mdx index 157711cbc..6e82ec206 100644 --- a/content/docs/reference/dns-lookup-family.mdx +++ b/content/docs/reference/dns-lookup-family.mdx @@ -52,14 +52,14 @@ Set **DNS Lookup Family** in the Console: Kubernetes does not support `dns_lookup_family` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | | `dns_lookup_family` | String | `V4_PREFERRED` | ### Examples -```yaml +```hcl default_lookup_family = "AUTO" ``` diff --git a/content/docs/reference/global-timeouts.mdx b/content/docs/reference/global-timeouts.mdx index 57de5a6db..879b05a8b 100644 --- a/content/docs/reference/global-timeouts.mdx +++ b/content/docs/reference/global-timeouts.mdx @@ -68,15 +68,15 @@ timeouts: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Defaults** | | :-- | :-- | :-- | -| `timeout_read ` | [Go Duration] string | `30s` | +| `timeout_read ` | String | `30s` | ### Examples -```yaml +```hcl timeout_read = "30s" ``` @@ -127,15 +127,15 @@ timeouts: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | -| `timeout_write` | [Go Duration] string | `0` (no timeout) | +| `timeout_write` | String | `0` (no timeout) | ### Examples -```yaml +```hcl timeout_write = "0" ``` @@ -186,15 +186,15 @@ timeouts: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | -| `timeout_idle ` | [Go Duration] string | `5m` | +| `timeout_idle ` | String | `5m` | ### Examples -```yaml +```hcl timeout_idle = "5m" ``` diff --git a/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx b/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx index decfc35f4..768ecb334 100644 --- a/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx +++ b/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx @@ -53,14 +53,14 @@ GOOGLE_CLOUD_SERVERLESS_AUTHENTICATION_SERVICE_ACCOUNT=base64-encoded-service-ac Kubernetes does not support `google_cloud_serverless_authentication_service_account` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `google_cloud_serverless_authentication_service_account ` | String | **optional** | ### Examples -```yaml +```hcl google_cloud_serverless_authentication_service_account = "base64-encoded-service-account-credentials" ``` diff --git a/content/docs/reference/grpc.mdx b/content/docs/reference/grpc.mdx index a8989cb32..8fc537f96 100644 --- a/content/docs/reference/grpc.mdx +++ b/content/docs/reference/grpc.mdx @@ -58,14 +58,14 @@ GRPC_ADDRESS=:8443 **gRPC Address** is not customizable with Kubernetes - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | | `grpc_address` | String | `:5443` in all-in-one mode
`:443` in [split service mode] | ### Examples -```yaml +```hcl grpc_address = ":8443" ``` @@ -141,14 +141,14 @@ GRPC_INSECURE=false **gRPC Insecure** is not customizable in Kubernetes - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | | `grpc_insecure` | Boolean | `true` in all-in-one mode
`false` in [split service mode] | ### Examples -```yaml +```hcl grpc_insecure = false ``` diff --git a/content/docs/reference/http-redirect-address.mdx b/content/docs/reference/http-redirect-address.mdx index 0c99881b9..d753f148b 100644 --- a/content/docs/reference/http-redirect-address.mdx +++ b/content/docs/reference/http-redirect-address.mdx @@ -50,14 +50,14 @@ Set **HTTP Redirect Address** in the Console: ![Set HTTP redirect address in the **HTTP Redirect Address** is not customizable in Kubernetes - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | | `http_redirect_addr` | String | **optional** | ### Examples -```yaml +```hcl http_redirect_addr = ":80" ``` diff --git a/content/docs/reference/identity-provider-settings.mdx b/content/docs/reference/identity-provider-settings.mdx index 3183e623c..3ddd1fe91 100644 --- a/content/docs/reference/identity-provider-settings.mdx +++ b/content/docs/reference/identity-provider-settings.mdx @@ -73,14 +73,14 @@ Configure **Identity Provider Client ID** under **IDP Options** in the Console: See [`identityProvider.secret`](/docs/deploy/k8s/reference#identityprovider) - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_client_id` | String | **required** (if self-hosting) | ### Examples -```yaml +```hcl idp_client_id = idp_client_id ``` @@ -122,14 +122,14 @@ Configure **Identity Provider Client Secret** under **IDP Settings** in the Cons See [`identityProvider.secret`](/docs/deploy/k8s/reference#identityprovider) for more information - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_client_secret` | String | **required** (unless using [idp_client_secret_file](#identity-provider-client-secret-file)) | ### Examples -```yaml +```hcl idp_client_secret = idp_client_secret ``` @@ -225,14 +225,14 @@ Set **Identity Provider Name** under the **Identity Provider** options in the Co See [`identityProvider.provider`](/docs/deploy/k8s/reference#identityprovider) for more information - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_provider` | String | **required** (if [self-hosting](/docs/capabilities/authentication)) | ### Examples -```yaml +```hcl idp_provider = "auth0" ``` @@ -277,14 +277,14 @@ Configure **Identity Provider Request Params** under **Authenticate** settings i See Kubernetes [`identityProvider.requestParams` and `identityProvider.requestParamsSecret`](/docs/deploy/k8s/reference#identityprovider) for more information - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `request_params` | Map of String | **optional** | ### Examples -```yaml +```hcl request_params = {"client_id": "client_id", "response_type": "response_type", "redirect_uri": "redirect_uri"} ``` @@ -359,14 +359,14 @@ Configure **Identity Provider Scopes** under **Authenticate** settings in the Co See Kubernetes [`identityProvider.scopes`](/docs/deploy/k8s/reference#identityprovider) for more information - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `scopes` | Set of String | **optional** | ### Examples -```yaml +```hcl scopes = ["openid", "profile", "offline_access", "email"] ``` @@ -419,14 +419,14 @@ Set the **Identity Provider URL** under **IDP Options** settings in the Console: See Kubernetes [`identityProvider.url`](/docs/deploy/k8s/reference#identityprovider) for more information - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_provider_url` | String | **required** (depending on identity provider) | ### Examples -```yaml +```hcl idp_provider_url = "https://awesome-company.auth0.com" ``` diff --git a/content/docs/reference/insecure-server.mdx b/content/docs/reference/insecure-server.mdx index 98578083a..6ae5a3ac9 100644 --- a/content/docs/reference/insecure-server.mdx +++ b/content/docs/reference/insecure-server.mdx @@ -58,14 +58,14 @@ INSECURE_SERVER=true Kubernetes does not support **Insecure Server** - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `insecure_server` | Boolean | **required** (if [certificates](/docs/reference/certificates) unset) | ### Examples -```yaml +```hcl insecure_server = true ``` diff --git a/content/docs/reference/jwt-claim-headers.mdx b/content/docs/reference/jwt-claim-headers.mdx index e39fef353..9a415846a 100644 --- a/content/docs/reference/jwt-claim-headers.mdx +++ b/content/docs/reference/jwt-claim-headers.mdx @@ -63,7 +63,7 @@ jwtClaimHeaders: ``` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -71,7 +71,7 @@ jwtClaimHeaders: ### Examples -```yaml +```hcl jwt_claims_headers = {"X-Email": "email", "X-Username": "user"} ``` diff --git a/content/docs/reference/log-level.mdx b/content/docs/reference/log-level.mdx index 3f6f95e6c..b703482d1 100644 --- a/content/docs/reference/log-level.mdx +++ b/content/docs/reference/log-level.mdx @@ -60,7 +60,7 @@ Set **Log Level** under **Global** settings in the Console: Kubernetes does not support `log_level` - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -68,7 +68,7 @@ Kubernetes does not support `log_level` ### Examples -```yaml +```hcl log_level = "error" ``` diff --git a/content/docs/reference/metrics.mdx b/content/docs/reference/metrics.mdx index 986b44a1b..ab40c6042 100644 --- a/content/docs/reference/metrics.mdx +++ b/content/docs/reference/metrics.mdx @@ -59,7 +59,7 @@ METRICS_ADDRESS: 127.0.0.1:9090 See Kubernetes [Metrics](/docs/deploy/k8s/install#metrics) - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -67,7 +67,7 @@ See Kubernetes [Metrics](/docs/deploy/k8s/install#metrics) ### Examples -```yaml +```hcl metrics_address = ":9090" ``` diff --git a/content/docs/reference/pass-identity-headers.mdx b/content/docs/reference/pass-identity-headers.mdx index bc2f010ce..c8292c3ac 100644 --- a/content/docs/reference/pass-identity-headers.mdx +++ b/content/docs/reference/pass-identity-headers.mdx @@ -73,7 +73,7 @@ passIdentityHeaders: true See [Kubernetes - Global Configuration](/docs/deploy/k8s/configure) for more information. - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | | :-- | :-- | :-- | :-- | @@ -81,7 +81,7 @@ See [Kubernetes - Global Configuration](/docs/deploy/k8s/configure) for more inf ### Examples -```yaml +```hcl pass_identity_headers = true ``` diff --git a/content/docs/reference/proxy-log-level.mdx b/content/docs/reference/proxy-log-level.mdx index 8c4e92402..88790c775 100644 --- a/content/docs/reference/proxy-log-level.mdx +++ b/content/docs/reference/proxy-log-level.mdx @@ -52,7 +52,7 @@ Set **Proxy Log Level** under **Global** settings in the Console: Kubernetes does not support **Proxy Log Level** - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -60,7 +60,7 @@ Kubernetes does not support **Proxy Log Level** ### Examples -```yaml +```hcl proxy_log_level = "error" ``` diff --git a/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx b/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx index ca57966a3..14def25f3 100644 --- a/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx +++ b/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx @@ -52,7 +52,7 @@ Enable **Google Cloud Serverless Authentication** under **General** route settin Kubernetes does not support **Enable Google Cloud Serverless Authentication** - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | | :-- | :-- | :-- | :-- | @@ -60,7 +60,7 @@ Kubernetes does not support **Enable Google Cloud Serverless Authentication** #### Examples -```yaml +```hcl enable_google_cloud_serverless_authentication = true ``` diff --git a/content/docs/reference/routes/from.mdx b/content/docs/reference/routes/from.mdx index d67e02e88..f47713599 100644 --- a/content/docs/reference/routes/from.mdx +++ b/content/docs/reference/routes/from.mdx @@ -95,7 +95,7 @@ Define a **From** route under **General** route settings in the Console: See Kubernetes [Ingress](/docs/deploy/k8s/ingress) for more information. - + | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/route)** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -103,7 +103,7 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress) for more information. #### Examples -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/routes/headers.mdx b/content/docs/reference/routes/headers.mdx index 0dadd037a..b5d305214 100644 --- a/content/docs/reference/routes/headers.mdx +++ b/content/docs/reference/routes/headers.mdx @@ -76,7 +76,7 @@ ingress.pomerium.io/host_rewrite: 'example.com' ``` - + | **Parameter name** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -87,7 +87,7 @@ ingress.pomerium.io/host_rewrite: 'example.com' ### Examples -```yaml +```hcl host_rewrite = "example.com" ``` @@ -202,6 +202,25 @@ ingress.pomerium.io/set_request_headers: | X-Test: X-Value ``` + + + + +| **Parameter name** | **Type** | **Usage** | +| :-- | :-- | :-- | +| `set_request_headers` | Map of String | **optional** | + +### Examples + +```hcl +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + set_request_headers = {"Pomerium-jwt": "$${pomerium.jwt}", "X-Your-favorite-authenticating-Proxy": "Pomerium"} +} +``` @@ -274,6 +293,25 @@ ingress.pomerium.io/remove_request_headers: | - X-User ``` + + + +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `remove_request_headers` | Set of String | **optional** | + +### Examples {#examples-remove-request-headers} + +```hcl +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + remove_request_headers = ["X-Email", "X-User"] +} +``` + @@ -316,6 +354,25 @@ ingress.pomerium.io/set_response_headers: | X-Test: X-Value ``` + + + +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `set_response_headers` | Map of String | **optional** | + +### Examples {#examples-remove-request-headers} + +```hcl +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + set_response_headers = {"X-Test": "X-Value"} +} +``` + @@ -384,5 +441,24 @@ ingress.pomerium.io/rewrite_response_headers: | The browser would be redirected to: `http://frontend/one/some/path/`. This is similar to nginx's [`proxy_redirect` option](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_redirect), but can be used for any header. + + + +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `rewrite_response_headers` | Map of String | **optional** | + +### Examples {#examples-remove-request-headers} + +```hcl +resource "pomerium_route" "verify_route" { + name = "verify-route" + namespace_id = pomerium_namespace.test_namespace.id + from = "https://verify.localhost.pomerium.io" + to = ["https://verify.pomerium.com"] + rewrite_response_headers = {"X-Test": "X-New-Value"} +} +``` + diff --git a/content/docs/reference/routes/identity-provider-client-id-per-route.mdx b/content/docs/reference/routes/identity-provider-client-id-per-route.mdx index 4470ea26f..211482d43 100644 --- a/content/docs/reference/routes/identity-provider-client-id-per-route.mdx +++ b/content/docs/reference/routes/identity-provider-client-id-per-route.mdx @@ -49,7 +49,7 @@ Set **Identity Provider Client ID (per route)** in the Console: Kubernetes does not support `idp_client_id` (per route) - + | **Parameter name** | **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -57,7 +57,7 @@ Kubernetes does not support `idp_client_id` (per route) ### Examples -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx b/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx index 1d695bc6f..a690d1df6 100644 --- a/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx +++ b/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx @@ -49,7 +49,7 @@ Set **Identity Provider Client Secret (per route)** in the Console: Kubernetes does not support `idp_client_secret` (per route) - + | **Parameter name** | **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -57,7 +57,7 @@ Kubernetes does not support `idp_client_secret` (per route) ### Examples -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/routes/jwt-issuer-format.mdx b/content/docs/reference/routes/jwt-issuer-format.mdx index 2b8515648..f7faf6161 100644 --- a/content/docs/reference/routes/jwt-issuer-format.mdx +++ b/content/docs/reference/routes/jwt-issuer-format.mdx @@ -43,7 +43,7 @@ jwt_issuer_format: uri **JWT Issuer Format** is not currently supported in Ingress Controller. - + | **Parameter name** | **Type** | **Default** | | :------------------------ | :------- | :----------- | @@ -51,7 +51,7 @@ jwt_issuer_format: uri ### Examples -```yaml +```hcl jwt_issuer_format = uri ``` diff --git a/content/docs/reference/routes/kubernetes-service-account-token.mdx b/content/docs/reference/routes/kubernetes-service-account-token.mdx index 9445a8b1b..03f6bb78a 100644 --- a/content/docs/reference/routes/kubernetes-service-account-token.mdx +++ b/content/docs/reference/routes/kubernetes-service-account-token.mdx @@ -53,7 +53,7 @@ Set the **Kubernetes Service Account Token** under **General** route settings in This option is not supported in Kubernetes. - + | **Parameter name** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -62,7 +62,7 @@ This option is not supported in Kubernetes. ### Examples -```yaml +```hcl kubernetes_service_account_token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJ..." kubernetes_service_account_token_file = "/var/run/secrets/kubernetes.io/serviceaccount/token" diff --git a/content/docs/reference/routes/load-balancing-policy-config.mdx b/content/docs/reference/routes/load-balancing-policy-config.mdx index 4b16fc89f..339d287f9 100644 --- a/content/docs/reference/routes/load-balancing-policy-config.mdx +++ b/content/docs/reference/routes/load-balancing-policy-config.mdx @@ -43,7 +43,7 @@ When [`lb_policy`](/docs/reference/routes/load-balancing#load-balancing-policy) See Kubernetes [Ingress](/docs/deploy/k8s/ingress#load-balancing) for more information - + | **Config file keys** | **Type** | **Options** | | :-- | :-- | :-- | diff --git a/content/docs/reference/routes/load-balancing.mdx b/content/docs/reference/routes/load-balancing.mdx index f3ca6dc9e..c8444ee01 100644 --- a/content/docs/reference/routes/load-balancing.mdx +++ b/content/docs/reference/routes/load-balancing.mdx @@ -70,7 +70,7 @@ ingress.pomerium.io/least_request_lb_config: '{"choice_count": 2}' See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more information. - + | **Config file keys** | **Type** | **Usage** | **Default** | | :------------------- | :------- | :----------- | :------------ | @@ -78,7 +78,7 @@ See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more info ### Examples {#examples-load-balancing-policy} -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/routes/pass-identity-headers.mdx b/content/docs/reference/routes/pass-identity-headers.mdx index f9d184d63..eb2271748 100644 --- a/content/docs/reference/routes/pass-identity-headers.mdx +++ b/content/docs/reference/routes/pass-identity-headers.mdx @@ -62,13 +62,13 @@ ingress.pomerium.io/pass_identity_headers: 'true' ``` - + | **Parameter namespace_id** | **Type** | **Usage** | **Default** | | :-- | :-- | :-- | :-- | | `pass_identity_headers` | Boolean | **optional** | `false` | -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/routes/path-matching.mdx b/content/docs/reference/routes/path-matching.mdx index 783acba6b..438d54fa4 100644 --- a/content/docs/reference/routes/path-matching.mdx +++ b/content/docs/reference/routes/path-matching.mdx @@ -54,7 +54,7 @@ Set **Path** under **Path Matching** settings in the Console: See Kubernetes [Ingress](/docs/deploy/k8s/ingress#regular-expressions-path-matching) for more information - + | **YAML**/**JSON** setting | **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -62,7 +62,7 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress#regular-expressions-path-match ### Examples {#examples-path} -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id @@ -129,7 +129,7 @@ spec: See Kubernetes [Ingress](/docs/deploy/k8s/ingress#annotations) for more information - + | **YAML**/**JSON** setting | **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -137,7 +137,7 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress#annotations) for more informat ### Examples {#examples-path} -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id @@ -204,7 +204,7 @@ spec: ``` - + | **Parameter name** | **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -212,7 +212,7 @@ spec: ### Examples {#examples-regex} -```yaml +```hcl regex = "^/(admin|superuser)/.*$" ``` diff --git a/content/docs/reference/routes/path-rewriting.mdx b/content/docs/reference/routes/path-rewriting.mdx index c0d6f175b..d60a673fa 100644 --- a/content/docs/reference/routes/path-rewriting.mdx +++ b/content/docs/reference/routes/path-rewriting.mdx @@ -86,7 +86,7 @@ Configure **Prefix Rewrite** in the Console: | `prefix_rewrite` | `string` | **optional** | - + | **Parameter name** | **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -94,7 +94,7 @@ Configure **Prefix Rewrite** in the Console: ### Examples {#examples-prefix-rewrite} -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id @@ -144,7 +144,7 @@ Set **Regex Rewrite** pattern and substitution in the Console: Kubernetes does not support **Regex Rewrite** - + | **Parameter name** | **Type** | **Usage** | | :--------------------------- | :------- | :----------- | @@ -153,7 +153,7 @@ Kubernetes does not support **Regex Rewrite** ### Examples {#examples-regex-rewrite} -```yaml +```hcl host_path_regex_rewrite_pattern = "^/service/([^/]+)(/.*)$" host_path_regex_rewrite_substitution = "\\2/instance/\\1" ``` diff --git a/content/docs/reference/routes/policy.mdx b/content/docs/reference/routes/policy.mdx index ff73d7dfb..ae0412516 100644 --- a/content/docs/reference/routes/policy.mdx +++ b/content/docs/reference/routes/policy.mdx @@ -80,7 +80,7 @@ ingress.pomerium.io/policy: | ``` - + | **Parameter name** | **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -88,7 +88,7 @@ ingress.pomerium.io/policy: | ### Examples -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/routes/regex-priority-order.mdx b/content/docs/reference/routes/regex-priority-order.mdx index 7a27a200f..0932e9a3a 100644 --- a/content/docs/reference/routes/regex-priority-order.mdx +++ b/content/docs/reference/routes/regex-priority-order.mdx @@ -49,7 +49,7 @@ Set **Regex Priority Order** in the Console: Kubernetes does not support **Regex Priority Order** - + | **Parameter name**| **Type** | **Usage** | | :------------------------ | :------- | :----------- | @@ -57,7 +57,7 @@ Kubernetes does not support **Regex Priority Order** ### Examples -```yaml +```hcl regex = "^/(admin|superuser)/.*$" regex_priority_order = 1 ``` diff --git a/content/docs/reference/routes/show-error-details.mdx b/content/docs/reference/routes/show-error-details.mdx index 0f35a1ec2..95e941df1 100644 --- a/content/docs/reference/routes/show-error-details.mdx +++ b/content/docs/reference/routes/show-error-details.mdx @@ -26,7 +26,7 @@ Enable **Show Error Details** on a route in the Console: ![Show error details](../branding/img/branding-show-error-details.png) - + | **Parameter name**| **Type** | **Default** | | :------------------------ | :------- | :----------- | @@ -34,7 +34,7 @@ Enable **Show Error Details** on a route in the Console: ### Examples -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/routes/timeouts.mdx b/content/docs/reference/routes/timeouts.mdx index fcdde627b..a6f28440d 100644 --- a/content/docs/reference/routes/timeouts.mdx +++ b/content/docs/reference/routes/timeouts.mdx @@ -66,7 +66,7 @@ ingress.pomerium.io/allow_websockets: 'true' ``` - + | **Parameter name** | **Type** | **Default** | | :----------------- | :------- | :---------- | @@ -74,7 +74,7 @@ ingress.pomerium.io/allow_websockets: 'true' ### Examples {#examples-websocket-connections} -```yaml +```hcl allow_websockets = true ``` @@ -123,7 +123,7 @@ ingress.pomerium.io/allow_spdy: 'true' See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more information. - + | **YAML**/**JSON** setting | **Type** | **Default** | | :------------------------ | :------- | :---------- | @@ -131,7 +131,7 @@ See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more info ### Examples {#examples-spdy} -```YAML +```hcl allow_spdy = true ``` @@ -178,7 +178,7 @@ ingress.pomerium.io/timeout: '30s' ``` - + | **Parameter name** | **Type** | **Usage** | **Default** | | :----------------- | :------- | :----------- | :---------- | @@ -186,7 +186,7 @@ ingress.pomerium.io/timeout: '30s' ### Examples {#examples-route-timeout} -```yaml +```hcl timeout = 30s ``` @@ -240,7 +240,7 @@ ingress.pomerium.io/idle_timeout: '5m' ``` - + | **Parameter name** | **Type** | **Usage** | **Default** | | :----------------- | :------- | :----------- | :---------- | @@ -248,7 +248,7 @@ ingress.pomerium.io/idle_timeout: '5m' ### Examples -```yaml +```hcl resource "pomerium_route" "verify_route" { name = "verify-route" namespace_id = pomerium_namespace.test_namespace.id from = "https://verify.localhost.pomerium.io" to = ["https://verify.pomerium.com"] policies = [pomerium_policy.test_policy.id] idle_timeout = 5m } ``` diff --git a/content/docs/reference/routes/tls.mdx b/content/docs/reference/routes/tls.mdx index 79013eb9f..09866b2db 100644 --- a/content/docs/reference/routes/tls.mdx +++ b/content/docs/reference/routes/tls.mdx @@ -63,7 +63,7 @@ Set the **TLS Client Certificate** under **TLS Settings** in the Console: See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for more information - + | **Parameter name** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -107,7 +107,7 @@ Set **TLS Custom Certificate Authority** in the Console: See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for more information - + | **Parameter name** | **Type** | **Usage** | | :-------------------------------------- | :------- | :----------- | @@ -191,7 +191,7 @@ Set **TLS Downstream Server Name** in the Console: Kubernetes does not support `tls_downstream_server_name` - + | **Parameter name** | **Type** | **Usage** | | :-- | :-- | :-- | @@ -244,7 +244,7 @@ ingress.pomerium.io/tls_skip_verify: 'true' ``` - + | **Parameter name** | **Type** | **Default** | | :------------------------ | :-------- | :---------- | @@ -252,7 +252,7 @@ ingress.pomerium.io/tls_skip_verify: 'true' ### Examples {#examples-tls-skip-verification} -```yaml +```hcl tls_skip_verify = true ``` @@ -297,7 +297,7 @@ Enable **TLS Upstream Allow Renegotiation** in the Console: Kubernetes does not support **TLS Upstream Allow Renegotiation** - + | **Parameter name** | **Type** | **Default** | | :--------------------------------- | :-------- | :---------- | @@ -305,7 +305,7 @@ Kubernetes does not support **TLS Upstream Allow Renegotiation** ### Examples {#examples-tls-upstream-allow-renegotiation} -```yaml +```hcl tls_upstream_allow_renegotiation = true ``` @@ -338,7 +338,7 @@ Set **TLS Upstream Server Name** in the Console: Kubernetes does not support `tls_upstream_server_name` - + | **Parameter name** | **Type** | **Usage** | | :-- | :-- | :-- | diff --git a/content/docs/reference/routes/to.mdx b/content/docs/reference/routes/to.mdx index b67912c84..63a2773a8 100644 --- a/content/docs/reference/routes/to.mdx +++ b/content/docs/reference/routes/to.mdx @@ -56,7 +56,7 @@ Set **To** in the Console: See Kubernetes [Ingress](/docs/deploy/k8s/ingress) for more information. - + | **Parameter name** | **Type** | **Usage** | **Schemes** | | :-- | :-- | :-- | :-- | @@ -64,7 +64,7 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress) for more information. ### Examples -```yaml +```hcl resource "pomerium_route" "example_route" { name = "example-route" namespace_id = pomerium_namespace.test_namespace.id diff --git a/content/docs/reference/service-urls.md b/content/docs/reference/service-urls.md index a44f3d4b9..220172117 100644 --- a/content/docs/reference/service-urls.md +++ b/content/docs/reference/service-urls.md @@ -79,7 +79,7 @@ AUTHENTICATE_SERVICE_URL=https://authenticate.corp.example.com -| **[Parameter name](/docs/deploy/k8s/reference#spec** | **Type** | **Usage** | +| **[Parameter name](/docs/deploy/k8s/reference#spec)** | **Type** | **Usage** | | :-- | :-- | :-- | | `authenticate.url` | `URL` | **optional** | @@ -93,17 +93,18 @@ authenticate: See the [Kubernetes - Global Configuration](/docs/deploy/k8s/configure#authenticate-endpoint) for more information. - + -| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings) | **Type** | **Usage** | +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `authenticate_service_url` | `URL` | **optional** | ### Examples -```yaml +```hcl authenticate_service_url = "https://authenticate.corp.example.com" ``` + @@ -194,7 +195,7 @@ AUTHORIZE_SERVICE_URL=https://pomerium-authorize-service.default.svc.cluster.loc The `authorize_service_url` is not customizable in all-in-one mode with the CRD - + | [Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings) | **Type** | **Usage** | | :-- | :-- | :-- | @@ -202,9 +203,10 @@ The `authorize_service_url` is not customizable in all-in-one mode with the CRD ### Examples -```yaml +```hcl authorize_service_url = "https://localhost:5443" ``` + @@ -221,7 +223,7 @@ If included, Authorize Internal Service URL will override Authorize Service URL. | **Config file keys** | **Environment variables** | **Type** | **Usage** | | :-- | :-- | :-- | :-- | -| `authorize_internal_service_url` | `AUTHORIZE_INTERNAL_SERVICE_URL` | `URL` | **required** (Inferred in all-in-one mode to be localhost)| +| `authorize_internal_service_url` | `AUTHORIZE_INTERNAL_SERVICE_URL` | `URL` | **required** (Inferred in all-in-one mode to be localhost) | ### Examples @@ -283,7 +285,7 @@ DATABROKER_SERVICE_URL=https://databroker.corp.example.com `databroker_service_url` is not customizable in Kubernetes for all-in-one mode deployments - + | [Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings) | **Type** | **Usage** | | :-- | :-- | :-- | @@ -291,9 +293,10 @@ DATABROKER_SERVICE_URL=https://databroker.corp.example.com ### Examples -```yaml +```hcl databroker_service_url = "http://databroker.corp.example1.com" ``` + diff --git a/content/docs/reference/set-response-headers.mdx b/content/docs/reference/set-response-headers.mdx index e20580cc5..11443466e 100644 --- a/content/docs/reference/set-response-headers.mdx +++ b/content/docs/reference/set-response-headers.mdx @@ -68,7 +68,7 @@ ingress.pomerium.io/set_response_headers: | ``` - + | **[Annotation name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -76,7 +76,7 @@ ingress.pomerium.io/set_response_headers: | ### Examples -```yaml +```hcl set_response_headers = {"X-Test": "X-Value", "X-Test2": "X-Value2"} ``` diff --git a/content/docs/reference/x-forwarded-for-settings.mdx b/content/docs/reference/x-forwarded-for-settings.mdx index 6ced5229b..30e446351 100644 --- a/content/docs/reference/x-forwarded-for-settings.mdx +++ b/content/docs/reference/x-forwarded-for-settings.mdx @@ -68,7 +68,7 @@ Configure **X-Forward-For HTTP Header** with the toggle button in the Console. T Kubernetes does not support `skip_xff_append` - + | **[Annotation name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | @@ -76,7 +76,7 @@ Kubernetes does not support `skip_xff_append` ### Examples -```yaml +```hcl skip_xff_append = true ``` From 795e17600d7e02e997b775a898c604ef3fca36f9 Mon Sep 17 00:00:00 2001 From: Svetlana Rekuts Date: Thu, 27 Mar 2025 18:46:54 +0000 Subject: [PATCH 5/6] Apply `yarn format` --- content/docs/reference/access-log-fields.mdx | 1 - content/docs/reference/address.mdx | 1 + .../docs/reference/authorize-log-fields.mdx | 1 + content/docs/reference/autocert.mdx | 4 ++ content/docs/reference/certificates.mdx | 1 + content/docs/reference/cookies.mdx | 6 +++ content/docs/reference/dns-lookup-family.mdx | 2 + content/docs/reference/global-timeouts.mdx | 3 ++ ...verless-authentication-service-account.mdx | 2 + content/docs/reference/grpc.mdx | 6 ++- .../docs/reference/http-redirect-address.mdx | 2 + .../reference/identity-provider-settings.mdx | 16 +++++++- content/docs/reference/insecure-server.mdx | 2 + .../docs/reference/pass-identity-headers.mdx | 1 + ...google-cloud-serverless-authentication.mdx | 4 +- content/docs/reference/routes/from.mdx | 6 +-- content/docs/reference/routes/headers.mdx | 39 ++++++++++--------- .../identity-provider-client-id-per-route.mdx | 5 ++- ...ntity-provider-client-secret-per-route.mdx | 7 ++-- .../reference/routes/jwt-issuer-format.mdx | 7 ++-- .../kubernetes-service-account-token.mdx | 8 ++-- .../routes/load-balancing-policy-config.mdx | 7 ++-- .../docs/reference/routes/load-balancing.mdx | 6 +-- .../routes/pass-identity-headers.mdx | 7 ++-- .../docs/reference/routes/path-matching.mdx | 8 ++-- .../docs/reference/routes/path-rewriting.mdx | 12 +++--- content/docs/reference/routes/policy.mdx | 6 +-- .../reference/routes/regex-priority-order.mdx | 6 +-- .../reference/routes/show-error-details.mdx | 10 +++-- content/docs/reference/routes/tls.mdx | 36 ++++++++--------- content/docs/reference/routes/to.mdx | 1 + 31 files changed, 135 insertions(+), 88 deletions(-) diff --git a/content/docs/reference/access-log-fields.mdx b/content/docs/reference/access-log-fields.mdx index b50a2f49b..b53bba7f2 100644 --- a/content/docs/reference/access-log-fields.mdx +++ b/content/docs/reference/access-log-fields.mdx @@ -101,7 +101,6 @@ accessLogFields: access_log_fields = ["authority", "duration", "path"] ``` - **Custom headers example** ```hcl diff --git a/content/docs/reference/address.mdx b/content/docs/reference/address.mdx index 0161373c4..d457c27fb 100644 --- a/content/docs/reference/address.mdx +++ b/content/docs/reference/address.mdx @@ -67,5 +67,6 @@ ADDRESS=:8443 ```hcl address = ":8433" ``` + diff --git a/content/docs/reference/authorize-log-fields.mdx b/content/docs/reference/authorize-log-fields.mdx index 705138840..fa1d7a5d9 100644 --- a/content/docs/reference/authorize-log-fields.mdx +++ b/content/docs/reference/authorize-log-fields.mdx @@ -103,6 +103,7 @@ authorizeLogFields: ```hcl authorize_log_fields = ["request-id", "path", "ip"] ``` + diff --git a/content/docs/reference/autocert.mdx b/content/docs/reference/autocert.mdx index 6f76764dd..e05b9605b 100644 --- a/content/docs/reference/autocert.mdx +++ b/content/docs/reference/autocert.mdx @@ -12,6 +12,7 @@ keywords: pagination_prev: null pagination_next: null --- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -72,6 +73,7 @@ autocert: true ```bash AUTOCERT=TRUE ``` + @@ -84,6 +86,7 @@ AUTOCERT=TRUE ```hcl autocert = true ``` + @@ -118,6 +121,7 @@ AUTOCERT_CA=https://acme.zerossl.com/v2/DV90 **Autocert Directory** is the path where [Autocert](/docs/reference/autocert) stores X.509 certificate data. ### How to configure {#autocert-directory-how-to-configure} + diff --git a/content/docs/reference/certificates.mdx b/content/docs/reference/certificates.mdx index a3879b28a..44c2ab460 100644 --- a/content/docs/reference/certificates.mdx +++ b/content/docs/reference/certificates.mdx @@ -179,5 +179,6 @@ Kubernetes does not support `certificate_authority` certificate_authority = "base64-encoded-string" certificate_authority_file = "/relative/file/location" ``` + diff --git a/content/docs/reference/cookies.mdx b/content/docs/reference/cookies.mdx index b0c8f0b79..d3fc7e207 100644 --- a/content/docs/reference/cookies.mdx +++ b/content/docs/reference/cookies.mdx @@ -76,6 +76,7 @@ cookie: ```hcl cookie_name = "cookie_name" ``` + @@ -132,6 +133,7 @@ See Kubernetes [bootstrap secrets](/docs/deploy/k8s/configure#bootstrap-secrets) ```hcl cookie_secret = "tdkuWzUelRukP/6VYzopfh6kis7y5u5Ldl3MrIq9ZR0=" ``` + @@ -191,6 +193,7 @@ cookie: ```hcl cookie_domain = "localhost.pomerium.io" ``` + @@ -241,6 +244,7 @@ Configure **Cookie HTTP Only** with the **Javascript Security** toggle button in cookie: httpOnly: false ``` + @@ -253,6 +257,7 @@ cookie: ```hcl cookie_http_only = false ``` + @@ -310,6 +315,7 @@ cookie: ```hcl cookie_expire = "13h15m0.5s" ``` + diff --git a/content/docs/reference/dns-lookup-family.mdx b/content/docs/reference/dns-lookup-family.mdx index 6e82ec206..113fae509 100644 --- a/content/docs/reference/dns-lookup-family.mdx +++ b/content/docs/reference/dns-lookup-family.mdx @@ -57,11 +57,13 @@ Kubernetes does not support `dns_lookup_family` | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | | `dns_lookup_family` | String | `V4_PREFERRED` | + ### Examples ```hcl default_lookup_family = "AUTO" ``` + diff --git a/content/docs/reference/global-timeouts.mdx b/content/docs/reference/global-timeouts.mdx index 879b05a8b..cc6f28284 100644 --- a/content/docs/reference/global-timeouts.mdx +++ b/content/docs/reference/global-timeouts.mdx @@ -79,6 +79,7 @@ timeouts: ```hcl timeout_read = "30s" ``` + @@ -138,6 +139,7 @@ timeouts: ```hcl timeout_write = "0" ``` + @@ -197,6 +199,7 @@ timeouts: ```hcl timeout_idle = "5m" ``` + diff --git a/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx b/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx index 768ecb334..2732177c8 100644 --- a/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx +++ b/content/docs/reference/google-cloud-serverless-authentication-service-account.mdx @@ -58,10 +58,12 @@ Kubernetes does not support `google_cloud_serverless_authentication_service_acco | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `google_cloud_serverless_authentication_service_account ` | String | **optional** | + ### Examples ```hcl google_cloud_serverless_authentication_service_account = "base64-encoded-service-account-credentials" ``` + diff --git a/content/docs/reference/grpc.mdx b/content/docs/reference/grpc.mdx index 8fc537f96..94b75766b 100644 --- a/content/docs/reference/grpc.mdx +++ b/content/docs/reference/grpc.mdx @@ -63,11 +63,13 @@ GRPC_ADDRESS=:8443 | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | | `grpc_address` | String | `:5443` in all-in-one mode
`:443` in [split service mode] | + ### Examples ```hcl grpc_address = ":8443" ``` + @@ -145,12 +147,14 @@ GRPC_INSECURE=false | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | -| `grpc_insecure` | Boolean | `true` in all-in-one mode
`false` in [split service mode] | +| `grpc_insecure` | Boolean | `true` in all-in-one mode
`false` in [split service mode] | + ### Examples ```hcl grpc_insecure = false ``` + diff --git a/content/docs/reference/http-redirect-address.mdx b/content/docs/reference/http-redirect-address.mdx index d753f148b..bb4339428 100644 --- a/content/docs/reference/http-redirect-address.mdx +++ b/content/docs/reference/http-redirect-address.mdx @@ -55,10 +55,12 @@ Set **HTTP Redirect Address** in the Console: ![Set HTTP redirect address in the | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Default** | | :-- | :-- | :-- | | `http_redirect_addr` | String | **optional** | + ### Examples ```hcl http_redirect_addr = ":80" ``` + diff --git a/content/docs/reference/identity-provider-settings.mdx b/content/docs/reference/identity-provider-settings.mdx index 3ddd1fe91..225985714 100644 --- a/content/docs/reference/identity-provider-settings.mdx +++ b/content/docs/reference/identity-provider-settings.mdx @@ -78,11 +78,13 @@ See [`identityProvider.secret`](/docs/deploy/k8s/reference#identityprovider) | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_client_id` | String | **required** (if self-hosting) | + ### Examples ```hcl idp_client_id = idp_client_id ``` + @@ -127,11 +129,13 @@ See [`identityProvider.secret`](/docs/deploy/k8s/reference#identityprovider) for | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_client_secret` | String | **required** (unless using [idp_client_secret_file](#identity-provider-client-secret-file)) | + ### Examples ```hcl idp_client_secret = idp_client_secret ``` + @@ -230,11 +234,13 @@ See [`identityProvider.provider`](/docs/deploy/k8s/reference#identityprovider) f | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_provider` | String | **required** (if [self-hosting](/docs/capabilities/authentication)) | + ### Examples ```hcl idp_provider = "auth0" ``` + @@ -282,11 +288,13 @@ See Kubernetes [`identityProvider.requestParams` and `identityProvider.requestPa | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `request_params` | Map of String | **optional** | + ### Examples ```hcl -request_params = {"client_id": "client_id", "response_type": "response_type", "redirect_uri": "redirect_uri"} +request_params = {"client_id": "client_id", "response_type": "response_type", "redirect_uri": "redirect_uri"} ``` + @@ -364,11 +372,13 @@ See Kubernetes [`identityProvider.scopes`](/docs/deploy/k8s/reference#identitypr | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `scopes` | Set of String | **optional** | + ### Examples ```hcl -scopes = ["openid", "profile", "offline_access", "email"] +scopes = ["openid", "profile", "offline_access", "email"] ``` + @@ -424,11 +434,13 @@ See Kubernetes [`identityProvider.url`](/docs/deploy/k8s/reference#identityprovi | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `idp_provider_url` | String | **required** (depending on identity provider) | + ### Examples ```hcl idp_provider_url = "https://awesome-company.auth0.com" ``` + diff --git a/content/docs/reference/insecure-server.mdx b/content/docs/reference/insecure-server.mdx index 6ae5a3ac9..fd9ce021d 100644 --- a/content/docs/reference/insecure-server.mdx +++ b/content/docs/reference/insecure-server.mdx @@ -63,10 +63,12 @@ Kubernetes does not support **Insecure Server** | **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | | :-- | :-- | :-- | | `insecure_server` | Boolean | **required** (if [certificates](/docs/reference/certificates) unset) | + ### Examples ```hcl insecure_server = true ``` + diff --git a/content/docs/reference/pass-identity-headers.mdx b/content/docs/reference/pass-identity-headers.mdx index c8292c3ac..3709fd570 100644 --- a/content/docs/reference/pass-identity-headers.mdx +++ b/content/docs/reference/pass-identity-headers.mdx @@ -84,6 +84,7 @@ See [Kubernetes - Global Configuration](/docs/deploy/k8s/configure) for more inf ```hcl pass_identity_headers = true ``` + diff --git a/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx b/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx index 14def25f3..1cae5cee7 100644 --- a/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx +++ b/content/docs/reference/routes/enable-google-cloud-serverless-authentication.mdx @@ -54,11 +54,11 @@ Kubernetes does not support **Enable Google Cloud Serverless Authentication** -| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/settings)** | **Type** | **Usage** | **Default** | | :-- | :-- | :-- | :-- | | `enable_google_cloud_serverless_authentication` | Boolean | **optional** | `false` | -#### Examples +#### Examples ```hcl enable_google_cloud_serverless_authentication = true diff --git a/content/docs/reference/routes/from.mdx b/content/docs/reference/routes/from.mdx index f47713599..58af4dd1a 100644 --- a/content/docs/reference/routes/from.mdx +++ b/content/docs/reference/routes/from.mdx @@ -97,11 +97,11 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress) for more information. -| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/route)** | **Type** | **Usage** | +| **[Parameter name](https://registry.terraform.io/providers/pomerium/pomerium/latest/docs/resources/route)** | **Type** | **Usage** | | :-- | :-- | :-- | -| `from` | String | **required** | +| `from` | String | **required** | -#### Examples +#### Examples ```hcl resource "pomerium_route" "verify_route" { diff --git a/content/docs/reference/routes/headers.mdx b/content/docs/reference/routes/headers.mdx index e2a6fdf3f..028af1f58 100644 --- a/content/docs/reference/routes/headers.mdx +++ b/content/docs/reference/routes/headers.mdx @@ -113,11 +113,11 @@ ingress.pomerium.io/host_rewrite: 'example.com' -| **Parameter name** | **Type** | **Usage** | -| :-- | :-- | :-- | -| `host_rewrite` | `String` | **optional** | -| `host_rewrite_header` | `String` | **optional** | -| `host_path_regex_rewrite_pattern` | `String` | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :------------------------------------- | :------- | :----------- | +| `host_rewrite` | `String` | **optional** | +| `host_rewrite_header` | `String` | **optional** | +| `host_path_regex_rewrite_pattern` | `String` | **optional** | | `host_path_regex_rewrite_substitution` | `String` | **optional** | ### Examples @@ -212,8 +212,8 @@ ingress.pomerium.io/set_request_headers: | -| **Parameter name** | **Type** | **Usage** | -| :-- | :-- | :-- | +| **Parameter name** | **Type** | **Usage** | +| :-------------------- | :------------ | :----------- | | `set_request_headers` | Map of String | **optional** | ### Examples @@ -224,9 +224,10 @@ resource "pomerium_route" "verify_route" { namespace_id = pomerium_namespace.test_namespace.id from = "https://verify.localhost.pomerium.io" to = ["https://verify.pomerium.com"] - set_request_headers = {"Pomerium-jwt": "$${pomerium.jwt}", "X-Your-favorite-authenticating-Proxy": "Pomerium"} + set_request_headers = {"Pomerium-jwt": "$${pomerium.jwt}", "X-Your-favorite-authenticating-Proxy": "Pomerium"} } ``` + @@ -302,8 +303,8 @@ ingress.pomerium.io/remove_request_headers: | -| **YAML**/**JSON** setting | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------ | :------------ | :----------- | | `remove_request_headers` | Set of String | **optional** | ### Examples {#examples-remove-request-headers} @@ -314,7 +315,7 @@ resource "pomerium_route" "verify_route" { namespace_id = pomerium_namespace.test_namespace.id from = "https://verify.localhost.pomerium.io" to = ["https://verify.pomerium.com"] - remove_request_headers = ["X-Email", "X-User"] + remove_request_headers = ["X-Email", "X-User"] } ``` @@ -363,9 +364,9 @@ ingress.pomerium.io/set_response_headers: | -| **YAML**/**JSON** setting | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `set_response_headers` | Map of String | **optional** | +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------ | :------------ | :----------- | +| `set_response_headers` | Map of String | **optional** | ### Examples {#examples-remove-request-headers} @@ -375,7 +376,7 @@ resource "pomerium_route" "verify_route" { namespace_id = pomerium_namespace.test_namespace.id from = "https://verify.localhost.pomerium.io" to = ["https://verify.pomerium.com"] - set_response_headers = {"X-Test": "X-Value"} + set_response_headers = {"X-Test": "X-Value"} } ``` @@ -450,9 +451,9 @@ The browser would be redirected to: `http://frontend/one/some/path/`. This is si -| **YAML**/**JSON** setting | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `rewrite_response_headers` | Map of String | **optional** | +| **YAML**/**JSON** setting | **Type** | **Usage** | +| :------------------------- | :------------ | :----------- | +| `rewrite_response_headers` | Map of String | **optional** | ### Examples {#examples-remove-request-headers} @@ -462,7 +463,7 @@ resource "pomerium_route" "verify_route" { namespace_id = pomerium_namespace.test_namespace.id from = "https://verify.localhost.pomerium.io" to = ["https://verify.pomerium.com"] - rewrite_response_headers = {"X-Test": "X-New-Value"} + rewrite_response_headers = {"X-Test": "X-New-Value"} } ``` diff --git a/content/docs/reference/routes/identity-provider-client-id-per-route.mdx b/content/docs/reference/routes/identity-provider-client-id-per-route.mdx index 211482d43..c58fa5bb7 100644 --- a/content/docs/reference/routes/identity-provider-client-id-per-route.mdx +++ b/content/docs/reference/routes/identity-provider-client-id-per-route.mdx @@ -52,8 +52,8 @@ Kubernetes does not support `idp_client_id` (per route) | **Parameter name** | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `idp_client_id` | `String` | **optional** | +| :----------------- | :------- | :----------- | +| `idp_client_id` | `String` | **optional** | ### Examples @@ -66,5 +66,6 @@ resource "pomerium_route" "verify_route" { idp_client_id = idp_client_id } ``` + diff --git a/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx b/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx index a690d1df6..42397ed19 100644 --- a/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx +++ b/content/docs/reference/routes/identity-provider-client-secret-per-route.mdx @@ -51,9 +51,9 @@ Kubernetes does not support `idp_client_secret` (per route) -| **Parameter name** | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `idp_client_secret` | `String` | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :------------------ | :------- | :----------- | +| `idp_client_secret` | `String` | **optional** | ### Examples @@ -66,5 +66,6 @@ resource "pomerium_route" "verify_route" { idp_client_secret = idp_client_secret } ``` + diff --git a/content/docs/reference/routes/jwt-issuer-format.mdx b/content/docs/reference/routes/jwt-issuer-format.mdx index f7faf6161..56c7b30e9 100644 --- a/content/docs/reference/routes/jwt-issuer-format.mdx +++ b/content/docs/reference/routes/jwt-issuer-format.mdx @@ -45,14 +45,15 @@ jwt_issuer_format: uri -| **Parameter name** | **Type** | **Default** | -| :------------------------ | :------- | :----------- | -| `jwt_issuer_format` | String | `hostOnly` | +| **Parameter name** | **Type** | **Default** | +| :------------------ | :------- | :---------- | +| `jwt_issuer_format` | String | `hostOnly` | ### Examples ```hcl jwt_issuer_format = uri ``` + diff --git a/content/docs/reference/routes/kubernetes-service-account-token.mdx b/content/docs/reference/routes/kubernetes-service-account-token.mdx index 03f6bb78a..a30a12091 100644 --- a/content/docs/reference/routes/kubernetes-service-account-token.mdx +++ b/content/docs/reference/routes/kubernetes-service-account-token.mdx @@ -55,10 +55,10 @@ This option is not supported in Kubernetes. -| **Parameter name** | **Type** | **Usage** | -| :-- | :-- | :-- | -| `kubernetes_service_account_token` | String | **optional** | -| `kubernetes_service_account_token_file` | String | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :-------------------------------------- | :------- | :----------- | +| `kubernetes_service_account_token` | String | **optional** | +| `kubernetes_service_account_token_file` | String | **optional** | ### Examples diff --git a/content/docs/reference/routes/load-balancing-policy-config.mdx b/content/docs/reference/routes/load-balancing-policy-config.mdx index 339d287f9..bde1d17d5 100644 --- a/content/docs/reference/routes/load-balancing-policy-config.mdx +++ b/content/docs/reference/routes/load-balancing-policy-config.mdx @@ -45,10 +45,9 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress#load-balancing) for more infor -| **Config file keys** | **Type** | **Options** | -| :-- | :-- | :-- | -| `load_balancing_policy` | String | `least_request`, `ring_hash`, `maglev` | - +| **Config file keys** | **Type** | **Options** | +| :---------------------- | :------- | :------------------------------------- | +| `load_balancing_policy` | String | `least_request`, `ring_hash`, `maglev` | diff --git a/content/docs/reference/routes/load-balancing.mdx b/content/docs/reference/routes/load-balancing.mdx index c8444ee01..a1f808bbc 100644 --- a/content/docs/reference/routes/load-balancing.mdx +++ b/content/docs/reference/routes/load-balancing.mdx @@ -72,9 +72,9 @@ See [Kubernetes - Ingress Configuration](/docs/deploy/k8s/ingress) for more info -| **Config file keys** | **Type** | **Usage** | **Default** | -| :------------------- | :------- | :----------- | :------------ | -| `load_balancing_policy` | String | **optional** | `round_robin` | +| **Config file keys** | **Type** | **Usage** | **Default** | +| :---------------------- | :------- | :----------- | :------------ | +| `load_balancing_policy` | String | **optional** | `round_robin` | ### Examples {#examples-load-balancing-policy} diff --git a/content/docs/reference/routes/pass-identity-headers.mdx b/content/docs/reference/routes/pass-identity-headers.mdx index eb2271748..6b8c9d0a5 100644 --- a/content/docs/reference/routes/pass-identity-headers.mdx +++ b/content/docs/reference/routes/pass-identity-headers.mdx @@ -64,9 +64,9 @@ ingress.pomerium.io/pass_identity_headers: 'true' -| **Parameter namespace_id** | **Type** | **Usage** | **Default** | -| :-- | :-- | :-- | :-- | -| `pass_identity_headers` | Boolean | **optional** | `false` | +| **Parameter namespace_id** | **Type** | **Usage** | **Default** | +| :------------------------- | :------- | :----------- | :---------- | +| `pass_identity_headers` | Boolean | **optional** | `false` | ```hcl resource "pomerium_route" "verify_route" { @@ -77,5 +77,6 @@ resource "pomerium_route" "verify_route" { pass_identity_headers = true } ``` + diff --git a/content/docs/reference/routes/path-matching.mdx b/content/docs/reference/routes/path-matching.mdx index 438d54fa4..eb0750521 100644 --- a/content/docs/reference/routes/path-matching.mdx +++ b/content/docs/reference/routes/path-matching.mdx @@ -58,7 +58,7 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress#regular-expressions-path-match | **YAML**/**JSON** setting | **Type** | **Usage** | | :------------------------ | :------- | :----------- | -| `path` | String | **optional** | +| `path` | String | **optional** | ### Examples {#examples-path} @@ -133,7 +133,7 @@ See Kubernetes [Ingress](/docs/deploy/k8s/ingress#annotations) for more informat | **YAML**/**JSON** setting | **Type** | **Usage** | | :------------------------ | :------- | :----------- | -| `prefix` | String | **optional** | +| `prefix` | String | **optional** | ### Examples {#examples-path} @@ -207,8 +207,8 @@ spec: | **Parameter name** | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `regex` | String | **optional** | +| :----------------- | :------- | :----------- | +| `regex` | String | **optional** | ### Examples {#examples-regex} diff --git a/content/docs/reference/routes/path-rewriting.mdx b/content/docs/reference/routes/path-rewriting.mdx index d60a673fa..2bc867d73 100644 --- a/content/docs/reference/routes/path-rewriting.mdx +++ b/content/docs/reference/routes/path-rewriting.mdx @@ -89,8 +89,8 @@ Configure **Prefix Rewrite** in the Console: | **Parameter name** | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `prefix_rewrite` | String | **optional** | +| :----------------- | :------- | :----------- | +| `prefix_rewrite` | String | **optional** | ### Examples {#examples-prefix-rewrite} @@ -146,10 +146,10 @@ Kubernetes does not support **Regex Rewrite** -| **Parameter name** | **Type** | **Usage** | -| :--------------------------- | :------- | :----------- | -| `host_path_regex_rewrite_pattern` | String | **optional** | -| `host_path_regex_rewrite_substitution ` | String | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :-------------------------------------- | :------- | :----------- | +| `host_path_regex_rewrite_pattern` | String | **optional** | +| `host_path_regex_rewrite_substitution ` | String | **optional** | ### Examples {#examples-regex-rewrite} diff --git a/content/docs/reference/routes/policy.mdx b/content/docs/reference/routes/policy.mdx index ae0412516..2b9af84f0 100644 --- a/content/docs/reference/routes/policy.mdx +++ b/content/docs/reference/routes/policy.mdx @@ -82,9 +82,9 @@ ingress.pomerium.io/policy: | -| **Parameter name** | **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `policies ` | Set of String | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :----------------- | :------------ | :----------- | +| `policies ` | Set of String | **optional** | ### Examples diff --git a/content/docs/reference/routes/regex-priority-order.mdx b/content/docs/reference/routes/regex-priority-order.mdx index 0932e9a3a..53c44a5dc 100644 --- a/content/docs/reference/routes/regex-priority-order.mdx +++ b/content/docs/reference/routes/regex-priority-order.mdx @@ -51,9 +51,9 @@ Kubernetes does not support **Regex Priority Order** -| **Parameter name**| **Type** | **Usage** | -| :------------------------ | :------- | :----------- | -| `regex_priority_order` | Number | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :--------------------- | :------- | :----------- | +| `regex_priority_order` | Number | **optional** | ### Examples diff --git a/content/docs/reference/routes/show-error-details.mdx b/content/docs/reference/routes/show-error-details.mdx index 95e941df1..d945cf52d 100644 --- a/content/docs/reference/routes/show-error-details.mdx +++ b/content/docs/reference/routes/show-error-details.mdx @@ -17,6 +17,7 @@ import TabItem from '@theme/TabItem'; If true, **Show Error Details** allows you apply your custom [error message header](/docs/reference/branding) to a route. ## How to configure + ### Examples @@ -28,9 +29,9 @@ Enable **Show Error Details** on a route in the Console: -| **Parameter name**| **Type** | **Default** | -| :------------------------ | :------- | :----------- | -| `show_error_details ` | Boolean | `false`| +| **Parameter name** | **Type** | **Default** | +| :-------------------- | :------- | :---------- | +| `show_error_details ` | Boolean | `false` | ### Examples @@ -44,5 +45,6 @@ resource "pomerium_route" "verify_route" { show_error_details = true } ``` + - \ No newline at end of file + diff --git a/content/docs/reference/routes/tls.mdx b/content/docs/reference/routes/tls.mdx index 09866b2db..a54822c9e 100644 --- a/content/docs/reference/routes/tls.mdx +++ b/content/docs/reference/routes/tls.mdx @@ -65,9 +65,9 @@ See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for -| **Parameter name** | **Type** | **Usage** | -| :-- | :-- | :-- | -| `tls_client_key_pair_id ` | String | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :------------------------ | :------- | :----------- | +| `tls_client_key_pair_id ` | String | **optional** | @@ -109,9 +109,9 @@ See Kubernetes [TLS Certificates](/docs/deploy/k8s/ingress#tls-certificates) for -| **Parameter name** | **Type** | **Usage** | -| :-------------------------------------- | :------- | :----------- | -| `tls_custom_ca_key_pair_id` | String | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :-------------------------- | :------- | :----------- | +| `tls_custom_ca_key_pair_id` | String | **optional** | @@ -193,9 +193,9 @@ Kubernetes does not support `tls_downstream_server_name` -| **Parameter name** | **Type** | **Usage** | -| :-- | :-- | :-- | -| `tls_downstream_server_name` | String | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :--------------------------- | :------- | :----------- | +| `tls_downstream_server_name` | String | **optional** | @@ -246,9 +246,9 @@ ingress.pomerium.io/tls_skip_verify: 'true' -| **Parameter name** | **Type** | **Default** | -| :------------------------ | :-------- | :---------- | -| `tls_skip_verify` | Boolean | `false` | +| **Parameter name** | **Type** | **Default** | +| :----------------- | :------- | :---------- | +| `tls_skip_verify` | Boolean | `false` | ### Examples {#examples-tls-skip-verification} @@ -299,9 +299,9 @@ Kubernetes does not support **TLS Upstream Allow Renegotiation** -| **Parameter name** | **Type** | **Default** | -| :--------------------------------- | :-------- | :---------- | -| `tls_upstream_allow_renegotiation` | Boolean | `false` | +| **Parameter name** | **Type** | **Default** | +| :--------------------------------- | :------- | :---------- | +| `tls_upstream_allow_renegotiation` | Boolean | `false` | ### Examples {#examples-tls-upstream-allow-renegotiation} @@ -340,9 +340,9 @@ Kubernetes does not support `tls_upstream_server_name` -| **Parameter name** | **Type** | **Usage** | -| :-- | :-- | :-- | -| `tls_upstream_server_name` | String | **optional** | +| **Parameter name** | **Type** | **Usage** | +| :------------------------- | :------- | :----------- | +| `tls_upstream_server_name` | String | **optional** | diff --git a/content/docs/reference/routes/to.mdx b/content/docs/reference/routes/to.mdx index 63a2773a8..2b8721b59 100644 --- a/content/docs/reference/routes/to.mdx +++ b/content/docs/reference/routes/to.mdx @@ -72,6 +72,7 @@ resource "pomerium_route" "example_route" { to = ["https://a.example.com", "https://b.example.com", "https://c.example.com"] } ``` + From 294549c29613629039392281791f14590e685899 Mon Sep 17 00:00:00 2001 From: Svetlana Rekuts Date: Fri, 28 Mar 2025 16:43:07 +0000 Subject: [PATCH 6/6] Add `Enterprise via Terraform` to the logo-url --- content/docs/reference/routes/logo-url.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/content/docs/reference/routes/logo-url.mdx b/content/docs/reference/routes/logo-url.mdx index dd43e0b3b..1e15ea957 100644 --- a/content/docs/reference/routes/logo-url.mdx +++ b/content/docs/reference/routes/logo-url.mdx @@ -41,5 +41,12 @@ Set the route **logo URL** under **General** route settings in the Console: | :-- | :-- | :-- | | `logo_url` | `string` | **optional** | + + + +| **Parameter name** | **Type** | **Usage** | +| :----------------- | :------- | :----------- | +| `logo_url` | String | **optional** | +