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: _docs-sources/guides/reference-architecture/configuration-guide/index.md
+26-2Lines changed: 26 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -189,7 +189,7 @@ YAML files are space-sensitive. As you edit the file, be sure to retain the corr
189
189
190
190
If you’re unsure about how to answer any of the questions, email <[email protected]> and let us know!
191
191
192
-
## Complete the set up process and open a pull request for Gruntwork
192
+
## Complete the set up process and open a pull request to engage our GitHub Automations
193
193
194
194
1. Review your changes. If you notice any errors, correct them, and rerun:
195
195
@@ -205,7 +205,31 @@ If you’re unsure about how to answer any of the questions, email <support@grun
205
205
git push origin ref-arch-form
206
206
```
207
207
208
-
1.[Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Gruntwork will review the pull request, resolve any open questions or issues, then merge and begin the deployment.
208
+
1.[Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
209
+
210
+
## Use Preflight Checks to iterate on your form and fix any configuration issues
211
+
212
+

213
+
214
+
Once your form is filled in and pushed to GitHub, our GitHub automations will take over. You'll notice a special GitHub check called _Preflight Checks_ that will run against your `reference-architecture-form.yml` file and flag any errors for you directly in your pull request, like so:
You can then locally iterate on your form by editing `reference-architecture-form.yml` on the `ref-arch-form` branch and pushing your changes up to GitHub. Each time you make a new commit and push it, the Gruntwork _Preflight Checks_ will be run against your form.
219
+
220
+
Keep iterating on your form and pushing new commits up until the Preflight Checks check passes and you see no more error annotations on your pull request.
221
+
222
+
## Next Steps
223
+
224
+
Once all your _Preflight Checks_ pass, you can merge your pull request, which will commence your Ref Arch deployment.
225
+
226
+
Gruntwork engineers are automatically notified of each new Ref Arch deployment, so there's no need to reach out to support just to inform us that your deployment has commenced.
227
+
228
+
Gruntwork engineers will monitor your deployment and receive notifications about failures and issues that may require intervention to resolve.
229
+
230
+
Gruntwork engineers rotate through all active deployments to fix up issues preventing them from making forward progress. In general, deployments take "A few days", although there are plenty of variables outside of our control that can occasionally interfere with a deployment, and which may take longer to remediate.
231
+
232
+
Gruntwork engineers will reach out to you to communicate a status update or next steps if your deployment requires additional intervention to complete.
209
233
210
234
## Appendix: How to create a secret for the VCS token in AWS Secrets Manager
Copy file name to clipboardExpand all lines: docs/guides/reference-architecture/configuration-guide/index.md
+27-3Lines changed: 27 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -189,7 +189,7 @@ YAML files are space-sensitive. As you edit the file, be sure to retain the corr
189
189
190
190
If you’re unsure about how to answer any of the questions, email <[email protected]> and let us know!
191
191
192
-
## Complete the set up process and open a pull request for Gruntwork
192
+
## Complete the set up process and open a pull request to engage our GitHub Automations
193
193
194
194
1. Review your changes. If you notice any errors, correct them, and rerun:
195
195
@@ -205,7 +205,31 @@ If you’re unsure about how to answer any of the questions, email <support@grun
205
205
git push origin ref-arch-form
206
206
```
207
207
208
-
1.[Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Gruntwork will review the pull request, resolve any open questions or issues, then merge and begin the deployment.
208
+
1.[Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
209
+
210
+
## Use Preflight Checks to iterate on your form and fix any configuration issues
211
+
212
+

213
+
214
+
Once your form is filled in and pushed to GitHub, our GitHub automations will take over. You'll notice a special GitHub check called _Preflight Checks_ that will run against your `reference-architecture-form.yml` file and flag any errors for you directly in your pull request, like so:
You can then locally iterate on your form by editing `reference-architecture-form.yml` on the `ref-arch-form` branch and pushing your changes up to GitHub. Each time you make a new commit and push it, the Gruntwork _Preflight Checks_ will be run against your form.
219
+
220
+
Keep iterating on your form and pushing new commits up until the Preflight Checks check passes and you see no more error annotations on your pull request.
221
+
222
+
## Next Steps
223
+
224
+
Once all your _Preflight Checks_ pass, you can merge your pull request, which will commence your Ref Arch deployment.
225
+
226
+
Gruntwork engineers are automatically notified of each new Ref Arch deployment, so there's no need to reach out to support just to inform us that your deployment has commenced.
227
+
228
+
Gruntwork engineers will monitor your deployment and receive notifications about failures and issues that may require intervention to resolve.
229
+
230
+
Gruntwork engineers rotate through all active deployments to fix up issues preventing them from making forward progress. In general, deployments take "A few days", although there are plenty of variables outside of our control that can occasionally interfere with a deployment, and which may take longer to remediate.
231
+
232
+
Gruntwork engineers will reach out to you to communicate a status update or next steps if your deployment requires additional intervention to complete.
209
233
210
234
## Appendix: How to create a secret for the VCS token in AWS Secrets Manager
211
235
@@ -235,6 +259,6 @@ In the ref arch form, `VCSPATSecretsManagerARN` is where you enter this ARN.
0 commit comments