Add error descriptions and error code for general UID2 setup errors #792
Conversation
| | 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. | | ||
| | 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. | | ||
| | 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 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 mode details. | |
There was a problem hiding this comment.
more details, not mode details. Also added a colon after Note.
Use this:
| 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. |
| The following table lists possible errors while setting up a Private Operator. | ||
|
|
||
| :::note | ||
| This applies only to Private Operators starting from Q2 2024. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
change to
"Error codes for private operator startup issues will only appear in versions released from Q2 2024 onward."
?
There was a problem hiding this comment.
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.
| @@ -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 | |||
|
|
|||
| The following table lists possible errors while setting up a Private Operator. | |||
There was a problem hiding this comment.
The following table lists possible errors presented in the startup sequence of a Private Operator.
There was a problem hiding this comment.
I will also change error codes to be just E01, E02 etc and not AW, AZ, GC. Since it is generic errors pointing to provider specific web page. (Also it minimizes conditions in generic exception handler)
See: https://github.com/IABTechLab/uid2-operator/pull/1232/files
No description provided.