You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-21Lines changed: 25 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,27 +12,31 @@ This guide will help you deploy and manage your AWS ServiceCatalog using Infrast
12
12
## Deployment
13
13
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.
14
14
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
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).
36
40
37
41
### Account and Credentials
38
42
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