Skip to content

Commit 0535ed9

Browse files
update README
1 parent e7b191b commit 0535ed9

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,31 @@ This guide will help you deploy and manage your AWS ServiceCatalog using Infrast
1212
## Deployment
1313
Merges to master will copy these templates to an S3 bucket that is used by [organizations-infra/sceptre/scipool](https://github.com/Sage-Bionetworks-IT/organizations-infra/tree/master/sceptre/scipool) to deploy stacks.
1414

15-
## Development
16-
Currently there is a manual process for development. The steps are:
17-
1. Deploy a test service catalog product template to an S3 bucket that has public access.
18-
2. Reference that template in a template that deploys a product. Examples can be found in the individual
19-
[Sceptre templates in org-formation-infra repo](https://github.com/Sage-Bionetworks-IT/organizations-infra/tree/master/sceptre/scipool/config/develop)
20-
21-
Example:
22-
```yaml
23-
template:
24-
path: "sc-product-ec2-linux-docker.j2"
25-
stack_name: "my-sc-product-ec2-linux-docker"
26-
parameters:
27-
ProductName: "EC2: Linux Docker"
28-
sceptre_user_data:
29-
# force cloudformation to update stack by setting a random number to the latest product's description
30-
ProvisioningArtifactParameters: |
31-
- Description: 'Test EC2 docker'
32-
Info:
33-
LoadTemplateFromURL: 'https://<TEST BUCKET>.s3.amazonaws.com/templates/ec2/sc-ec2-linux-docker.yaml'
34-
Name: 'v9.9.9'
35-
```
15+
## Develoopment
16+
17+
### Pre-Commit
18+
As a pre-deployment step we syntatically validate our sceptre and
19+
cloudformation yaml files with [pre-commit](https://pre-commit.com).
20+
21+
Please install pre-commit, once installed the file validations will
22+
automatically run on every commit. Alternatively you can manually
23+
execute the validations by running `pre-commit run --all-files`.
24+
Please install pre-commit, once installed the file validations will
25+
automatically run on every commit.
26+
27+
### Functional Testing
28+
In order to test a change to a template, the template to test needs
29+
to be uploaded to S3, and then a service catalog product needs to
30+
be configured to use the test template.
31+
32+
The deploy pipeline will run on branches that begin with `test/`
33+
and will upload the templates to S3 in a directory named after the
34+
branch name.
35+
36+
Then a PR can be made to `organizations-infra` to create or update
37+
a service catalog product that references the test template, like in [this PR](https://github.com/Sage-Bionetworks-IT/organizations-infra/pull/1109/files).
38+
This process is outlined [in scipool documentation in `organizations-infra`](https://github.com/Sage-Bionetworks-IT/organizations-infra/tree/master/sceptre/scipool/README.md)
39+
and existing templates can be found in the individual [sceptre templates in `organiationss-infra`](https://github.com/Sage-Bionetworks-IT/organizations-infra/tree/master/sceptre/scipool/config/develop).
3640

3741
### Account and Credentials
3842
While the templates in this library could be used in any AWS account, Sage Bionetworks is currently deploying to the "scipooldev" and "scipoolprod" account.

0 commit comments

Comments
 (0)