Skip to content

Commit b46d2ad

Browse files
committed
Private Operator docs, add info re rotating the keys
1 parent e1ae9d1 commit b46d2ad

6 files changed

+31
-0
lines changed

docs/guides/integration-options-private-operator.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ displayed_sidebar: docs
77

88
import Link from '@docusaurus/Link';
99
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
10+
import SnptRotatingTheKeys from '../snippets/_private-operator-rotating-the-keys.mdx';
1011

1112
# UID2 Private Operator Integration Overview
1213

@@ -93,6 +94,10 @@ For information about supported versions and deprecation dates, see [Private Ope
9394

9495
<UpgradePolicy />
9596

97+
## Rotating the Keys
98+
99+
<SnptRotatingTheKeys />
100+
96101
## Getting Started
97102

98103
To get started as a Private Operator, follow these steps:

docs/guides/operator-guide-aks-enclave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ displayed_sidebar: docs
1010

1111
import Link from '@docusaurus/Link';
1212
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
13+
import SnptRotatingTheKeys from '../snippets/_private-operator-rotating-the-keys.mdx';
1314

1415
# UID2 Private Operator for AKS Integration Guide
1516

@@ -471,3 +472,7 @@ To upgrade, complete the following steps:
471472
```
472473
kubectl get pods
473474
```
475+
476+
## Rotating the Keys
477+
478+
<SnptRotatingTheKeys />

docs/guides/operator-guide-aws-marketplace.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ displayed_sidebar: docs
1111
import Link from '@docusaurus/Link';
1212
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
1313
import AttestFailure from '../snippets/_private-operator-attest-failure.mdx';
14+
import SnptRotatingTheKeys from '../snippets/_private-operator-rotating-the-keys.mdx';
1415

1516
# UID2 Private Operator for AWS Integration Guide
1617

@@ -359,6 +360,9 @@ The following table includes some additional commands that might help you manage
359360
| Runs one iteration of `logrotate` manually, without changing the scheduled interval. | `sudo logrotate -f /etc/logrotate.conf --force` |
360361
| Reloads `syslog-ng`. | `sudo /usr/sbin/syslog-ng-ctl reload` |
361362

363+
## Rotating the Keys
364+
365+
<SnptRotatingTheKeys />
362366

363367
## UID2 Operator Error Codes
364368

docs/guides/operator-guide-azure-enclave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ displayed_sidebar: docs
1010

1111
import Link from '@docusaurus/Link';
1212
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
13+
import SnptRotatingTheKeys from '../snippets/_private-operator-rotating-the-keys.mdx';
1314

1415
# UID2 Private Operator for Azure Integration Guide
1516

@@ -336,6 +337,10 @@ To upgrade, complete the following steps:
336337
for i in {0..COUNT}; az container delete --name uid-operator-OLD-VERSION-$i --resource-group {RESOURCE_GROUP} --yes
337338
```
338339

340+
## Rotating the Keys
341+
342+
<SnptRotatingTheKeys />
343+
339344
## UID2 Operator Error Codes
340345

341346
The following table lists errors that might occur during a Private Operator's startup sequence.

docs/guides/operator-private-gcp-confidential-space.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ displayed_sidebar: docs
1010

1111
import Link from '@docusaurus/Link';
1212
import UpgradePolicy from '../snippets/_private-operator-upgrade-policy.mdx';
13+
import SnptRotatingTheKeys from '../snippets/_private-operator-rotating-the-keys.mdx';
1314

1415
# UID2 Private Operator for GCP Integration Guide
1516

@@ -532,6 +533,10 @@ If you previously set up a load balancer manually, you'll also need to update th
532533
## Scraping Metrics
533534
The Private Operator for GCP exposes [Prometheus-formatted metrics](https://prometheus.io/docs/concepts/data_model/) on port 9080 through the /metrics endpoint. You can use a Prometheus-compatible scraper to collect and aggregate these metrics for your own needs.
534535
536+
## Rotating the Keys
537+
538+
<SnptRotatingTheKeys />
539+
535540
## UID2 Operator Error Codes
536541
537542
The following table lists errors that might occur during a Private Operator's startup sequence.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!-- Used by: all Private Operator guides plus intro: guides/operator-guide-aks-enclave.md, operator-guide-aws-marketplace.md, operator-guide-azure-enclave.md, operator-private-gcp-confidential-space.md, also integration-options-private-operator.md -->
2+
3+
It's a good security practice to rotate the keys on a regular cadence.
4+
5+
[**GWH__SW question. In this doc (AWS) we mention: KMSKey, SSMKeyAlias, "the operator key", SSH key, the key store, OPERATOR_KEY, EC2 key pair. I'd like to be clear about naming and I'm frankly not sure... is it the operator key? Just need to be a bit clearer than "rotate the keys"**]
6+
7+
For specific recommendations, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret).

0 commit comments

Comments
 (0)