Skip to content

Commit b54735b

Browse files
clarkxuyangclarkxuyang
authored
Merge pull request #854 from IABTechLab/xuy-UID2-4736-update-private-operator-docs
Xuy UI d2 4736 update private operator docs
2 parents 0d2c943 + 6c6f18b commit b54735b

File tree

5 files changed

+56
-2
lines changed

5 files changed

+56
-2
lines changed

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,24 @@ The following table includes some additional commands that might help you manage
350350
| Runs one iteration of `logrotate` manually, without changing the scheduled interval. | `sudo logrotate -f /etc/logrotate.conf --force` |
351351
| Reloads `syslog-ng`. | `sudo /usr/sbin/syslog-ng-ctl reload` |
352352

353+
354+
## UID2 Operator Error Codes
355+
356+
The following table lists errors that might occur during a Private Operator's startup sequence.
357+
358+
:::note
359+
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
360+
:::
361+
362+
| Error Code | Issue | Steps to Resolve |
363+
| :--- | :--- | :--- |
364+
| E01 | InstanceProfileMissingError | Attach an IAM instance profile to the EC2 instance with the required permissions. The UID2 Operator needs these permissions to access configurations from AWS Secrets Manager. |
365+
| E02 | OperatorKeyNotFoundError | Make sure that the secret referenced by the Private Operator exists in AWS Secrets Manager in the same region as the operator, and that the IAM instance profile has permission to access the secret. If needed, you can check the logs for the specific secret name and region. |
366+
| E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes in Secrets Manager. |
367+
| E04 | ConfigurationValueError | A configuration value is invalid. Verify that the configuration values in the AWS Secrets Manager align with the required format and environment. Note: `debug_mode = true` is allowed only in the `integ` environment. Check the logs for more details. |
368+
| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. |
369+
| E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
370+
353371
## Technical Support
354372

355373
If you have trouble subscribing to the product, or deploying, [contact us](mailto:[email protected]).

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,3 +324,20 @@ To upgrade, complete the following steps:
324324
```
325325
for i in {0..COUNT}; az container delete --name uid-operator-OLD-VERSION-$i --resource-group {RESOURCE_GROUP} --yes
326326
```
327+
328+
## UID2 Operator Error Codes
329+
330+
The following table lists errors that might occur during a Private Operator's startup sequence.
331+
332+
:::note
333+
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
334+
:::
335+
336+
| Error Code | Issue | Steps to Resolve |
337+
| :--- | :--- | :--- |
338+
| E02 | OperatorKeyNotFoundError | Make sure that the secret vault and secret name that store the operator key are correctly configured. Make sure they are set as `VAULT_NAME` and `OPERATOR_KEY_SECRET_NAME`. |
339+
| E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes before running the Azure operator. |
340+
| E04 | ConfigurationValueError | A configuration value is invalid. Verify that the configuration values align with the required format and environment. Note: `debug_mode = true` is allowed only in the `integ` environment. Check the logs for more details. |
341+
| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. |
342+
| E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
343+
| E08 | OperatorKeyPermissionError | The managed identity (specified via the `operatorIdentifier` parameter) that launches the container must have access to the key vault where the operator key is stored. The value of `operatorIdentifier` must be identical across all configuration JSON files. |

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -519,3 +519,20 @@ If you previously set up a load balancer manually, you'll also need to update th
519519
520520
## Scraping Metrics
521521
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.
522+
523+
## UID2 Operator Error Codes
524+
525+
The following table lists errors that might occur during a Private Operator's startup sequence.
526+
527+
:::note
528+
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
529+
:::
530+
531+
| Error Code | Issue | Steps to Resolve |
532+
| :--- | :--- | :--- |
533+
| E02 | OperatorKeyNotFoundError | Make sure that the secret name specified exists in GCP Secret Manager in the same project as the operator, and that the service account has permission to access the secret. Make sure it's set to: `tee-env-API_TOKEN_SECRET_NAME`. If needed, you can check the logs for the specific secret name. |
534+
| E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes before running GCP operator. |
535+
| E04 | ConfigurationValueError | A configuration value is invalid. Verify that the configuration values align with the required format and environment. Note: `debug_mode = true` is allowed only in the `integ` environment. Check the logs for more details. |
536+
| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. |
537+
| E06 | UID2ServicesUnreachableError | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
538+
| E08 | OperatorKeyPermissionError | Attach a service account to the Compute Engine instance template. The UID2 Operator needs these permissions to access the operator key from the GCP Secret Manager. |

