Skip to content

Commit

Permalink
update docs on circle deployer
Browse files Browse the repository at this point in the history
  • Loading branch information
alain-hoang committed Jan 8, 2018
1 parent 3cb4e98 commit d544826
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
5 changes: 3 additions & 2 deletions README.md
@@ -1,10 +1,11 @@

# TTS DNS configuration

[![CircleCI](https://circleci.com/gh/18F/dns.svg?branch=deploy&style-svg)](https://circleci.com/gh/18F/dns)

This repository holds the source code for configuring DNS for domains managed by GSA TTS, including 18F and the Presidential Innovation Fellows.

[![dns-pipeline](https://user-images.githubusercontent.com/20934414/32065692-10d18d2c-ba43-11e7-9604-d97d7613bf1e.png)](https://github.com/18F/Infrastructure/wiki/DNS-architecture)
[![dns-pipeline](https://user-images.githubusercontent.com/20934414/34623560-7dd34d3c-f217-11e7-95fd-1cc8236d4b5b.png)](https://github.com/18F/Infrastructure/wiki/DNS-architecture)

## Making changes

Expand All @@ -27,7 +28,7 @@ This repository holds the source code for configuring DNS for domains managed by

It's worth noting that if you are pointing to a CloudFront distro, you should use Route 53's own `alias` and not a CNAME record. In fact, CNAMEing a top-level domain (or the top level of a delegated subdomain) is not allowed in DNS. See the various examples in the repo, such as [this one](https://github.com/18F/dns/blob/deploy/terraform/usa.gov.tf#L8-L17).

On merge, changes are deployed to the cloud.gov AWS account automatically by an instance of Concourse hosted on [cloud.gov](https://cloud.gov). The configuration for the Concourse instance is in `pipeline.yml`.
On merge, changes are deployed to the cloud.gov AWS account automatically by an instance of Concourse hosted on [cloud.gov](https://cloud.gov). The configuration for the Concourse instance is in `pipeline.yml`. Note: Deployment migration to [CircleCI](https://circleci.com/gh/18F/dns) is in progress.

**Please note: only production systems with an ATO should have their DNS configuration here. If you wish to create DNS records for pre-production systems, please use the domain `sandbox.gov` which is available in the [TTS Sandbox account](https://pages.18f.gov/before-you-ship/infrastructure/sandbox/).**

Expand Down
12 changes: 6 additions & 6 deletions doc/dns-pipeline.mmd
Expand Up @@ -2,7 +2,7 @@
sequenceDiagram
participant Github
participant CI
participant Concourse
participant Deployer
participant AWS

note over Github: dns repo
Expand All @@ -14,11 +14,11 @@ sequenceDiagram
CI -->>- Github: Delete pull request branch
end

Note over Github: cg-pipeline-tasks repo
Note over Github: dns repo
Github ->> Concourse: Deploys updated deploy branch
Note over Github: deploy pipeline
Github ->> Deployer: Deploys updated deploy branch

Note over Concourse: terraform apply
Concourse ->> AWS: update dns, save terraform state
Note over Deployer: terraform apply
Deployer ->> AWS: update dns, save terraform state

Note over Concourse: Report dns nameserver information
Note over Deployer: Report dns nameserver information

0 comments on commit d544826

Please sign in to comment.