[IT-3523] Update Service Catalog AMI testing docs #1306
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
Document the current manual process used for testing changes to AMIs used by service catalog products.
Update the documentation on how to perform functional and integration testing of AMIs used by service catalog products now that test artifacts are automatically created. Depends on Sage-Bionetworks-IT/packer-ami-template Depends on Sage-Bionetworks-IT/service-catalog-library
brucehoff
requested changes
Dec 16, 2024
| execute the validations by running `pre-commit run --all-files`. | ||
| Please install pre-commit, once installed the file validations will | ||
| automatically run on every commit. | ||
|
|
||
| ### Functional Testing | ||
| The process to test the functionality of an AMI and it's integration with our |
| account, allowing anyone with write access to the packer repos to create test | ||
| AMIs, and anyone with write access to service-catalog-library to upload test | ||
| templates for service catalog to S3. | ||
|
|
There was a problem hiding this comment.
all bullets are '1', below
| product template to S3, and create a new Service Catalog product in the | ||
| scipool dev account to verify manually from https://sc-dev.sageit.org/ | ||
|
|
||
| The deploy pipelines for both our packer repos and our service catalog library |
There was a problem hiding this comment.
Can you link to the "packer repo's"?
| templates for service catalog to S3. | ||
|
|
||
| 1. Commit changes to the packer repo to update or modify the AMI on a branch | ||
| that starts with `test/`, and push directly to the origin repo. |
There was a problem hiding this comment.
"to the origin repo'" -> "to the origin branch".
Can you please link the words "the packer repo" to the packer repo' URL?
| 1. Manually create an EC2 instance in the `itsandbox` account from the test AMI | ||
| for any initial system validation, then terminate it. | ||
| 1. Commit changes to `service-catalog-library` on a branch that starts with | ||
| `test/` to update the desired template, and push directly to the origin repo. |
| 1. Commit changes to `service-catalog-library` on a branch that starts with | ||
| `test/` to update the desired template, and push directly to the origin repo. | ||
| 1. Create a pull request for `organizations-infra` to add a new Service Catalog | ||
| product to `scipool-dev` with 'test' in the name for the test template. |
There was a problem hiding this comment.
Can you mention where the "product" templates are located in the repo'? How does the product reference the template in the previous step?
| execute the validations by running `pre-commit run --all-files`. | ||
| Please install pre-commit, once installed the file validations will | ||
| automatically run on every commit. | ||
|
|
||
| ### Functional Testing | ||
| The process to test the functionality of an AMI and it's integration with our | ||
| Service Catalog products is to first create a test AMI, upload a modified |
There was a problem hiding this comment.
Below you say to create the new product via a PR, not by uploading to S3. Can you please be consistent?
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.
Update the documentation on Service Catalog integration testing to reflect new automation added to the process.