Skip to content

Commit 848eb62

Browse files
committed
edits from SW
1 parent b46d2ad commit 848eb62

6 files changed

+10
-9
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ For information about supported versions and deprecation dates, see [Private Ope
9494

9595
<UpgradePolicy />
9696

97-
## Rotating the Keys
97+
## Keeping the Operator Key Secure
9898

9999
<SnptRotatingTheKeys />
100100

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,6 @@ To upgrade, complete the following steps:
473473
kubectl get pods
474474
```
475475

476-
## Rotating the Keys
476+
## Keeping the Operator Key Secure
477477

478478
<SnptRotatingTheKeys />

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ The following table includes some additional commands that might help you manage
360360
| Runs one iteration of `logrotate` manually, without changing the scheduled interval. | `sudo logrotate -f /etc/logrotate.conf --force` |
361361
| Reloads `syslog-ng`. | `sudo /usr/sbin/syslog-ng-ctl reload` |
362362

363-
## Rotating the Keys
363+
## Keeping the Operator Key Secure
364364

365365
<SnptRotatingTheKeys />
366366

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ To upgrade, complete the following steps:
337337
for i in {0..COUNT}; az container delete --name uid-operator-OLD-VERSION-$i --resource-group {RESOURCE_GROUP} --yes
338338
```
339339

340-
## Rotating the Keys
340+
## Keeping the Operator Key Secure
341341

342342
<SnptRotatingTheKeys />
343343

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ If you previously set up a load balancer manually, you'll also need to update th
533533
## Scraping Metrics
534534
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.
535535
536-
## Rotating the Keys
536+
## Keeping the Operator Key Secure
537537
538538
<SnptRotatingTheKeys />
539539
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
<!-- 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 -->
22

3-
It's a good security practice to rotate the keys on a regular cadence.
3+
Here are some guidelines for keeping your operator key secure:
44

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).
5+
- When you receive your operator key, store it in a secure location.
6+
- Keep track of all places where the key is used, so that if you need to rotate it you can do so quickly.
7+
- Establish a process for replacing the existing value with a new one if the key is compromised.
8+
- Rotate it on a regular cadence&#8212;for example, yearly&#8212;to help reduce the risk of the key being compromised.

0 commit comments

Comments
 (0)