‎docs/snippets/_private-operator-release-matrix.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
| Q1 2024 | 5.26.19 | February 13, 2024 | [v5.26.19-56899dc0d7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.26.19-56899dc0d7) | 5.26.19-56899dc0d7 | [5.26.19-56899dc0d7 GCP ZIP](https://github.com/IABTechLab/uid2-operator/releases/download/v5.26.19-56899dc0d7/uid2-operator-deployment-artifacts-5.26.19-56899dc0d7-gcp-oidc.zip) | [5.26.19-56899dc0d7 Azure ZIP](https://github.com/IABTechLab/uid2-operator/releases/download/v5.26.19-56899dc0d7/uid2-operator-deployment-artifacts-5.26.19-56899dc0d7-azure-cc.zip) |
44
| Q2 2024 | 5.37.12 | June 12, 2024 | [v5.37.12](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.37.12) | 5.37.12 | [gcp-oidc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/gcp-oidc-deployment-files-5.37.12.zip) | [azure-cc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/azure-cc-deployment-files-5.37.12.zip) |
55
| Q3 2024 | 5.38.104 | September 12, 2024 | [v5.38.104](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.38.104) | 5.38.104 | [gcp-oidc-deployment-files-5.38.104.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.38.104/gcp-oidc-deployment-files-5.38.104.zip) | [azure-cc-deployment-files-5.38.104.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.38.104/azure-cc-deployment-files-5.38.104.zip) |
6-
| Q3 2024 Out-of-band | 5.41.0 | October 29, 2024 | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | 5.41.0 | [gcp-oidc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/gcp-oidc-deployment-files-5.41.0.zip) | [azure-cc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/azure-cc-deployment-files-5.41.0.zip) |
6+
| Q3 2024 Out-of-band | 5.41.0 | October 29, 2024 | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | 5.41.0 | [gcp-oidc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/gcp-oidc-deployment-files-5.41.0.zip) | [azure-cc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/azure-cc-deployment-files-5.41.0.zip) |
7+
| Q1 2025 | 5.49.7 | Mar 19, 2025 | [v5.49.7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.49.7) | 5.49.7 | [gcp-oidc-deployment-files-5.49.7.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.49.7/gcp-oidc-deployment-files-5.49.7.zip) | [azure-cc-deployment-files-5.49.7.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.49.7/azure-cc-deployment-files-5.49.7.zip) |

‎i18n/ja/docusaurus-plugin-content-docs/current/snippets/_private-operator-release-matrix.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
| Q1 2024 | 5.26.19 | February 13, 2024 | [v5.26.19-56899dc0d7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.26.19-56899dc0d7) | 5.26.19-56899dc0d7 | [5.26.19-56899dc0d7 GCP ZIP](https://github.com/IABTechLab/uid2-operator/releases/download/v5.26.19-56899dc0d7/uid2-operator-deployment-artifacts-5.26.19-56899dc0d7-gcp-oidc.zip) | [5.26.19-56899dc0d7 Azure ZIP](https://github.com/IABTechLab/uid2-operator/releases/download/v5.26.19-56899dc0d7/uid2-operator-deployment-artifacts-5.26.19-56899dc0d7-azure-cc.zip) |
44
| Q2 2024 | 5.37.12 | June 12, 2024 | [v5.37.12](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.37.12) | 5.37.12 | [gcp-oidc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/gcp-oidc-deployment-files-5.37.12.zip) | [azure-cc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/azure-cc-deployment-files-5.37.12.zip) |
55
| Q3 2024 | 5.38.104 | September 12, 2024 | [v5.38.104](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.38.104) | 5.38.104 | [gcp-oidc-deployment-files-5.38.104.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.38.104/gcp-oidc-deployment-files-5.38.104.zip) | [azure-cc-deployment-files-5.38.104.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.38.104/azure-cc-deployment-files-5.38.104.zip) |
6-
| Q3 2024 Out-of-band | 5.41.0 | October 29, 2024 | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | 5.41.0 | [gcp-oidc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/gcp-oidc-deployment-files-5.41.0.zip) | [azure-cc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/azure-cc-deployment-files-5.41.0.zip) |
6+
| Q3 2024 Out-of-band | 5.41.0 | October 29, 2024 | [v5.41.0](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.41.0) | 5.41.0 | [gcp-oidc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/gcp-oidc-deployment-files-5.41.0.zip) | [azure-cc-deployment-files-5.41.0.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.41.0/azure-cc-deployment-files-5.41.0.zip) |
7+
| Q1 2025 | 5.49.7 | March 19, 2025 | [v5.49.7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.49.7) | 5.49.7 | [gcp-oidc-deployment-files-5.49.7.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.49.7/gcp-oidc-deployment-files-5.49.7.zip) | [azure-cc-deployment-files-5.49.7.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.49.7/azure-cc-deployment-files-5.49.7.zip) |

0 commit comments

Comments
 (0)