Skip to content
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
16 changes: 16 additions & 0 deletions docs/guides/operator-guide-aks-enclave.md
Original file line number Diff line number Diff line change
Expand Up @@ -447,3 +447,19 @@ To upgrade, complete the following steps:
```
kubectl get pods
```

## UID2 Operator Error Codes

The following sections list error codes that might occur during a Private Operator's runtime.

:::note
Error codes for Private Operator issues are applicable only to release v5.49.7 and later.
:::

### Runtime Errors

The following errors occur during operator runtime:

| Error Code | Issue | How to Identify in Logs | Steps to Resolve |
| :--- | :--- | :--- | :--- |
| E12 | Data Download Failure | Look for log messages containing `"E12: Data Download Failure"` along with `"Failed to load"` errors from `RotatingStoreVerticle`. These will include HTTP status codes (e.g., `"HTTP response code 403"`) or exception types (e.g., `"exception: IOException"`). | Check the HTTP status code or exception in the error message: <br/>**404 errors** - Verify operator key is valid for the environment.<br/>**403 errors** - Verify operator key and credentials are correct.<br/>**Timeout errors** - Verify network connectivity, check NSG/firewall rules allow outbound HTTPS (port 443), and ensure UID2 service endpoints are accessible.<br/>**500 errors** - Temporary UID2 service issue, retry or contact UID2 support if persistent. |
16 changes: 14 additions & 2 deletions docs/guides/operator-guide-aws-marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,12 +361,16 @@ The following table includes some additional commands that might help you manage

## UID2 Operator Error Codes

The following table lists errors that might occur during a Private Operator's startup sequence.
The following sections list error codes that might occur during a Private Operator's startup or runtime.

:::note
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
Error codes for Private Operator issues are applicable only to release v5.49.7 and later.
:::

### Startup Errors

The following errors occur during operator startup:

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
| 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. |
Expand All @@ -376,6 +380,14 @@ Error codes for Private Operator startup issues are applicable only to release v
| 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. |

### Runtime Errors

The following errors occur during operator runtime:

| Error Code | Issue | How to Identify in Logs | Steps to Resolve |
| :--- | :--- | :--- | :--- |
| E12 | Data Download Failure | Look for log messages containing `"E12: Data Download Failure"` along with `"Failed to load"` errors from `RotatingStoreVerticle`. These will include HTTP status codes (e.g., `"HTTP response code 403"`) or exception types (e.g., `"exception: IOException"`). | Check the HTTP status code or exception in the error message: <br/>**404 errors** - Verify operator key is valid for the environment.<br/>**403 errors** - Verify operator key and credentials are correct.<br/>**Timeout errors** - Verify network connectivity, check firewall/security group settings allow outbound HTTPS (port 443), and ensure UID2 service endpoints are accessible.<br/>**500 errors** - Temporary UID2 service issue, retry or contact UID2 support if persistent. |

## Technical Support

If you have trouble subscribing to the product, or deploying, [contact us](mailto:aws-mktpl-uid@thetradedesk.com).
18 changes: 15 additions & 3 deletions docs/guides/operator-guide-azure-enclave.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,17 +337,29 @@ To upgrade, complete the following steps:

## UID2 Operator Error Codes

The following table lists errors that might occur during a Private Operator's startup sequence.
The following sections list error codes that might occur during a Private Operator's startup or runtime.

:::note
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
Error codes for Private Operator issues are applicable only to release v5.49.7 and later.
:::

### Startup Errors

The following errors occur during operator startup:

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
| 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`. |
| 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. |
| 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. |
| 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. |
| 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. |

### Runtime Errors

The following errors occur during operator runtime:

| Error Code | Issue | How to Identify in Logs | Steps to Resolve |
| :--- | :--- | :--- | :--- |
| E12 | Data Download Failure | Look for log messages containing `"E12: Data Download Failure"` along with `"Failed to load"` errors from `RotatingStoreVerticle`. These will include HTTP status codes (e.g., `"HTTP response code 403"`) or exception types (e.g., `"exception: IOException"`). | Check the HTTP status code or exception in the error message: <br/>**404 errors** - Verify operator key is valid for the environment.<br/>**403 errors** - Verify operator key and credentials are correct.<br/>**Timeout errors** - Verify network connectivity, check NSG/firewall rules allow outbound HTTPS (port 443), and ensure UID2 service endpoints are accessible.<br/>**500 errors** - Temporary UID2 service issue, retry or contact UID2 support if persistent. |
16 changes: 14 additions & 2 deletions docs/guides/operator-private-gcp-confidential-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,12 +532,16 @@ The Private Operator for GCP exposes [Prometheus-formatted metrics](https://prom

## UID2 Operator Error Codes

The following table lists errors that might occur during a Private Operator's startup sequence.
The following sections list error codes that might occur during a Private Operator's startup or runtime.

:::note
Error codes for Private Operator startup issues are applicable only to release v5.49.7 and later.
Error codes for Private Operator issues are applicable only to release v5.49.7 and later.
:::

### Startup Errors

The following errors occur during operator startup:

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
| 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. |
Expand All @@ -546,3 +550,11 @@ Error codes for Private Operator startup issues are applicable only to release v
| 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 the Compute Engine instance template. The UID2 Operator needs these permissions to access the operator key from the GCP Secret Manager. |

### Runtime Errors

The following errors occur during operator runtime:

| Error Code | Issue | How to Identify in Logs | Steps to Resolve |
| :--- | :--- | :--- | :--- |
| E12 | Data Download Failure | Look for log messages containing `"E12: Data Download Failure"` along with `"Failed to load"` errors from `RotatingStoreVerticle`. These will include HTTP status codes (e.g., `"HTTP response code 403"`) or exception types (e.g., `"exception: IOException"`). | Check the HTTP status code or exception in the error message: <br/>**404 errors** - Verify operator key is valid for the environment.<br/>**403 errors** - Verify operator key and credentials are correct.<br/>**Timeout errors** - Verify network connectivity, check VPC firewall rules allow outbound HTTPS (port 443), and ensure UID2 service endpoints are accessible.<br/>**500 errors** - Temporary UID2 service issue, retry or contact UID2 support if persistent. |