mirror of
https://github.com/GSA/notifications-api.git
synced 2026-02-05 02:41:14 -05:00
Update instructions for managing DNS and domain configuration
This changeset updates our runbook for the DNS and domain management: * Add instructions and steps for how to perform the necessary actions to add and/or remove domains * Update links to existing resources * Add links to additional documentation Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
@@ -507,7 +507,7 @@ instructions above for more details.
|
||||
- [Deploying to Production](./docs/all.md#-deploying-to-production)
|
||||
- [Smoke-testing the App](./docs/all.md#-smoke-testing-the-app)
|
||||
- [Configuration Management](./docs/all.md#-configuration-management)
|
||||
- [DNS Changes](./docs/all.md#-dns-changes)
|
||||
- [DNS and Domain Changes](./docs/all.md#-dns-changes)
|
||||
- [Exporting test results for compliance monitoring](./docs/all.md#exporting-test-results-for-compliance-monitoring)
|
||||
- [Known Gotchas](./docs/all.md#-known-gotchas)
|
||||
- [User Account Management](./docs/all.md#-user-account-management)
|
||||
|
||||
44
docs/all.md
44
docs/all.md
@@ -53,7 +53,7 @@
|
||||
- [Smoke-testing the App](#-smoke-testing-the-app)
|
||||
- [Simulated bulk send testing](#-simulated-bulk-send-testing)
|
||||
- [Configuration Management](#-configuration-management)
|
||||
- [DNS Changes](#-dns-changes)
|
||||
- [DNS and Domain Changes](#-dns-changes)
|
||||
- [Exporting test results for compliance monitoring](#exporting-test-results-for-compliance-monitoring)
|
||||
- [Known Gotchas](#-known-gotchas)
|
||||
- [User Account Management](#-user-account-management)
|
||||
@@ -1068,7 +1068,7 @@ that the security of the system is maintained.
|
||||
1. [Smoke-testing the App](#smoke-testing)
|
||||
1. [Simulated bulk send testing](#simulated-bulk-send-testing)
|
||||
1. [Configuration Management](#cm)
|
||||
1. [DNS Changes](#dns)
|
||||
1. [DNS and Domain Changes](#dns)
|
||||
1. [Known Gotchas](#gotcha)
|
||||
1. [User Account Management](#ac)
|
||||
1. [SMS Phone Number Management](#phone-numbers)
|
||||
@@ -1239,15 +1239,41 @@ US_Notify Administrators are responsible for ensuring that remediations for vuln
|
||||
- Low - 180 days
|
||||
- Informational - 365 days (depending on the analysis of the issue)
|
||||
|
||||
## <a name="dns"></a> DNS Changes
|
||||
## <a name="dns"></a> DNS and Domain Changes
|
||||
|
||||
Notify.gov DNS records are maintained within [the 18f/dns repository](https://github.com/18F/dns/blob/main/terraform/notify.gov.tf). To create new DNS records for notify.gov or any subdomains:
|
||||
Notify.gov DNS records are maintained within [the GSA-TTS/dns repository](https://github.com/GSA-TTS/dns/blob/main/terraform/notify.gov.tf), and the domains and routes are managed directly in our Cloud.gov production space.
|
||||
|
||||
1. Update the `notify.gov.tf` terraform to update oƒr create the new records within Route53 and push the branch to the 18f/dns repository.
|
||||
1. Open a PR.
|
||||
1. Verify that the plan output within circleci creates the records that you expect.
|
||||
1. Request a PR review from the 18F/tts-tech-portfolio team
|
||||
1. Once the PR is approved and merged, verify that the apply step happened correctly within [CircleCI](https://app.circleci.com/pipelines/github/18F/dns)
|
||||
**Step 1: Make changes to the DNS records**
|
||||
|
||||
1. If you haven't already, clone a local copy of [the GSA-TTS/dns repository](https://github.com/GSA-TTS/dns).
|
||||
1. Create a new branch and update the [`notify.gov.tf`]((https://github.com/GSA-TTS/dns/blob/main/terraform/notify.gov.tf)) Terraform file to update, create, or remove DNS records within Route53.
|
||||
1. Open a PR in the repository and verify that the plan output within CircleCI makes the changes that you expect.
|
||||
1. Request a PR review from the `@tts-tech-operations` team within the GSA-TTS GitHub org.
|
||||
1. Once the PR is approved and merged, verify that the apply step happened correctly within [CircleCI](https://app.circleci.com/pipelines/github/GSA-TTS/dns).
|
||||
|
||||
**Steo 2: Make changes to the domains and routes in Cloud.gov**
|
||||
|
||||
The domains and routes are managed via the [`external domain` service](https://www.cloud.gov/docs/services/external-domain-service/) within Cloud.gov.
|
||||
|
||||
If you're creating new domains:
|
||||
|
||||
1. Sign in to the `cf` CLI in your terminal and target the `notify-production` space.
|
||||
1. Create the new domain(s) with [`cf create-private-domain`](https://docs.cloudfoundry.org/devguide/deploy-apps/routes-domains.html#private-domains).
|
||||
1. Map the routes needed to the new domain(s) with [`cf map-route`](https://docs.cloudfoundry.org/devguide/deploy-apps/routes-domains.html#map-route).
|
||||
1. Update the service to account for the new domain(s): `cf update-service notify-admin-domain-production -c '{"domains": "example.gov,www.example.gov,..."}'` (make sure to list *all* domains that need to be accounted for, including any existing ones that you want to keep!).
|
||||
|
||||
If you're removing existing domains:
|
||||
|
||||
1. Sign in to the `cf` CLI in your terminal and target the `notify-production` space.
|
||||
1. Unmap the routes to the existing domain(s) with [`cf unmap-route`](https://docs.cloudfoundry.org/devguide/deploy-apps/routes-domains.html#unmap-route).
|
||||
1. Delete the existing domain(s) with [`cf delete-private-domain`](https://docs.cloudfoundry.org/devguide/deploy-apps/routes-domains.html#private-domains).
|
||||
1. Update the service to account for the deleted domain(s): `cf update-service notify-admin-domain-production -c '{"domains": "example.gov,www.example.gov,..."}'` (make sure to list *all* domains that need to be accounted for, including any existing ones that you want to keep!).
|
||||
|
||||
**Step 3: Redeploy or restage the Admin app:**
|
||||
|
||||
Restage or redeploy the `notify-admin-production` app. To restage, you can trigger the action in GitHub or run the command directly: `cf restage notify-admin-production --strategy rolling`.
|
||||
|
||||
Test that the changes took effect properly by going to the domain(s) that were adjusted and seeing if they resolved correctly and/or no longer resolve as expected.
|
||||
|
||||
## Exporting test results for compliance monitoring
|
||||
|
||||
|
||||
Reference in New Issue
Block a user