Docs: remove optn settings for certs and cookiesec

pomerium · Nov 21, 2022 · 22ed832 · 22ed832
1 parent a82f80f
commit 22ed832
Show file tree

Hide file tree

Showing 68 changed files with 5,381 additions and 6,015 deletions.
diff --git a/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE b/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE
diff --git a/.github/ISSUE_TEMPLATE/doc-error.md b/.github/ISSUE_TEMPLATE/doc-error.md
@@ -4,6 +4,7 @@ about: Report a problem with existing documentation
 labels: Fix Content
 ---
 
+
 <!--- ** Partial or incorrectly filled out issues may be deferred.--->
 
 Page: https://www.pomerium.com/docs/${page}

diff --git a/.gitignore b/.gitignore
@@ -23,5 +23,3 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
-package-lock.json
diff --git a/content/docs/enterprise/branding.md b/content/docs/enterprise/branding.md
diff --git a/content/docs/enterprise/branding/colors.md b/content/docs/enterprise/branding/colors.md
diff --git a/content/docs/enterprise/branding/error_details.md b/content/docs/enterprise/branding/error_details.md
diff --git a/content/docs/enterprise/branding/img/branded_colors_console.png b/content/docs/enterprise/branding/img/branded_colors_console.png
diff --git a/content/docs/enterprise/branding/img/branded_colors_darkmode_console.png b/content/docs/enterprise/branding/img/branded_colors_darkmode_console.png
diff --git a/content/docs/enterprise/branding/img/branded_colors_error_details.png b/content/docs/enterprise/branding/img/branded_colors_error_details.png
diff --git a/content/docs/enterprise/branding/img/enable_error_details.png b/content/docs/enterprise/branding/img/enable_error_details.png
diff --git a/content/docs/enterprise/branding/img/error_details_enabled.png b/content/docs/enterprise/branding/img/error_details_enabled.png
diff --git a/content/docs/enterprise/branding/img/first_paragraph_setting.png b/content/docs/enterprise/branding/img/first_paragraph_setting.png
diff --git a/content/docs/enterprise/branding/img/includes_first_paragraph.png b/content/docs/enterprise/branding/img/includes_first_paragraph.png
diff --git a/content/docs/enterprise/branding/img/no_branding_settings.png b/content/docs/enterprise/branding/img/no_branding_settings.png
diff --git a/content/docs/enterprise/branding/img/policy_with_explanation_and_remediation.png b/content/docs/enterprise/branding/img/policy_with_explanation_and_remediation.png
diff --git a/content/docs/enterprise/branding/img/secondary_color.png b/content/docs/enterprise/branding/img/secondary_color.png
diff --git a/content/docs/enterprise/branding/img/svg_logo_console.png b/content/docs/enterprise/branding/img/svg_logo_console.png
diff --git a/content/docs/enterprise/branding/img/svg_logo_error_details.png b/content/docs/enterprise/branding/img/svg_logo_error_details.png
diff --git a/content/docs/enterprise/branding/img/unbranded_error_page.png b/content/docs/enterprise/branding/img/unbranded_error_page.png
diff --git a/content/docs/enterprise/branding/logo.md b/content/docs/enterprise/branding/logo.md
diff --git a/content/docs/enterprise/external-data/bamboohr.mdx b/content/docs/enterprise/external-data/bamboohr.mdx
@@ -82,13 +82,11 @@ To create new external data record:
 
 1. Fill out the following fields:
 
-  | Field             | Content                                    | Notes                                                                             |
-  | :---------------- | :----------------------------------------- | :-------------------------------------------------------------------------------- |
-  | URL               | `http://bamboohr:8080/employees/available` | Adjust for the endpoint you'll write policies against.                            |
-  | Record type       | `pomerium.io/BambooHRAvailable`            | As above, adjust to somethinglike pomerium.io/BambooHRAll for the other endpoint. |
-  | Foreign Key       | `user.email`                               | Pomerium uses the users's email to associate IdP and Bamboo user entries.         |
-  | Polling Min Delay | `30m`                                      | Minimum poll interval                                                             |
-  | Polling Max Delay | `4h`                                       | Maximum poll interval                                                                 |
+  | Field       | Content                                    | Notes                                                                             |
+  | :---------- | :----------------------------------------- | :-------------------------------------------------------------------------------- |
+  | URL         | `http://bamboohr:8080/employees/available` | Adjust for the endpoint you'll write policies against.                            |
+  | Record type | `pomerium.io/BambooHRAvailable`            | As above, adjust to somethinglike pomerium.io/BambooHRAll for the other endpoint. |
+  | Foreign Key | `user.email`                               | Pomerium uses the users's email to associate IdP and Bamboo user entries.         |
 
 1. Click **SAVE EXTERNAL DATA SOURCE**.
 

diff --git a/content/docs/enterprise/external-data/geoip.mdx b/content/docs/enterprise/external-data/geoip.mdx
@@ -93,13 +93,11 @@ Create an external data source:
 
 1. Fill out the following fields:
 
