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.

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

Add error descriptions and error code for general UID2 setup errors #792

Merged
merged 9 commits into from
Dec 23, 2024
Merged

Add error descriptions and error code for general UID2 setup errors #792

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0b8db6a
Add error descriptions and error code for general UID2 setup errors
abuabraham-ttd Dec 20, 2024
ab70ee1
Update operator-guide-aws-marketplace.md
abuabraham-ttd Dec 21, 2024
3466a81
Add version
abuabraham-ttd Dec 23, 2024
c5abc9b
Add error code to be AW instead of E
abuabraham-ttd Dec 23, 2024
2206944
Update on review
abuabraham-ttd Dec 23, 2024
692e848
Update on review
abuabraham-ttd Dec 23, 2024
b7563c5
Update on review
abuabraham-ttd Dec 23, 2024
604b7cd
Update on review
abuabraham-ttd Dec 23, 2024
450cac3
Update on review
abuabraham-ttd Dec 23, 2024
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
17 changes: 17 additions & 0 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 @@ -350,6 +350,23 @@ The following table includes some additional commands that might help you manage
| Runs one iteration of `logrotate` manually, without changing the scheduled interval. | `sudo logrotate -f /etc/logrotate.conf --force` |
| Reloads `syslog-ng`. | `sudo /usr/sbin/syslog-ng-ctl reload` |

### UID2 Operator error codes
abuabraham-ttd marked this conversation as resolved.
Show resolved Hide resolved

The following table lists possible errors while setting up private operator.
abuabraham-ttd marked this conversation as resolved.
Show resolved Hide resolved

:::note
This applies only to Private Operators starting from Q2 2024.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not very clear - it somewhat sounds like existing private operator will magically show these error code from Q2 2024. Should be more like:

Only Private Operators versions released on and after Q2 2024 will present these error codes if private operator startup issues are encountered

Copy link
Contributor Author

Choose a reason for hiding this comment

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

change to

"Error codes for private operator startup issues will only appear in versions released from Q2 2024 onward."

?

Copy link
Collaborator

@genwhittTTD genwhittTTD Dec 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yes that's better. Though, best not to use future tense. My suggestion:
Error codes for Private Operator startup issues apply to versions released from Q2 2024 and later.

:::

| Error Code | Issue | Steps to Resolve |
| :--- | :--- | :--- |
| 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. |
abuabraham-ttd marked this conversation as resolved.
Show resolved Hide resolved
| AW02 | ConfigNotFound | Ensure the secret referenced by the operator exists in AWS Secrets Manager in the same region as the operator. And verify that the IAM instance profile has permission to access it. Check the logs the specific secret name and region. |
abuabraham-ttd marked this conversation as resolved.
Show resolved Hide resolved
| AW03 | MissingConfig | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes in Secrets Manager. |
| AW04 | InvalidConfigValue | A configuration value is invalid. Verify the configuration values in Secrets Manager align with the required format and environment. Note `debug = true` is allowed only in the `integ` environment. Check the logs for mode details. |
abuabraham-ttd marked this conversation as resolved.
Show resolved Hide resolved
| AW05 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. |
| AW06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IPs in the egress firewall. Refer to logs for IPs and DNS details. |
abuabraham-ttd marked this conversation as resolved.
Show resolved Hide resolved

## Technical Support

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