[IT-3523] Update Service Catalog AMI testing docs #1306
Conversation
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
sceptre/scipool/README.md
Outdated
| 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"?
There was a problem hiding this comment.
I've added a list to the end of the section
sceptre/scipool/README.md
Outdated
| 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?
There was a problem hiding this comment.
The branch name will start with test/ such as test/foo, and that branch is pushed directly to the origin, e.g. Sage-Bionetworks-IT/packer-ami-template. I've reworded this to 'upstream repo' with an explicit example.
sceptre/scipool/README.md
Outdated
| 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. |
sceptre/scipool/README.md
Outdated
| 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?
There was a problem hiding this comment.
The wording is a little tricky because there's a template in service-catalog-library, and another in organizations-infra. I've added a link to an example PR that hopefully shows the relationship between the two templates.
sceptre/scipool/README.md
Outdated
| 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?
There was a problem hiding this comment.
I'm trying to describe both the underlying process and the automation around it. I've reworded this to hopefully explain that a bit more
ConsoleCatzirl
force-pushed
the
it-3523-b
branch
from
013f5cd to
91876f5
Compare
ConsoleCatzirl
force-pushed
the
it-3523-b
branch
from
91876f5 to
e012dc2
Compare
Reword and expand both the reasoning and the process documented.
ConsoleCatzirl
force-pushed
the
it-3523-b
branch
from
e012dc2 to
088bbbb
Compare
Update the documentation on Service Catalog integration testing to reflect new automation added to the process.