From 0b8db6ac46aaebf98f56cb040f8eace0d85703e5 Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Fri, 20 Dec 2024 14:42:45 -0800 Subject: [PATCH 1/9] Add error descriptions and error code for general UID2 setup errors --- docs/guides/operator-guide-aws-marketplace.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index 5053bc6e9..d32fd1ee6 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -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 private operator. + +:::note +This is applicable only for version XXXX or later of Private Operators. +::: + +| ErrorCode | Error | How to fix | +| :--- | :--- | :--- | +| E01 | 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. | +| E02 | 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. | +| E03 | MissingConfig | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes in Secrets Manager. | +| E04 | 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. | +| E05 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. | +| E06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IPs in the egress firewall. Refer to logs for IPs and DNS details. | + ## Technical Support If you have trouble subscribing to the product, or deploying, [contact us](mailto:aws-mktpl-uid@thetradedesk.com). From ab70ee1db37706255395e39a643a25f30cda4ecd Mon Sep 17 00:00:00 2001 From: abuabraham-ttd <130511456+abuabraham-ttd@users.noreply.github.com> Date: Fri, 20 Dec 2024 17:41:38 -0800 Subject: [PATCH 2/9] Update operator-guide-aws-marketplace.md --- docs/guides/operator-guide-aws-marketplace.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index d32fd1ee6..e788f7c16 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -358,7 +358,7 @@ The following table lists possible errors while setting up private operator. This is applicable only for version XXXX or later of Private Operators. ::: -| ErrorCode | Error | How to fix | +| Error Code | Issue | Steps to Resolve | | :--- | :--- | :--- | | E01 | 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. | | E02 | 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. | From 3466a81f182079fd7912950f9ef09b82ebf431d5 Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Mon, 23 Dec 2024 09:08:37 -0800 Subject: [PATCH 3/9] Add version --- docs/guides/operator-guide-aws-marketplace.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index e788f7c16..85767da9a 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -355,7 +355,7 @@ The following table includes some additional commands that might help you manage The following table lists possible errors while setting up private operator. :::note -This is applicable only for version XXXX or later of Private Operators. +This applies only to Private Operators starting from Q2 2024. ::: | Error Code | Issue | Steps to Resolve | @@ -363,7 +363,7 @@ This is applicable only for version XXXX or later of Private Operators. | E01 | 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. | | E02 | 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. | | E03 | MissingConfig | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes in Secrets Manager. | -| E04 | 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. | +| E04 | 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. | | E05 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. | | E06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IPs in the egress firewall. Refer to logs for IPs and DNS details. | From c5abc9bfe63812d3823c1c0aaf65225fcf15f703 Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Mon, 23 Dec 2024 09:17:09 -0800 Subject: [PATCH 4/9] Add error code to be AW instead of E --- docs/guides/operator-guide-aws-marketplace.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index 85767da9a..4b85cfd39 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -360,12 +360,12 @@ This applies only to Private Operators starting from Q2 2024. | Error Code | Issue | Steps to Resolve | | :--- | :--- | :--- | -| E01 | 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. | -| E02 | 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. | -| E03 | MissingConfig | Required attributes are missing in the configuration. Refer to the logs for details and update the missing attributes in Secrets Manager. | -| E04 | 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. | -| E05 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. | -| E06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IPs in the egress firewall. Refer to logs for IPs and DNS details. | +| 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 | 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. | +| 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. | +| 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. | ## Technical Support From 2206944f4bc1a376f44b1ac5c01e2d258d148d66 Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Mon, 23 Dec 2024 11:51:43 -0800 Subject: [PATCH 5/9] Update on review --- docs/guides/operator-guide-aws-marketplace.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index 4b85cfd39..c55b1c909 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -350,9 +350,9 @@ 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 +## UID2 Operator Error Codes -The following table lists possible errors while setting up private operator. +The following table lists possible errors while setting up Private Operator. :::note This applies only to Private Operators starting from Q2 2024. @@ -363,9 +363,9 @@ This applies only to Private Operators starting from Q2 2024. | 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 | 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. | | 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. | +| 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. | | 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. | +| AW06 | UID2ServicesUnreachable | Allow UID2 core and opt-out service IP addresses in the egress firewall. Refer to logs for IPs and DNS details. | ## Technical Support From 692e84800bdc944039b5c802873a85ca8807bd99 Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Mon, 23 Dec 2024 12:02:28 -0800 Subject: [PATCH 6/9] Update on review --- docs/guides/operator-guide-aws-marketplace.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index c55b1c909..a6ca9459f 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -361,7 +361,7 @@ This applies only to Private Operators starting from Q2 2024. | 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. | -| 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. | +| AW02 | ConfigNotFound | Take the following steps:
- Make sure that the secret referenced by the Private Operator exists in AWS Secrets Manager in the same region as the operator.
- Verify that the IAM instance profile has permission to access the secret.
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. | | AW05 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. | From b7563c5c3db4bc8d853f4234f06d0b317225255a Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Mon, 23 Dec 2024 12:10:50 -0800 Subject: [PATCH 7/9] Update on review --- docs/guides/operator-guide-aws-marketplace.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index a6ca9459f..04c8d552e 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -361,7 +361,7 @@ This applies only to Private Operators starting from Q2 2024. | 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. | -| AW02 | ConfigNotFound | Take the following steps:
- Make sure that the secret referenced by the Private Operator exists in AWS Secrets Manager in the same region as the operator.
- Verify that the IAM instance profile has permission to access the secret.
You can check the logs for the specific secret name and region. | +| 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. | | AW05 | InvalidOperatorKey | Ensure the operator key is correct for the environment and matches the one provided to you. | From 604b7cd685f9f5c1d812002f07778b3873e2f6b0 Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Mon, 23 Dec 2024 12:19:33 -0800 Subject: [PATCH 8/9] Update on review --- docs/guides/operator-guide-aws-marketplace.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index 04c8d552e..d2e27325d 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -352,7 +352,7 @@ The following table includes some additional commands that might help you manage ## UID2 Operator Error Codes -The following table lists possible errors while setting up Private Operator. +The following table lists possible errors while setting up a Private Operator. :::note This applies only to Private Operators starting from Q2 2024. From 450cac36413a5344fba78be43d75cb94ee5a5601 Mon Sep 17 00:00:00 2001 From: abuabraham-ttd Date: Mon, 23 Dec 2024 12:28:38 -0800 Subject: [PATCH 9/9] Update on review --- docs/guides/operator-guide-aws-marketplace.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index d2e27325d..34e7843ca 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -363,9 +363,9 @@ This applies only to Private Operators starting from Q2 2024. | 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. | +| 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. | | 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 IP addresses in the egress firewall. Refer to logs for IPs and DNS details. | +| 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. | ## Technical Support