Skip to content

Commit c20e3eb

Browse files
Add error descriptions and error code for general UID2 setup errors (#792)
* Add error codes and messages for AWS operator
1 parent 595231b commit c20e3eb

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,23 @@ 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+
## UID2 Operator Error Codes
354+
355+
The following table lists possible errors while setting up a Private Operator.
356+
357+
:::note
358+
This applies only to Private Operators starting from Q2 2024.
359+
:::
360+
361+
| Error Code | Issue | Steps to Resolve |
362+
| :--- | :--- | :--- |
363+
| AW01 | MissingInstanceProfile | 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. |
364+
| AW02 | ConfigNotFound | 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. |
365+
| AW03 | MissingConfig | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes in Secrets Manager. |
366+
| AW04 | InvalidConfigValue | A configuration value is invalid. Verify that the configuration values in the AWS Secrets Manager align with the required format and environment. Note `debug = true` is allowed only in the `integ` environment. Check the logs for more details. |
367+
| AW05 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. |
368+
| AW06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IP addresses in the egress firewall. For IP addresses and DNS details, refer to the logs. |
369+
353370
## Technical Support
354371

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

0 commit comments

Comments
 (0)