docs: update branding, concepts (#2445) (#2449)

* Pomerium Enterprise not Pomerium Enterprise Console to be consistent.

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

* s/The Pomerium Enterprise/Pomerium Enterprise/g

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

* update concepts

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

* Update docs/enterprise/about.md

Co-authored-by: Alex Fornuto <alex@fornuto.com>

* Update docs/enterprise/concepts.md

Co-authored-by: Alex Fornuto <alex@fornuto.com>

Co-authored-by: Alex Fornuto <alex@fornuto.com>

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: Alex Fornuto <alex@fornuto.com>
This commit is contained in:
backport-actions-token[bot] 2021-08-06 16:14:27 +00:00 committed by GitHub
parent 82f84365a9
commit 094eaa4b7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 50 additions and 52 deletions

View file

@ -4,18 +4,18 @@ sidebarDepth: 1
description: Install Pomerium Enterprise in Kubernetes with Helm
---
# Install Pomerium Enterprise Console in Helm
# Install Pomerium Enterprise in Helm
This document covers installing Pomerium Enterprise Console into your existing helm-managed Kubernetes cluster. It's designed to work with an existing cluster running Pomerium, as described im [Pomerium using Helm]. Follow that document before continuing here.
This document covers installing Pomerium Enterprise into your existing helm-managed Kubernetes cluster. It's designed to work with an existing cluster running Pomerium, as described im [Pomerium using Helm]. Follow that document before continuing here.
## Before You Begin
The Pomerium Enterprise Console requires:
Pomerium Enterprise requires:
- An accessible RDBMS. We support PostgreSQL 9+.
- A database and user with full permissions for it.
- A certificate management solution. This page will assume a store of certificates using [cert-manager] as the solution. If you use another certificate solution, adjust the steps accordingly.
- An existing Pomerium installation. If you don't already have the open-source Pomerium installed in your cluster, see [Pomerium using Helm] before you continue.
- An existing Pomerium installation. If you don't already have open-source Pomerium installed in your cluster, see [Pomerium using Helm] before you continue.
## System Requirements
@ -84,7 +84,7 @@ This setup assumes an existing certificate solution using cert-manager, as descr
helm upgrade --install pomerium pomerium/pomerium --values=./pomerium-values.yaml
```
## Install Pomerium Enterprise Console
## Install Pomerium Enterprise
1. Create `pomerium-console-values.yaml` as shown below, replacing placeholder values:
@ -133,7 +133,7 @@ This setup assumes an existing certificate solution using cert-manager, as descr
1. When visiting `https://console.localhost.pomerium.io`, you should se the Session List page:
![The Session List page after installing Pomerium Enterprise Console](../img/console-session-landing.png)
![The Session List page after installing Pomerium Enterprise](../img/console-session-landing.png)
## Troubleshooting

View file

@ -21,7 +21,7 @@ This document assumes:
## Requirements
- The Pomerium Enterprise Console requires Linux amd64/x86_64. It can manage Pomerium instances on other platforms, however.
- Pomerium Enterprise requires Linux amd64/x86_64. It can manage Pomerium instances on other platforms, however.
- Each Console instance should have at least:
- 4 vCPUs
- 8G RAM
@ -35,7 +35,7 @@ This document assumes:
- 4G RAM
- 20G for data files
## Install Pomerium Enterprise Console
## Install Pomerium Enterprise
Pomerium publishes standard OS packages for RPM and DEB based systems. The repositories require authentication via username and access key. These credentials will be issued to you during the onboarding process.
@ -59,7 +59,7 @@ Pomerium publishes standard OS packages for RPM and DEB based systems. The repos
echo "deb https://dl.cloudsmith.io/[access-key]/pomerium/enterprise/deb/debian buster main" | sudo tee /apt/sources.list.d/pomerium-console.list
```
1. Update `apt` and install the Pomerium Enterprise Console:
1. Update `apt` and install Pomerium Enterprise:
```bash
sudo apt update; sudo apt install pomerium-console
@ -108,7 +108,7 @@ sudo systemctl enable --now pomerium-console
## Initial Configuration
Like the open-source Pomerium base, Pomerium Enterprise Console is configured through a single config file, located at `/etc/pomerium-console/config.yaml`.
Like the open-source Pomerium base, Pomerium Enterprise is configured through a single config file, located at `/etc/pomerium-console/config.yaml`.
### Update Pomerium
@ -160,7 +160,7 @@ Once you have set permissions in the console UI, you should remove this configur
### TLS, Signing Key and Audience
1. If your open-source Pomerium installation is already configured to use TLS to secure back-end communication, you can do the same for the Pomerium Enterprise Console by providing it a certificate, key, and optional custom CA file to validate the `databroker_service_url` connection:
1. If your open-source Pomerium installation is already configured to use TLS to secure back-end communication, you can do the same for Pomerium Enterprise by providing it a certificate, key, and optional custom CA file to validate the `databroker_service_url` connection:
```yaml
tls_ca_file: /etc/pomerium-console/ca.pem
@ -202,4 +202,4 @@ audience: console.localhost.pomerium.com
## Next Steps
The Pomerium Enterprise Console assumes access to a [Prometheus](https://prometheus.io/) data store for metrics. See [Prometheus Metrics](/enterprise/prometheus.md) to learn how to configure access.
Pomerium Enterprise assumes access to a [Prometheus](https://prometheus.io/) data store for metrics. See [Prometheus Metrics](/enterprise/prometheus.md) to learn how to configure access.

View file

@ -6,7 +6,7 @@ meta:
content: pomerium identity-access-proxy oidc docker reverse-proxy containers install enterprise console
---
There are several ways to install Pomerium Enterprise, to suite your organization's needs. We provide open-source Pomerium and the Pomerium Enterprise Console as deb and rpm packages from an upstream repository, and as Docker images, and Helm charts. You can also build Pomerium from source.
There are several ways to install Pomerium Enterprise, to suite your organization's needs. We provide open-source Pomerium and Pomerium Enterprise as deb and rpm packages from an upstream repository, and as Docker images, and Helm charts. You can also build Pomerium from source.
Our docs are updated frequently, so check back if you don't see your preferred installation method here.