Skip to content

Create custom exceptions and link it to website #1232

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

Jump to bottom
Merged
abuabraham-ttd merged 6 commits into from
Jan 2, 2025
Merged

Create custom exceptions and link it to website #1232

abuabraham-ttd merged 6 commits into from
Jan 2, 2025

Conversation

@abuabraham-ttd
Copy link
Contributor

@abuabraham-ttd abuabraham-ttd commented Dec 27, 2024 •
edited
Loading

When IAM role is not attached


Dec 27 22:10:29 ip-172-31-30-140.ec2.internal systemd[1]: Starting uid2operator.service - Starter service for UID2 Operator Enclave...
Dec 27 22:10:30 ip-172-31-30-140.ec2.internal uid2operator[3424]: Running in us-east-1
Dec 27 22:10:30 ip-172-31-30-140.ec2.internal uid2operator[3424]: Failed starting up Confidential Compute. Please checks the logs for errors and retry
Dec 27 22:10:30 ip-172-31-30-140.ec2.internal uid2operator[3424]: E01: MissingInstanceProfile
Dec 27 22:10:30 ip-172-31-30-140.ec2.internal uid2operator[3424]: Visit https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#uid2-operator-error-codes for more details

When Secret manager does not exist

Dec 27 22:17:10 ip-172-31-22-85.ec2.internal uid2operator[2530]: Running in us-east-1
Dec 27 22:17:10 ip-172-31-22-85.ec2.internal uid2operator[2530]: Failed starting up Confidential Compute. Please checks the logs for errors and retry
Dec 27 22:17:10 ip-172-31-22-85.ec2.internal uid2operator[2530]: E02: ConfigNotFound
Dec 27 22:17:10 ip-172-31-22-85.ec2.internal uid2operator[2530]: Secret Manager uid2-stack-some-random in us-east-1
Dec 27 22:17:10 ip-172-31-22-85.ec2.internal uid2operator[2530]: Visit https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#uid2-operator-error-codes  for more details

If debug mode is enabled in prod


Dec 27 22:20:38 ip-172-31-22-85.ec2.internal uid2operator[3194]: Running in us-east-1
Dec 27 22:20:38 ip-172-31-22-85.ec2.internal uid2operator[3194]: Fetched configs from uid2-stack-some-random
Dec 27 22:20:38 ip-172-31-22-85.ec2.internal uid2operator[3194]: Validating configurations provided
Dec 27 22:20:38 ip-172-31-22-85.ec2.internal uid2operator[3194]: Failed starting up Confidential Compute. Please checks the logs for errors and retry
Dec 27 22:20:38 ip-172-31-22-85.ec2.internal uid2operator[3194]: E04: InvalidConfigValue
Dec 27 22:20:38 ip-172-31-22-85.ec2.internal uid2operator[3194]: debug_mode
Dec 27 22:20:38 ip-172-31-22-85.ec2.internal uid2operator[3194]: Visit https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#uid2-operator-error-codes  for more details

When integ key is used in prod

Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: Running in us-east-1
Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: Fetched configs from uid2-stack-some-random
Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: Validating configurations provided
Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: Validated https://core-integ.uidapi.com/ matches other config parameters
Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: Validated https://optout-integ.uidapi.com/ matches other config parameters
Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: Failed starting up Confidential Compute. Please checks the logs for errors and retry
Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: E05: InvalidOperatorKey
Dec 27 22:21:56 ip-172-31-22-85.ec2.internal uid2operator[3266]: Visit https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#uid2-operator-error-codes for more details

When core URL does not match environment

Dec 27 22:23:45 ip-172-31-22-85.ec2.internal uid2operator[3348]: Running in us-east-1
Dec 27 22:23:45 ip-172-31-22-85.ec2.internal uid2operator[3348]: Fetched configs from uid2-stack-some-random
Dec 27 22:23:45 ip-172-31-22-85.ec2.internal uid2operator[3348]: Validating configurations provided
Dec 27 22:23:45 ip-172-31-22-85.ec2.internal uid2operator[3348]: Failed starting up Confidential Compute. Please checks the logs for errors and retry
Dec 27 22:23:45 ip-172-31-22-85.ec2.internal uid2operator[3348]: E04: InvalidConfigValue
Dec 27 22:23:45 ip-172-31-22-85.ec2.internal uid2operator[3348]: core_base_url
Dec 27 22:23:45 ip-172-31-22-85.ec2.internal uid2operator[3348]: Visit https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#uid2-operator-error-codes for more details

When required configs are missing


Dec 27 22:25:13 ip-172-31-22-85.ec2.internal uid2operator[3422]: Running in us-east-1
Dec 27 22:25:13 ip-172-31-22-85.ec2.internal uid2operator[3422]: Fetched configs from uid2-stack-some-random
Dec 27 22:25:13 ip-172-31-22-85.ec2.internal uid2operator[3422]: Validating configurations provided
Dec 27 22:25:13 ip-172-31-22-85.ec2.internal uid2operator[3422]: Failed starting up Confidential Compute. Please checks the logs for errors and retry
Dec 27 22:25:13 ip-172-31-22-85.ec2.internal uid2operator[3422]: E03: MissingConfig
Dec 27 22:25:13 ip-172-31-22-85.ec2.internal uid2operator[3422]: Missing configuration keys: core_base_url, environment
Dec 27 22:25:13 ip-172-31-22-85.ec2.internal uid2operator[3422]: Visit https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#uid2-operator-error-codes for more details

@abuabraham-ttd abuabraham-ttd self-assigned this Dec 27, 2024
@abuabraham-ttd abuabraham-ttd force-pushed the abu-UID2-4490-link-public-doc branch from 05c3c9d to 881cafb Compare December 27, 2024 21:15
@abuabraham-ttd abuabraham-ttd force-pushed the abu-UID2-4490-link-public-doc branch from d426b91 to 639d95e Compare December 27, 2024 23:40
@abuabraham-ttd abuabraham-ttd merged commit c3b2f03 into main Jan 2, 2025
4 checks passed
@abuabraham-ttd abuabraham-ttd deleted the abu-UID2-4490-link-public-doc branch January 2, 2025 22:42
sunnywu
sunnywu reviewed Jan 6, 2025
View reviewed changes
scripts/confidential_compute.py

class MissingInstanceProfile(ConfidentialComputeStartupException):
def __init__(self, cls):
super().__init__(error_name=f"E01: {self.__class__.__name__}", provider=cls)
Copy link
Contributor

@sunnywu sunnywu Jan 6, 2025

Choose a reason for hiding this comment

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

not sure if you have tried @abuabraham-ttd - the URL may be anchored to the specific error code like the glossary page, e.g. https://unifiedid.com/docs/ref-info/glossary-uid#gl-client-key

maybe like:
https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#uid2-operator-error-codes#gl-e01

so people can just see the right error code straight away

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sunnywu sunnywu sunnywu left review comments

@Ian-Nara Ian-Nara Ian-Nara approved these changes

@cody-constine-ttd cody-constine-ttd Awaiting requested review from cody-constine-ttd

Assignees

@abuabraham-ttd abuabraham-ttd

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@abuabraham-ttd @sunnywu @Ian-Nara