Add task to create new public api keys #5826
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5826 +/- ##
========================================
Coverage 85.77% 85.77%
========================================
Files 81 81
Lines 8624 8624
========================================
Hits 7397 7397
Misses 1227 1227 ☔ View full report in Codecov by Sentry. |
tmpayton
force-pushed
the
feature/5802-create-api-key
branch
from
05f43ba
to
89914d8
Compare
pkfec
reviewed
May 15, 2024
There was a problem hiding this comment.
- Finalize FEC_EMAIL we want to use while creating a API keys. Currently we use webappalerts@fec.gov to create API keys in the umbrella.
- Use the existing
cms-creds-devservice instead of creating a new one - Add the API key creation instructions to a wiki
pkfec
reviewed
May 15, 2024
pkfec
reviewed
May 23, 2024
|
@pkfec thank you for the review, I implemented your changes! |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary (required)
This ticket adds a the new
update_public_api_keytask. The PMs decided that this task should only create a new API key and add it to our environment variables. After that, the developer can manually re-stage the app and disable the old key. Here is the wiki page.The new command is:
cf run-task api --command "python cli.py update_public_api_key <space> <service_instance> '$(< token.txt)' <first_rate_limit> <first_rate_limit_duration> <second_rate_limit> <second_rate_limit_duration>" --name update_public_api_keyThe arguments are:
space: [Required] the space that you want to updateservice_instance: [Required] the user provided service you want to updatetoken: [Required] your cf oath tokenfirst_rate_limit: [Optional] the limit of the first rate limit on the new keyfirst_rate_limit_duration[Optional] the duration of the first rate limit on the new keysecond_rate_limit[Optional] the limit of the second rate limit on the new keysecond_rate_limit_duration[Optional] the duration of the second rate limit on the new keyA typical example would be:
cf run-task api --command "python cli.py update_public_api_key dev tricia-test '$(< token.txt)' " --name update_public_api_keyI also added these new environment variables:
FEC_EMAIL: currently set to my email for testing purposes, I'll change this once testing is completedUMBRELLA_ADMIN_AUTH_TOKEN: Auth token to access API UmbrellaRequired reviewers 2 - 3 developers
Impacted areas of the application
General components of the application that this PR will affect:
How to test
Locally:
git checkout test-create-api-keypyenv activate <your virtual environment>SLACK_HOOK,UMBRELLA_ADMIN_AUTH_TOKEN,FEC_EMAIL,FEC_WEB_API_KEY_PUBLICcf login -a api.fr.cloud.gov --sso(space does not matter when testing locally)cf oauth-token > token.txtpython cli.py update_public_api_key dev tricia-test "$(< token.txt)"On Dev:
cf login -a api.fr.cloud.gov --ssocf oauth-token > token.txtcf run-task api --command "python cli.py update_public_api_key dev tricia-test '$(< token.txt)' " --name update_public_api_keyNOTE: Cf tokens last for about 4 minutes before needing another one