Improve Docs for SQS Authentication #9868
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the SQS broker documentation to clarify a common pitfall while setting up Celery with SQS.
Problem: The current documentation shows how to URL-encode AWS credentials for the broker URL using
safequote(), but doesn't clarify that these encoded credentials should NOT be used in thepredefined_queuesconfiguration. Doing so will throw an error that looks something like this
This docs change should make the SQS setup more reliable and intuitive for users working with predefined queues.