Skip to content

updating wordings + use snippet for runtime error section #976

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.

Sign up for GitHub

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

Merged
lizk886 merged 4 commits into from
Jan 8, 2026
Merged

updating wordings + use snippet for runtime error section #976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30d3c0b
updating wordings
lizk886 Jan 8, 2026
33da0b6
revert some changes
lizk886 Jan 8, 2026
996a1e6
use snippet for repetitive contents
lizk886 Jan 8, 2026
4f753ee
Add runtime errors snippet for private operator docs
lizk886 Jan 8, 2026
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
9 changes: 4 additions & 5 deletions docs/guides/operator-guide-aws-marketplace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure.mdx';
import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx';
import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx';

# UID2 Private Operator for AWS Integration Guide

Expand Down Expand Up @@ -379,7 +380,7 @@ Error codes for Private Operator issues are applicable only to release v5.49.7 a

### Startup Errors

The following errors occur during operator startup:
The following errors might occur during operator startup:

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
Expand All @@ -392,11 +393,9 @@ The following errors occur during operator startup:

### Runtime Errors

The following errors occur during operator runtime:
The following errors might 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/503 errors** - Temporary UID2 service issue, retry or contact UID2 support if persistent. |
<SnptRuntimeErrors />

## Technical Support

Expand Down
9 changes: 4 additions & 5 deletions docs/guides/operator-guide-azure-enclave.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure.mdx';
import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx';
import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx';

# UID2 Private Operator for Azure Integration Guide

Expand Down Expand Up @@ -357,7 +358,7 @@ Error codes for Private Operator issues are applicable only to release v5.49.7 a

### Startup Errors

The following errors occur during operator startup:
The following errors might occur during operator startup:

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
Expand All @@ -370,8 +371,6 @@ The following errors occur during operator startup:

### Runtime Errors

The following errors occur during operator runtime:
The following errors might 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/503 errors** - Temporary UID2 service issue, retry or contact UID2 support if persistent. |
<SnptRuntimeErrors />
9 changes: 4 additions & 5 deletions docs/guides/operator-private-gcp-confidential-space.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptAttestFailure from '../snippets/_snpt-private-operator-attest-failure.mdx';
import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx';
import SnptRuntimeErrors from '../snippets/_snpt-private-operator-runtime-errors.mdx';

# UID2 Private Operator for GCP Integration Guide

Expand Down Expand Up @@ -553,7 +554,7 @@ Error codes for Private Operator issues are applicable only to release v5.49.7 a

### Startup Errors

The following errors occur during operator startup:
The following errors might occur during operator startup:

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
Expand All @@ -566,8 +567,6 @@ The following errors occur during operator startup:

### Runtime Errors

The following errors occur during operator runtime:
The following errors might 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/503 errors** - Temporary UID2 service issue, retry or contact UID2 support if persistent. |
<SnptRuntimeErrors />
4 changes: 4 additions & 0 deletions docs/snippets/_snpt-private-operator-runtime-errors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
| Error Code | Issue | How to Identify in Logs | Steps to Resolve |
| :--- | :--- | :--- | :--- |
| E12 | Data Download Failure | Look for log messages containing `E12: Data Download Failure` or `Failed to load` errors from `RotatingStoreVerticle`. These messages include HTTP status codes (for example, `HTTP response code 403`) or exception types (for example, `exception: IOException`). | Check the HTTP status code or exception in the error message and resolve accordingly:<br/>**404 errors**: Verify that the operator key is valid for the environment.<br/>**403 errors**: Verify that the operator key and credentials are correct.<br/>**Timeout errors**: Verify network connectivity, check that firewall/security group settings allow outbound HTTPS (port 443), and ensure that the UID2 service endpoints are accessible.<br/>**500/503 errors**: This code indicates a temporary UID2 service issue. Retry, and if the error persists contact UID2 support. |

Loading