mirror of
https://github.com/pomerium/pomerium.git
synced 2025-08-06 10:21:05 +02:00
block of enterprise doc updates
This commit is contained in:
parent
8581dff7cf
commit
2ea61ae960
4 changed files with 65 additions and 1 deletions
|
@ -208,6 +208,7 @@ module.exports = {
|
||||||
"install/quickstart",
|
"install/quickstart",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
"prometheus",
|
||||||
"concepts",
|
"concepts",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|
|
@ -8,12 +8,29 @@ description: Learn how the Pomerium Enterprise Console works.
|
||||||
|
|
||||||
## Namespaces
|
## Namespaces
|
||||||
|
|
||||||
## Folders
|
In the Pomerium Enterprise Console, a namespace is where you can define an organizational unit of users and groups with fine-grained access management. This enables teams to self-service the routes and policies pertinent to them. Namespaces can optionally inherit from their parent units.
|
||||||
|
|
||||||
## Service Accounts
|
## Service Accounts
|
||||||
|
|
||||||
|
Service accounts handle machine-to-machine communication from Pomerium to your Identity Provider (**IdP**) in order to retrieve and establish group membership. Configuration is largely dependent on the IdP, but is usually an API acccess token with sufficient privlidges to read users and groups.
|
||||||
|
|
||||||
## Routes
|
## Routes
|
||||||
|
|
||||||
|
Unlike the open-source Pomerium configuration, access is not defined alongside routing. Instead, authorization is configured by attaching [policies](#policies) to a route.
|
||||||
|
|
||||||
## Policies
|
## Policies
|
||||||
|
|
||||||
|
In the open-source Pomerium config, routes and policies are configured in a single block, under `policy`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
policy:
|
||||||
|
- from: https://code.corp.domain.example
|
||||||
|
to: http://codeserver:8080
|
||||||
|
allowed_users:
|
||||||
|
- some.user@domain.example
|
||||||
|
allow_websockets: true
|
||||||
|
```
|
||||||
|
|
||||||
|
In the Pomerium Enterprise Console, [routes](#routes) and policies are separate entities. This allows for both easier and more fine-grained access control, as policies can be defined once, optionally associated under a [Namespace](#namespaces), and attached to one or more routes. Routes can also inherit policies from their parent Namespace <!-- @Travis please confirm -->.
|
||||||
|
|
||||||
### Authorization Policy
|
### Authorization Policy
|
BIN
docs/enterprise/img/console-route-traffic.png
Normal file
BIN
docs/enterprise/img/console-route-traffic.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 62 KiB |
46
docs/enterprise/prometheus.md
Normal file
46
docs/enterprise/prometheus.md
Normal file
|
@ -0,0 +1,46 @@
|
||||||
|
---
|
||||||
|
title: Prometheus
|
||||||
|
sidebarDepth: 1
|
||||||
|
description: Use Prometheus as a metrics data store.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Prometheus Metrics
|
||||||
|
|
||||||
|
The Pomerium Enterprise Console 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.
|
||||||
|
|
||||||
|
## External Prometheus
|
||||||
|
|
||||||
|
1. In the Pomerium `config.yaml` define the `metrics_address` key to a network interface and port. For example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
metrics_address: localhost:9999
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Add this listener to your Prometheus configurarion, usually via `prometheus.yml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- job_name: 'Pomerium'
|
||||||
|
scrape_interval: 30s
|
||||||
|
scrape_timeout: 5s
|
||||||
|
static_configs:
|
||||||
|
- targets: ['192.0.2.10:9999']
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
1. [Reload](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration) the Prometheus configuration:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -i -XPOST path.to.prometheus:port/-/reload
|
||||||
|
```
|
||||||
|
|
||||||
|
1. In the Pomerium Enterprise Console `config.yaml` file, define the `prometheus_url` key to point to your Prometheus instance(s):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
prometheus_url: http://192.168.122.50:9090
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Restart the Pomerium and Pomerium Enterprise Console services. You should now see route traffic data in the Enterprise Console:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Embedded Prometheus
|
Loading…
Add table
Add a link
Reference in a new issue