-  | Field             | Content               | Notes                                                                                                |
-  | :---------------- | :-------------------- | :--------------------------------------------------------------------------------------------------- |
-  | URL               | http://localhost:8080 | If you configured the service in Docker Compose with a set container name, you can use that instead. |
-  | Record type       | pomerium.io/GeoIP     |                                                                                                      |
-  | Foreign Key       | request.ip            |                                                                                                      |
-  | Polling Min Delay | `30m`                 | Minimum poll interval                                                                                |
-  | Polling Max Delay | `4h`                  | Maximum poll interval                                                                                    |
+  | Field       | Content               | Notes                                                                                                |
+  | :---------- | :-------------------- | :--------------------------------------------------------------------------------------------------- |
+  | URL         | http://localhost:8080 | If you configured the service in Docker Compose with a set container name, you can use that instead. |
+  | Record type | pomerium.io/GeoIP     |                                                                                                      |
+  | Foreign Key | request.ip            |                                                                                                      |
 
 1. Click **SAVE EXTERNAL DATA SOURCE**.
 

diff --git a/content/docs/enterprise/external-data/ip-ranges.mdx b/content/docs/enterprise/external-data/ip-ranges.mdx
@@ -91,13 +91,11 @@ Create an external data source:
 
 1. Fill out the following fields:
 
-| Field             | Content                      | Notes                                                                                                |
-| :---------------- | :--------------------------- | :--------------------------------------------------------------------------------------------------- |
-| URL               | http://localhost:8080        | If you configured the service in Docker Compose with a set container name, you can use that instead. |
-| Record type       | pomerium.io/WellKnownIPRange |                                                                                                      |
-| Foreign Key       | request.ip                   |                                                                                                      |
-| Polling Min Delay | `1h`                         | Minimum poll interval                                                                                |
-| Polling Max Delay | `4h`                         | Maximum poll interval                                                                                    |
+| Field       | Content                      | Notes                                                                                                |
+| :---------- | :--------------------------- | :--------------------------------------------------------------------------------------------------- |
+| URL         | http://localhost:8080        | If you configured the service in Docker Compose with a set container name, you can use that instead. |
+| Record type | pomerium.io/WellKnownIPRange |                                                                                                      |
+| Foreign Key | request.ip                   |                                                                                                      |
 
 ## Configure Pomerium Enterprise Console
 

diff --git a/content/docs/enterprise/external-data/vpn-providers.mdx b/content/docs/enterprise/external-data/vpn-providers.mdx
@@ -30,13 +30,11 @@ Create an external data source:
 
 1. Fill out the following fields:
 
-   | Field             | Content                                                              |
-   | :---------------- | :------------------------------------------------------------------- |
-   | URL               | https://raw.githubusercontent.com/pomerium/vpnlist/main/vpnlist.json |
-   | Record type       | pomerium.io/VPNNode                                                  |
-   | Foreign Key       | request.ip                                                           |
-   | Polling Min Delay | `1h`                                                                 | 
-   | Polling Max Delay | `4h`                                                                 | 
+   | Field       | Content                                                              |
+   | :---------- | :------------------------------------------------------------------- |
+   | URL         | https://raw.githubusercontent.com/pomerium/vpnlist/main/vpnlist.json |
+   | Record type | pomerium.io/VPNNode                                                  |
+   | Foreign Key | request.ip                                                           |
 
 1. Click **SAVE EXTERNAL DATA SOURCE**.
 

diff --git a/content/docs/enterprise/external-data/zenefits.mdx b/content/docs/enterprise/external-data/zenefits.mdx
@@ -75,13 +75,11 @@ These instructions assume a local testing environment. Adjust as needed for your
 
 1. Fill out the following fields:
 
-  | Field             | Content                          | Notes                                                                     |
-  | :---------------- | :------------------------------- | :------------------------------------------------------------------------ |
-  | URL               | `http://zenefits:8080/employees` | Adjust the hostname as needed depending on your local test environment.   |
-  | Record type       | `pomerium.io/Zenefits`           |                                                                           |
-  | Foreign Key       | `user.email`                     | Pomerium uses the users's email to associate IdP and Zenefits user entries. |
-  | Polling Min Delay | `1h`                             | Minimum poll interval                                                                                |
-  | Polling Max Delay | `4h`                             | Max poll interval                                                                                    |
+  | Field       | Content                          | Notes                                                                     |
+  | :---------- | :------------------------------- | :------------------------------------------------------------------------ |
+  | URL         | `http://zenefits:8080/employees` | Adjust the hostname as needed depending on your local test environment.   |
+  | Record type | `pomerium.io/Zenefits`           |                                                                           |
+  | Foreign Key | `user.email`                     | Pomerium uses the users's email to associate IdP and Zenefits user entries. |
 
 1. Define a new policy. The example policy below only allows persons in the list (i.e. not out of office or on vacation) and in `active` status (i.e. not `terminated` or `onboarding`) to pass. 
 

diff --git a/content/docs/enterprise/identity-providers/auth0.mdx b/content/docs/enterprise/identity-providers/auth0.mdx
@@ -1,6 +1,5 @@
 ---
 title: Auth0
