diff --git a/docs/guides/operator-guide-azure-enclave.md b/docs/guides/operator-guide-azure-enclave.md index a866f96b4..c5b01707f 100644 --- a/docs/guides/operator-guide-azure-enclave.md +++ b/docs/guides/operator-guide-azure-enclave.md @@ -324,3 +324,20 @@ To upgrade, complete the following steps: ``` for i in {0..COUNT}; az container delete --name uid-operator-OLD-VERSION-$i --resource-group {RESOURCE_GROUP} --yes ``` + +## UID2 Operator Error Codes + +The following table lists errors that might occur during a Private Operator's startup sequence. + +:::note +Error codes for Private Operator startup issues apply only to versions released in Q2 2025 and later. +::: + +| Error Code | Issue | Steps to Resolve | +| :--- | :--- | :--- | +| E02 | OperatorKeyNotFoundError | Make sure that the secret vault and secret name that store operator key are correctly configured. You set them as `VAULT_NAME` and `OPERATOR_KEY_SECRET_NAME`. | +| E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes while running Azure operator. | +| E04 | ConfigurationValueError | A configuration value is invalid. Verify that the configuration values align with the required format and environment. Note `debug = true` is allowed only in the `integ` environment. Check the logs for more details. | +| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. | +| 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. | +| 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. | \ No newline at end of file diff --git a/docs/guides/operator-private-gcp-confidential-space.md b/docs/guides/operator-private-gcp-confidential-space.md index 11c2b1e60..e8c6eff6e 100644 --- a/docs/guides/operator-private-gcp-confidential-space.md +++ b/docs/guides/operator-private-gcp-confidential-space.md @@ -519,3 +519,20 @@ If you previously set up a load balancer manually, you'll also need to update th ## Scraping Metrics 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. + +## UID2 Operator Error Codes + +The following table lists errors that might occur during a Private Operator's startup sequence. + +:::note +Error codes for Private Operator startup issues apply only to versions released in Q2 2025 and later. +::: + +| Error Code | Issue | Steps to Resolve | +| :--- | :--- | :--- | +| E02 | OperatorKeyNotFoundError | Make sure that the secret name specified while running the Private Operator exists in GCP Secrets Manager in the same project as the operator, and that the service account has permission to access the secret. You set it as `tee-env-API_TOKEN_SECRET_NAME`. If needed, you can check the logs for the specific secret name. | +| E03 | ConfigurationMissingError | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes while running GCP operator. | +| E04 | ConfigurationValueError | A configuration value is invalid. Verify that the configuration values align with the required format and environment. Note `debug = true` is allowed only in the `integ` environment. Check the logs for more details. | +| E05 | OperatorKeyValidationError | Ensure the operator key is correct for the environment and matches the one provided to you. | +| 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. | +| E08 | OperatorKeyPermissionError | Attach a service account to compute's instance template. The UID2 Operator needs these permissions to access operator key from GCP Secrets Manager. |