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.

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

improve readme and error messages #335

Merged
merged 2 commits into from
Jun 5, 2024

Conversation

webern
Copy link
Contributor

@webern webern commented May 14, 2024

Issue #, if available:

Closes #334

Description of changes:

    readme: describe credentials behavio
    better error message for misconfiguration

    If AWS credentials are missing, i.e. there is no profile information
    in ~/.aws, and no other source of credentials, then coldsnap would
    provide this unhelpful error message:

    Failed to download snapshot: Failed to list snapshot blocks 'snapid'.

    We now print the underlying error as well, which is at least a little
    bit more helpful:

    Failed to download snapshot: Failed to list snapshot blocks 'snapid':
    dispatch failure: other: Invalid Configuration: Missing Region

Testing

Uploaded and Downloaded Snapshots. The error messages were like this before:

Failed to download snapshot: Failed to list snapshot blocks 'snap-0a5cdf61910a948d8': dispatch failure

Failed to upload snapshot: Failed to start snapshot: dispatch failure

And like this after

Failed to download snapshot: Failed to list snapshot blocks 'snap-0a5cdf61910a948d8': dispatch failure: other: Invalid Configuration: Missing Region

Failed to upload snapshot: Failed to start snapshot: dispatch failure: other: Invalid Configuration: Missing Region

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

If AWS credentials are missing, i.e. there is no profile information
in ~/.aws, and no other source of credentials, then coldsnap would
provide this unhelpful error message:

Failed to download snapshot: Failed to list snapshot blocks 'snapid'.

We now print the underlying error as well, which is at least a little
bit more helpful:

Failed to download snapshot: Failed to list snapshot blocks 'snapid':
dispatch failure: other: Invalid Configuration: Missing Region
@webern webern requested review from rpkelly and bcressey May 14, 2024 18:02
@webern
Copy link
Contributor Author

webern commented Jun 4, 2024

bump

@webern webern merged commit b0d1d67 into awslabs:develop Jun 5, 2024
2 checks passed
@webern webern deleted the readme-and-error-messages branch June 5, 2024 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add requirements to README
4 participants