-sidebar_class_name: enterprise
 ---
 
 ## Setting Up Directory Sync

diff --git a/content/docs/enterprise/img/console-ext-datasource-monitoring.png b/content/docs/enterprise/img/console-ext-datasource-monitoring.png
diff --git a/content/docs/enterprise/install/helm.mdx b/content/docs/enterprise/install/helm.mdx
@@ -123,12 +123,6 @@ This setup assumes an existing certificate solution using cert-manager, as descr
    image:
      pullUsername: pomerium/enterprise
      pullPassword: your-access-key
-   serviceMonitor:
-     enabled: true
-   metrics:
-     enabled: true
-```
-
    ```
 
 1. The Pomerium repository should already be in your Helm configuration per [Pomerium using Helm]. If not, add it now:

diff --git a/content/docs/enterprise/metrics.md b/content/docs/enterprise/metrics.md
@@ -4,30 +4,24 @@ sidebar_label: Metrics
 description: Use Prometheus as a metrics data store.
 ---
 
-Pomerium Enterprise uses Prometheus as a metrics collection back-end. You can configure Pomerium and the Console to talk to an existing Prometheus server, or configure the embedded Prometheus backend. This guide assumes you're running both Pomerium and Pomerium Enterprise on localhost `127.0.0.1`.
+Pomerium Enterprise uses Prometheus as a metrics collection back-end. You can configure Pomerium and the Console to talk to an existing Prometheus server, or configure the embedded Prometheus backend.
 
 :::tip
 For production deployments, we suggest using a dedicated Prometheus instance.
 :::
 
 ## Prepare Pomerium
 
-1. In the Pomerium `pomerium-config.yaml`, define the [`metrics_address`](/docs/reference/metrics-address) key to a network interface and/or port. For example:
+1. In the Pomerium `config.yaml`, define the [`metrics_address`](/docs/reference/metrics-address) key to a network interface and/or port. For example:
 
-   ```yaml title="pomerium-config.yaml"
-   metrics_address: 127.0.0.1:9091
+   ```yaml title="config.yaml"
+   metrics_address: 192.0.2.31:9999
    ```
 
    The example above has Pomerium providing metrics at port `9999` on an IP address reachable by the Pomerium Console service.
 
    If you're running Pomerium Enterprise in a distributed environment where the IP address is not known at the time of deployment, you can use the resolvable FQDN of the Pomerium host (`pomerium0.internal.mycompany.com`, for example), or override this key with the environment variable `METRICS_ADDRESS`. We do not recommend exposing this endpoint to public traffic as it can contain potentially sensitive information.
 
-1. In the Pomerium Enterprise `pomerium-enterprise-config.yaml`, define the `metrics_addr` key to a network interface and/or port. For example: 
-
-   ```yaml title="config.yaml"
-   metrics_addr: 127.0.0.1:9092
-   ```
-
 ## External Prometheus
 
 1. Add the listener to your Prometheus configuration, usually via `prometheus.yml`:
@@ -37,12 +31,7 @@ For production deployments, we suggest using a dedicated Prometheus instance.
       scrape_interval: 30s
       scrape_timeout: 5s
       static_configs:
-         - targets: ['127.0.0.1:9901']
-   - job_name: 'Pomerium Enterprise'
-      scrape_interval: 30s
-      scrape_timeout: 5s
-      static_configs:
-         - targets: ['127.0.0.1:9902']
+         - targets: ['192.0.2.10:9999']
 
    ```
 
@@ -58,10 +47,9 @@ For production deployments, we suggest using a dedicated Prometheus instance.
    prometheus_url: http://192.168.122.50:9090
    ```
 
-2. Restart the Pomerium and Pomerium Enterprise services. You should now see route traffic and External Data Source monitoring data in the Enterprise Console:
+1. Restart the Pomerium and Pomerium Enterprise services. You should now see route traffic data in the Enterprise Console:
 
    ![Traffic Data in Pomerium Enterprise](img/console-route-traffic.png)
-   ![External Data Source in Pomerium Enterprise](img/console-ext-datasource-monitoring.png)
 
 ## Embedded Prometheus
 

diff --git a/content/docs/enterprise/reference/configure.md b/content/docs/enterprise/reference/configure.md
@@ -273,11 +273,7 @@ If set, allows the import of external data from sources using untrusted TLS cert
 
 #### Polling Min/Max Delay
 
-Defines the minimum and maximum delay times between requests to the external data source. 
-The job would be scheduled to run within `min delay` intervals. Note, if a job may not
-complete within the `min delay` period, it would be interrupted and restarted. If a job 
-is interrupted by timeout or due to an error, it would be restarted with increasing 
-intervals up to the `max delay` period. 
+Defines the minimum and maximum delay times between requests to the external data source.
 
 #### Client TLS Key
 

diff --git a/content/docs/install/img/self-signed-warning.png b/content/docs/install/img/self-signed-warning.png
diff --git a/content/docs/install/img/user-details-page.png b/content/docs/install/img/user-details-page.png