Skip to content

Commit 88a680a

Browse files
ndintenfassndintenfass
authored
Edit Preview doc and add install instructions for 2.0 BTF preview (circleci#1331)
* Edit Preview doc and add install instructions for 2.0 BTF preview * make link out of url
1 parent 67dc950 commit 88a680a

File tree

1 file changed

+215
-18
lines changed

1 file changed

+215
-18
lines changed

‎jekyll/_ccie/preview.md

Lines changed: 215 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,229 @@ description: "Pre-release access to CircleCI 2.0 functionality behind your firew
88
hide: true
99
---
1010

11-
## Overview
12-
11+
# Introducing CircleCI Enterprise 2.0
1312
CircleCI 2.0 is our new infrastructure that provides a number of new valuable options for your development teams, including:
1413
* New configuration paradigm with any number of jobs and workflows to orchestrate them.
1514
* Custom images for execution on a per-job basis.
1615
* Fine-grained performance with custom caching & per-job CPU/memory allocation.
1716

18-
Starting in Q2 2017 we will be offering a preview release to an expanding set of customers. To participate, contact your Account Executive.
17+
Having completed an alpha trial, starting in July 2017 we will be offering a preview release to an expanding set of customers. To participate, contact your Account team.
18+
19+
## Current Phase: "Private Preview"
20+
Preview customers will set up a separate trial of the new platform with the expectation that they will update frequently (daily releases) and provide active feedback on the installation process, performance profile of their installation, and any other issues that arise.
21+
22+
The Preview will have the following constraints:
1923

20-
## Phase 1: "Alpha"
21-
A handful of customers will be participating in our Alpha release, with the expectation that they will provide active feedback on the installation process, performance profile of their Alpha installation, and any other issues that arise. The Alpha release will have the following constraints:
2224
* Requires setting up a fresh installation that will be entirely disposable (no ability to migrate data from an Alpha install to your existing CircleCI Installation).
23-
* Requires teams to build a new CircleCI 2.0 configuration in their repositories.
24-
* Only available on AWS.
25-
* Need to manually set up a separate worker cluster.
26-
* No Workflows functionality in the Alpha release.
27-
* Little to no documentation -- support from our Sales and Success Engineers will be available (which is part of why we need to limit Alpha access).
28-
* HTTP only for internal communications between workers and the output processor (HTTPS coming in Beta), so only should be run on a trusted network.
29-
* No "machine" executor for running jobs inside VMs or doing a remote Docker host - Full Docker features can be achieved using privileged containers in your worker fleet and setting up a shared Docker on the hosts.
30-
31-
## Phase 2: "Beta"
32-
An expanded set of customers will be invited in waves to try CircleCI 2.0 features in their existing installation of CircleCI, with the expectation that they will provide feedback directly to CircleCI about their experience operating the new infrastructure and any issues their teams encounter when making the transition to the new configuration. The Beta will have the following constraints:
3325
* Only available on AWS.
3426
* Requires teams to build a new CircleCI 2.0 configuration in their repositories.
35-
* Admin-led opt-in on a per-project basis -- teams will not automatically get 2.0 functionality in the Beta.
27+
* Limited documentation -- support from your account team will be available.
28+
* HTTP only for internal communications between workers and the output processor (HTTPS coming soon), so only should be run on a trusted network.
29+
* Only IAM User Authentication is currently supported (no instance profiles yet)
30+
* If you choose to NOT run a "1.0" fleet you may see some odd UI behaviors during the Preview. This will be addressed soon.
31+
32+
## Coming Soon: "General Availability"
33+
Later this year, all customers with CircleCI Enterprise installed will be able to get access to CircleCI 2.0 features on their current installation with no restrictions under their current agreement and support level.
34+
35+
-----
36+
37+
# Installation of the Preview
38+
Once you have received a Preview license from your account team, the following instructions will help you set up your trial installation.
39+
40+
## Installation with Terraform
41+
* Fill vars in `terraform.tfvars` file in <https://github.com/circleci/enterprise-setup/tree/ccie2>
42+
* Apply Terraform scripts (`terraform apply`)
43+
* Go to provided URL at the end of Terraform output and follow instruction
44+
* Enter your license
45+
* In the `Storage` section:
46+
* **Only AWS S3 is currently supported**
47+
* **Only IAM User Authentication is currently supported**
48+
* Following permissions are required for an IAM User:
49+
```JSON
50+
{
51+
"Version": "2012-10-17",
52+
"Statement": [
53+
{
54+
"Effect": "Allow",
55+
"Action": [
56+
"ec2:RunInstances",
57+
"ec2:TerminateInstances",
58+
"ec2:Describe*",
59+
"ec2:CreateTags",
60+
"iam:GetUser",
61+
"cloudwatch:*",
62+
"sts:GetFederationToken"
63+
],
64+
"Resource": [
65+
"*"
66+
]
67+
},
68+
{
69+
"Effect": "Allow",
70+
"Action": [
71+
"s3:*"
72+
],
73+
"Resource": [
74+
"arn:aws:s3:::YOUR-BUCKET-HERE",
75+
"arn:aws:s3:::YOUR-BUCKET-HERE/*"
76+
]
77+
}
78+
]
79+
}
80+
```
81+
* vm-service configuration:
82+
* The AWS User need to have the following permissions. It might be the same user as for S3, but then it needs to have both sets of permissions.
83+
``` JSON
84+
{
85+
"Version": "2012-10-17",
86+
"Statement": [
87+
{
88+
"Action": [
89+
"ec2:RunInstances",
90+
"ec2:CreateTags"
91+
],
92+
"Effect": "Allow",
93+
"Resource": "arn:aws:ec2:HERE-IS-REGION-OR-*:*"
94+
},
95+
{
96+
"Action": [
97+
"ec2:Describe*"
98+
],
99+
"Effect": "Allow",
100+
"Resource": "*"
101+
},
102+
{
103+
"Action": [
104+
"ec2:TerminateInstances"
105+
],
106+
"Effect": "Allow",
107+
"Resource": "arn:aws:ec2:HERE-IS-REGION-OR-*:*:instance/*",
108+
"Condition": {
109+
"StringEquals": {
110+
"ec2:ResourceTag/ManagedBy": "circleci-vm-service"
111+
}
112+
}
113+
}
114+
]
115+
}
116+
```
117+
* region/subnet/sercurity group will be filled automatically
118+
119+
## Manual installation
120+
121+
### Service-box instance
122+
123+
* Type: At least `m4.xlarge` (better `m4.2xlarge`).
124+
* Storage: 100 GB, General Purpose SSD
125+
* Security groups:
126+
127+
| Protocol | Port Range | Source |
128+
| -------- | ---------- | ------- |
129+
| TCP | 22 | 0.0.0.0 |
130+
| TCP | 80 | 0.0.0.0 |
131+
| TCP | 443 | 0.0.0.0 |
132+
| TCP | 8800 | 0.0.0.0 |
133+
| TCP | 8585 | vpc |
134+
| TCP | 4647 | vpc |
135+
136+
137+
### 1.0 Builders
138+
139+
No changes, the same process as for the CCIE 1.0 (https://circleci.com/docs/enterprise/aws-manual/)
140+
141+
### 2.0 Builders
142+
143+
#### Cluster Mode
144+
145+
* Terraform script: https://github.com/circleci/enterprise-setup/blob/ccie2/nomad/nomad-cluster.tf
146+
* Instance Type: At least `m4.xlarge` (better `m4.4xlarge`)
147+
148+
149+
### Installation and configuration
150+
151+
* SSH into service-box
152+
* `curl https://get.replicated.com/docker | sudo bash`
153+
* Go to provided at the end of the previous step URL
154+
* Use a special Alpha license
155+
* Storage:
156+
* **Only AWS S3 is currently supported**
157+
* **Only IAM User Authentication is currently supported**
158+
* Following permissions are required for an IAM User:
159+
```JSON
160+
{
161+
"Version": "2012-10-17",
162+
"Statement": [
163+
{
164+
"Effect": "Allow",
165+
"Action": [
166+
"ec2:RunInstances",
167+
"ec2:TerminateInstances",
168+
"ec2:Describe*",
169+
"ec2:CreateTags",
170+
"iam:GetUser",
171+
"cloudwatch:*",
172+
"sts:GetFederationToken"
173+
],
174+
"Resource": [
175+
"*"
176+
]
177+
},
178+
{
179+
"Effect": "Allow",
180+
"Action": [
181+
"s3:*"
182+
],
183+
"Resource": [
184+
"arn:aws:s3:::YOUR-BUCKET-HERE",
185+
"arn:aws:s3:::YOUR-BUCKET-HERE/*"
186+
]
187+
}
188+
]
189+
}
190+
```
191+
* vm-service configuration:
192+
* AWS User need to have this permissions. It might be the same user as for S3, but then it needs to have both set of permissions.
193+
``` JSON
194+
{
195+
"Version": "2012-10-17",
196+
"Statement": [
197+
{
198+
"Action": [
199+
"ec2:RunInstances",
200+
"ec2:CreateTags"
201+
],
202+
"Effect": "Allow",
203+
"Resource": "arn:aws:ec2:HERE-IS-REGION-OR-*:*"
204+
},
205+
{
206+
"Action": [
207+
"ec2:Describe*"
208+
],
209+
"Effect": "Allow",
210+
"Resource": "*"
211+
},
212+
{
213+
"Action": [
214+
"ec2:TerminateInstances"
215+
],
216+
"Effect": "Allow",
217+
"Resource": "arn:aws:ec2:HERE-IS-REGION-OR-*:*:instance/*",
218+
"Condition": {
219+
"StringEquals": {
220+
"ec2:ResourceTag/ManagedBy": "circleci-vm-service"
221+
}
222+
}
223+
}
224+
]
225+
}
226+
```
227+
* EC2 security group should have these rules:
228+
229+
| Protocol | Port Range | Source |
230+
| -------- | ---------- | ------- |
231+
| TCP | 22 | 0.0.0.0 |
232+
| TCP | 2376 | 0.0.0.0 |
233+
| TCP | 32768-61000| 0.0.0.0 |
234+
36235

37-
## Phase 3: "General Availability"
38-
All customers with CircleCI installed will be able to get access to CircleCI 2.0 features on their current installation with no restrictions under their current agreement and support level.
39236

0 commit comments

Comments
 (0)