3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-06-02 02:42:57 +02:00
Code Issues Projects Releases Packages Wiki Activity

databroker: rename cache service (#1790)

Browse source 
* rename cache folder

* rename cache service everywhere

* skip yaml in examples

* Update docs/docs/topics/data-storage.md

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>

Co-authored-by: Travis Groth <travisgroth@users.noreply.github.com>
This commit is contained in:
Caleb Doxsey 2021-01-21 08:41:22 -07:00 • committed by GitHub
parent 0adb9e5dde
commit 70b4497595
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
27 changed files with 115 additions and 108 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/reference/readme.md
View file

@ -511,7 +511,7 @@ Proxy log level sets the logging level for the pomerium proxy service access log
- Config File Key: `services`
- Type: `string`
- Default: `all`
- Options: `all` `authenticate` `authorize` `cache` or `proxy`
- Options: `all` `authenticate` `authorize` `databroker` or `proxy`
Service mode sets which service(s) to run. If testing, you may want to set to `all` and run pomerium in "all-in-one mode." In production, you'll likely want to spin up several instances of each service mode for high availability.
@ -855,26 +855,26 @@ Refresh cooldown is the minimum amount of time between allowed manually refreshe
Do not append proxy IP address to `x-forwarded-for` HTTP header. See [Envoy](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/headers.html?highlight=skip_xff_append#x-forwarded-for) docs for more detail.
## Cache Service
The cache service is used for storing user session data.
## Data Broker Service
The databroker service is used for storing user session data.
### Data Broker Service URL
- Environmental Variable: `DATABROKER_SERVICE_URL`
- Config File Key: `databroker_service_url`
- Type: `URL`
- Example: `https://cache.corp.example.com`
- Example: `https://databroker.corp.example.com`
- Default: in all-in-one mode, `http://localhost:5443`
The data broker service URL points to a data broker which is responsible for storing associated authorization context (e.g. sessions, users and user groups).
By default, the `cache` service uses an in-memory databroker.
By default, the `databroker` service uses an in-memory databroker.
To create your own data broker, implement the following gRPC interface:
- [pkg/grpc/databroker/databroker.proto](https://github.com/pomerium/pomerium/blob/master/pkg/grpc/databroker/databroker.proto)
For an example implementation, the in-memory database used by the cache service can be found here:
For an example implementation, the in-memory database used by the databroker service can be found here:
- [pkg/databroker/memory](https://github.com/pomerium/pomerium/tree/master/pkg/databroker/memory)

12
docs/reference/settings.yaml
View file

@ -581,7 +581,7 @@ settings:
- Config File Key: `services`
- Type: `string`
- Default: `all`
- Options: `all` `authenticate` `authorize` `cache` or `proxy`
- Options: `all` `authenticate` `authorize` `databroker` or `proxy`
doc: |
Service mode sets which service(s) to run. If testing, you may want to set to `all` and run pomerium in "all-in-one mode." In production, you'll likely want to spin up several instances of each service mode for high availability.
shortdoc: |
@ -967,9 +967,9 @@ settings:
Do not append proxy IP address to `x-forwarded-for` HTTP header. See [Envoy](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/headers.html?highlight=skip_xff_append#x-forwarded-for) docs for more detail.
shortdoc: |
Do not append proxy IP address to [x-forwarded-for](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/headers.html?highlight=skip_xff_append#x-forwarded-for).
- name: "Cache Service"
- name: "Data Broker Service"
doc: |
The cache service is used for storing user session data.
The databroker service is used for storing user session data.
settings:
- name: "Data Broker Service URL"
keys: ["databroker_service_url"]
@ -977,18 +977,18 @@ settings:
- Environmental Variable: `DATABROKER_SERVICE_URL`
- Config File Key: `databroker_service_url`
- Type: `URL`
- Example: `https://cache.corp.example.com`
- Example: `https://databroker.corp.example.com`
- Default: in all-in-one mode, `http://localhost:5443`
doc: |
The data broker service URL points to a data broker which is responsible for storing associated authorization context (e.g. sessions, users and user groups).
By default, the `cache` service uses an in-memory databroker.
By default, the `databroker` service uses an in-memory databroker.
To create your own data broker, implement the following gRPC interface:
- [pkg/grpc/databroker/databroker.proto](https://github.com/pomerium/pomerium/blob/master/pkg/grpc/databroker/databroker.proto)
For an example implementation, the in-memory database used by the cache service can be found here:
For an example implementation, the in-memory database used by the databroker service can be found here:
- [pkg/databroker/memory](https://github.com/pomerium/pomerium/tree/master/pkg/databroker/memory)
- name: "Data Broker Storage Type"