Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding GCP and Azure doc #803

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/guides/operator-guide-azure-enclave.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,3 +324,21 @@ 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This information was already pulled back: we should not include future error information in public documentation. Doc is for current products not future. Q2 2025 is very far in the future. Is there any current error information we can release?

:::

| Error Code | Issue | Steps to Resolve |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be good to add a small section that says, if operator.json is modified the cce policy will change and containers wont start

| :--- | :--- | :--- |
| E02 | OperatorKeyNotFound | 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 | MissingConfig | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes while running Azure operator. |
| E04 | InvalidConfigValue | 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 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. |
| E06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
| E07 | AuxiliariesException | The attestation sidecar failed to start due to an Azure environment configuration issue. Please refer to the logs for more details. |
| E08 | OperatorKeyAccessDenied | 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. |
17 changes: 17 additions & 0 deletions docs/guides/operator-private-gcp-confidential-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This information was already pulled back: we should not include future error information in public documentation. Doc is for current products not future. Q2 2025 is very far in the future. Is there any current error information we can release?

:::

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
| E02 | OperatorKeyNotFound | 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 | MissingConfig | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes while running GCP operator. |
| E04 | InvalidConfigValue | 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 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. |
| E06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
| E08 | OperatorKeyAccessDenied | Attach a service account to compute's instance template. The UID2 Operator needs these permissions to access operator key from GCP Secrets Manager. |
Loading