Ensure SSL changes are logged. #5423
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
added 2 commits
January 11, 2021 17:09
There are three endpoints (Add, Generate, Delete) that manipulate SSL certificates for a delivery service. (Actually there are more with the Let's Encrypt ACME endpoints, but those have a different changelog order of operations). These all must log their action in the Changelog for verification and confirmation when the actions complete. Generate and Delete succesfully log the changes, however Add was apparently not. In fact, there are two successful cases where the SSL keys could be added and the endpoint would return prematurely, preventing the action from being logged in the Changelog. The Changelog entry is now performed before the return of these two logic flows. Additionally added a comment to a public package function (Generate) and clarified language within the Changelog messages.
mitchell852
added
Traffic Ops
mattjackson220
approved these changes
Jan 15, 2021
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.
There are three endpoints (Add, Generate, Delete) that manipulate SSL certificates
for a delivery service. (Actually there are more with the Let's Encrypt ACME
endpoints, but those have a different changelog order of operations). These all
must log their action in the Changelog for verification and confirmation when
the actions complete. Generate and Delete succesfully log the changes, however
Add was apparently not.
In fact, there are two successful cases where the SSL keys could be added and
the endpoint would return prematurely, preventing the action from being logged
in the Changelog. The Changelog entry is now performed before the return of
these two logic flows.
Additionally added a comment to a public package function (Generate) and clarified
language within the Changelog messages.
What does this PR (Pull Request) do?
Which Traffic Control components are affected by this PR?
What is the best way to verify this PR?
This PR can be validated by performing curl requests against the various endpoints.
You will need to replace the values where appropriate to work with your dataset (hostname, deliveryservice, key, cookies, etc.) Alternatively you can utilize TP for the Generate and Add/Update, but will need to use the
curlcall to Delete.Generate example
Add / Update example
Delete
If this is a bug fix, what versions of Traffic Control are affected?
master (0ad2086)
The following criteria are ALL met by this PR
Additional Information