Skip to content

Commit 00881d4

Browse files
committed
moves databroker service def to data-storage
1 parent cbb0be8 commit 00881d4

File tree

2 files changed

+15
-27
lines changed

2 files changed

+15
-27
lines changed

content/docs/internals/data-storage.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,18 @@ To prevent early session loss in production deployments, persistent storage back
3131

3232
## Backends
3333

34-
Configuration options for each backend are detailed in [databroker configuration reference](/docs/reference/databroker).
34+
The **Databroker Service** stores user session data, and uses an in-memory databroker by default.
3535

3636
Pomerium encrypts record values only for the Redis storage backend (not for the in-memory or Postgres storage backends). When using the Postgres backend we recommend that users configure their own encryption at rest, for example by using full-disk encryption on the volume where Postgres data is stored.
3737

38+
:::tip
39+
40+
You can create your own databroker by implementing Pomerium's [**databroker gRPC interface**](https://github.com/pomerium/pomerium/blob/main/pkg/grpc/databroker/databroker.proto). For an example implementation, see the in-memory database used by the databroker service:
41+
42+
- [pkg/storage](https://github.com/pomerium/pomerium/tree/main/pkg/storage/inmemory)
43+
44+
:::
45+
3846
### In-Memory
3947

4048
- Data Broker Service HA: `no`
@@ -78,6 +86,12 @@ name=value[&...]
7886

7987
When using multiple hosts make sure to specify `target_session_attrs=read-write` so that the Databroker does not attempt to write to a read-only replica.
8088

89+
:::note
90+
91+
Configuration options for each backend are detailed in the [**databroker configuration reference**](/docs/reference/databroker) page.
92+
93+
:::
94+
8195
## Troubleshooting
8296

8397
Most issues with the Databroker service are caused by a [`shared_secret`](/docs/reference/shared-secret) mismatch between services. See [Troubleshooting - Shared Secret Mismatch](/docs/reference/shared-secret) for details.

content/docs/reference/databroker.mdx

-26
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,6 @@ import TabItem from '@theme/TabItem';
1111

1212
# Databroker Settings
1313

14-
This reference covers all of Pomerium's **Databroker Settings**:
15-
16-
- [Databroker Service](#databroker-service)
17-
- [Databroker Service URL](#databroker-service-url)
18-
- [Databroker Internal Service URL](#databroker-internal-service-url)
19-
- [Databroker Storage Certificate Authority](#databroker-storage-certificate-authority)
20-
- [Databroker Storage Certificate File](#databroker-storage-certificate-file)
21-
- [Databroker Storage Certificate Key File](#databroker-storage-certificate-key-file)
22-
- [Databroker Storage Connection String](#databroker-storage-connection-string)
23-
- [Databroker Storage TLS Skip Verify](#databroker-storage-tls-skip-verify)
24-
- [Databroker Storage Type](#databroker-storage-type)
25-
26-
## Databroker Service {#databroker-service}
27-
28-
The **Databroker Service** stores user session data.
29-
30-
### How to configure {#databroker-service-how-to-configure}
31-
32-
By default, the `databroker` service uses an in-memory databroker.
33-
34-
To create your own databroker, implement Pomerium's [databroker gRPC interface](https://github.com/pomerium/pomerium/blob/main/pkg/grpc/databroker/databroker.proto).
35-
36-
For an example implementation, see the in-memory database used by the databroker service here:
37-
38-
- [pkg/storage](https://github.com/pomerium/pomerium/tree/main/pkg/storage/inmemory)
39-
4014
## Databroker Service URL {#databroker-service-url}
4115

4216
**Databroker Service URL** points to a data broker which is responsible for storing associated authorization context (for example, sessions, users, and user groups).

0 commit comments

Comments
 (0)