Skip to content

Commit 429dad3

Browse files
GEReyGERey
authored
Document that revamps the current AWS install instructions. (circleci#459)
* Changed instructions to include my comments on how the doc should look * Changed enterprise tag to previous correct installation tag
1 parent 01df40b commit 429dad3

File tree

1 file changed

+67
-28
lines changed

1 file changed

+67
-28
lines changed

‎jekyll/_docs/enterprise/aws.md

Lines changed: 67 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,45 +6,84 @@ order: 3
66
description: "How to install CircleCI Enterprise on Amazon Web Services (AWS)."
77
---
88

9-
109
The following step-by-step instructions will guide you through the process of installing CircleCI Enterprise on AWS. If you have any questions as you go through these steps, please contact <[email protected]>.
1110

12-
<ol>
13-
<li>Launch resources on AWS using Terraform (see <a href="{{site.baseurl}}/enterprise/aws-manual/">here</a> for advanced instructions if you prefer to set up resources manually or using different tools):
14-
<pre>
15-
git clone https://github.com/circleci/enterprise-setup ccie && cd ccie
11+
Prerequisites
12+
==================
1613

17-
# Ensure that <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-dns.html#vpc-dns-updating">DNS is enabled for your VPC</a>.
18-
# Specifically, enableDnsSupport must be true.
19-
# If this is not enabled, then you must otherwise ensure that DNS is configured correctly on your instances
20-
# IMPORTANT: See [additional instructions if you are using a private subnet]({{site.baseurl}}/enterprise/aws-private-subnet/).
14+
* AWS Access Key
15+
* AWS Secret Key
16+
* AWS Region
17+
* For example: "us-west-2"
18+
* AWS VPC ID
19+
* Ensure that your VPC has the setting [enableDNSSupport](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-dns.html#vpc-dns-updating)
20+
set to true
21+
* Instructions if you have a [Private Subnet]({{site.baseurl}}/enterprise/aws-private-subnet/)
22+
* AWS Subnet ID
23+
* AWS S3 Bucket Name
24+
* Services Instance Type
25+
* The type of aws resource for our CircleCI service
26+
* Builder Instance Type
27+
* The type of aws resource for our CircleCI builder
28+
* Circle CI License .rli file.
2129

22-
vi terraform.tfvars # Edit variables as appropriate with your favorite editor
30+
Step One: Setup Terraform
31+
==================
2332

24-
# Launch AWS resources with the Terraform wrapper script
25-
# (This script requires OSX. Please <a href="https://www.terraform.io/downloads.html">install Terraform</a> yourself on Linux/Windows.)
33+
If you prefer to do this process manually or with different tools please see the [Manual Aws Instructions]({{site.baseurl}}/enterprise/aws-manual/)
34+
35+
36+
Download the following repo: `git clone https://github.com/circleci/enterprise-setup ccie && cd ccie`
37+
38+
39+
Open `terraform.tfvars` in your favorite text editor and input the
40+
prerequities stated above in the required fields.
41+
42+
For Linux/Windows
43+
------------------
44+
Please install <a href="https://www.terraform.io/downloads.html">Terraform</a> yourself on Linux/Windows. Then run the command below.
45+
46+
For OSX
47+
------------------
48+
49+
You can just run the command below.
50+
51+
`bin/terraform apply`
52+
53+
Configure Circle Ci Enterprise
54+
==================
55+
<li>Go To the URL output from Terraform
56+
<ol>
57+
<li>Click "Get Started"</li>
58+
<li>Trust the temporary SSL cert</li>
59+
<li>Use a self-signed certificate ( or if you already have one feel free to use it here )</li>
60+
<li>Upload your license</li>
61+
<li>Secure the console with a password</li>
62+
<li>Enter the current machine's IP address or a hostname that you have configured</li>
63+
<li>Create a <a href="https://github.com/settings/applications/new">Github Developer Application</a></li>
64+
<ol type="a">
65+
<li>Set the homepage URL to <code>www.circleci.com</code> </li>
66+
<li>Set the callback URL to <code>&lt;circleci enterprise base url&gt;/auth/github</code></li>
67+
</ol>
68+
<li>Input the key and secret from GitHub back into the settings page</li>
69+
<li>Either upload a valid SSL cert with intermediate certificates and key, or disable SSL (you can always add it later)</li>
70+
<li>Save and start the app (all other default settings are fine for now). You will be redirected to the System Console Dashboard,
71+
where you should soon see an indication that the app has started like below.</li>
72+
</ol>
73+
</li>
74+
75+
<img src="{{site.baseurl}}/assets/img/docs/started.png" alt="Look For 'Open'" width="150" style="margin: 10px; margin-left: 200px">
76+
77+
Using Circle CI Enterprise
78+
==================
2679

27-
bin/terraform apply</pre>
28-
</li>
29-
<li>Fill out the settings form in the web UI:
30-
<ol type="a">
31-
<li>Go to the URL output from Terraform, click "Get Started", then click on "Advanced", "Add exception...", or whatever mechanism your browser provides to trust the temporary SSL cert</li>
32-
<li>Use a self-signed certificate, upload your license, and secure the console with a password</li>
33-
<li>Enter the current machine's IP address or a hostname that you have configured</li>
34-
<li>Create a GitHub developer application at <code>&lt;github base url&gt;/settings/applications/new</code>, set the callback URL to <code>&lt;circleci enterprise base url&gt;/auth/github</code>, and input the key and secret back in the settings page</li>
35-
<li>Either upload a valid SSL cert with intermediate certificates and key, or disable SSL (you can always add it later)</li>
36-
<li>Save and start the app (all other default settings are fine for now). You will be redirected to the System Console Dashboard,
37-
where you should soon see an indication that the app has started like this: <br /> <img src="{{site.baseurl}}/assets/img/docs/started.png" alt="Look For 'Open'" width="150" style="margin: 10px; margin-left: 200px">
38-
</li>
39-
</ol>
40-
</li>
4180
<li>Try it out!
42-
<ol type="a">
81+
<ol>
4382
<li>Click the "Open" link in the dashboard to go to the CircleCI Enterprise app. You may see a "Starting" page for a few minutes to indicate that the CircleCI
4483
application is booting up, but you will soon be automatically redirected to the homepage for your CircleCI Enterprise installation.</li>
4584
<li>Sign up and follow a <a href="/docs/enterprise/quick-start/">project</a></li>
4685
<li>The first build may remain queued while the build containers start. You can check the "Fleet State" by clicking on the wrench icon on the sidebar and selecting "Fleet State".
4786
If no instances appear in the list, then the first builder is still starting. If there is a builder instance in the list but its state is "starting-up", then it is still downloading the build container image and starting its first build containers. Once this is all done, the first build should begin immediately. If there are no updates after about 15 minutes (remember to click the "refresh" button occasionally), please contact <a href="mailto:[email protected]">CircleCI Enterprise support</a>.</li>
4887
</ol>
4988
</li>
50-
</ol>
89+

0 commit comments

Comments
 (0)