Skip to content

Commit fd6c7b3

Browse files
committed
start tidy up of core service install doc
1 parent 3308008 commit fd6c7b3

File tree

2 files changed

+22
-23
lines changed

2 files changed

+22
-23
lines changed

jekyll/_cci2/server-3-install-prerequisites.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Download and install the following software before continuing:
4949

5050
| KOTS: https://github.com/replicatedhq/kots/releases/download/v1.65.0/kots_darwin_amd64.tar.gz[Mac] or https://github.com/replicatedhq/kots/releases/download/v1.65.0/kots_linux_amd64.tar.gz[Linux].
5151
| {kotsversion} *
52-
| Replicated Kubernetes Application Management
52+
| Replicated Kubernetes Application Management. KOTS is a `kubectl` https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/[plugin].
5353
| Once you have extracted `kots` from the tar.gz (`tar zxvf kots_linux_amd64.tar.gz`), run `sudo mv kots /usr/local/bin/kubectl-kots` to install it. Mac users will need to grant a security exception.
5454

5555

jekyll/_cci2/server-3-install.adoc

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,46 +15,45 @@ version:
1515

1616
Before you begin with the CircleCI server v3.x core services installation phase, ensure all xref:server-3-install-prerequisites.adoc[prerequisites] are met.
1717

18-
NOTE: In the following sections replace any items or credentials displayed between `< >` with your details.
19-
2018
.Installation Experience Flow Chart Phase 2
2119
image::server-install-flow-chart-phase2.png[Flow chart showing the installation flow for server 3.x with phase 2 highlighted]
2220

21+
NOTE: In the following sections replace any items or credentials displayed between `< >` with your details.
22+
2323
toc::[]
2424

2525
== Phase 2: Core services installation
26-
CircleCI server v3.x uses https://kots.io[KOTS] from https://www.replicated.com/[Replicated] to manage and distribute server v3.x. KOTS is a `kubectl` https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/[plugin].
27-
To install the latest version, you can run `curl \https://kots.io/install | bash`.
28-
29-
Ensure you are running the minimum KOTS version ({kotsversion}) by running the command:
26+
CircleCI server v3.x uses https://kots.io[KOTS] from https://www.replicated.com/[Replicated] for installation management and distribution. .
3027

28+
. Ensure you are running the minimum KOTS version ({kotsversion}) by running the command:
29+
+
3130
```bash
3231
kubectl kots version
3332
```
34-
33+
+
3534
NOTE: The KOTS command will open up a tunnel to the admin console. If running on Windows inside WSL2, the port is not available on the host machine. Turning WSL off and back on should resolve the issue. For more information, please see
3635
https://github.com/microsoft/WSL/issues/4199.
3736

38-
From the terminal run (if you are installing behind a proxy see https://circleci.com/docs/2.0/server-3-install/#installing-behind-an-http-proxy[Installing behind HTTP Proxy]):
39-
37+
. From the terminal run (if you are installing behind a proxy see https://circleci.com/docs/2.0/server-3-install/#installing-behind-an-http-proxy[Installing behind HTTP Proxy]):
38+
+
4039
```bash
4140
kubectl kots install circleci-server
4241
```
43-
44-
You will be prompted for a:
45-
42+
+
43+
You will be prompted for:
44+
+
4645
* namespace for the deployment
4746
* password for the KOTS admin console
4847

49-
When complete, you should be provided with a URL to access the KOTS admin console, usually `\http://localhost:8800`.
48+
. When complete, you should be provided with a URL to access the KOTS admin console, usually `\http://localhost:8800`.
5049

51-
NOTE: If you need to get back to the KOTS admin console at a later date you can run: `kubectl kots admin-console -n <YOUR_CIRCLECI_NAMESPACE>`
50+
TIP: If you need to get back to the KOTS admin console at a later date you can run: `kubectl kots admin-console -n <YOUR_CIRCLECI_NAMESPACE>`
5251

53-
NOTE: Once you have created your namespace, we recommend setting your `kubectl` context too with the following command: `kubectl config set-context --current --namespace <namespace>`
52+
TIP: Once you have created your namespace, we recommend setting your `kubectl` context too with the following command: `kubectl config set-context --current --namespace <namespace>`
5453

55-
=== Installing behind an HTTP Proxy
54+
=== Installing behind an HTTP Proxy (optional)
5655

57-
If you wish to install CircleCI server behind a proxy, the following command structure should be used (for more information see the KOTS docs https://kots.io/kotsadm/installing/online-install/#proxies[here]):
56+
If you wish to install CircleCI server behind a proxy, the following command structure should be used for step 2 above (for more information see the KOTS docs https://kots.io/kotsadm/installing/online-install/#proxies[here]):
5857

5958
```bash
6059
kubectl kots install circleci-server --http-proxy <YOUR_HTTP_PROXY_URI> --https-proxy <https-proxy> --no-proxy <YOUR_NO_PROXY_LIST>
@@ -65,12 +64,12 @@ The load balancer endpoints must be added to the no-proxy list for the following
6564
For further information see the https://circleci.com//docs/2.0/server-3-operator-proxy/index.html[Configuring a Proxy] guide.
6665

6766
=== Frontend Settings
68-
Frontend settings control the web application specific aspects of the CircleCI system.
67+
Frontend settings control the web-application-specific aspects of the CircleCI system.
6968

7069
.Frontend Settings
7170
image::server-3-frontend-settings.png[Screenshot showing frontend settings]
7271

73-
Complete the fields described below. You can either supply a private key and certificate, or check the box that allows Let's Encrypt or https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html[AWS Certificate Manager (ACM)] to automatically request and manage certificates for you. You can also disable TLS termination at this point, but the system will still need to be accessed over HTTPS.
72+
Complete the fields described below. You can either supply a private key and certificate, or check the box that allows https://letsencrypt.org/[Let's Encrypt] or https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html[AWS Certificate Manager (ACM)] to automatically request and manage certificates for you. You can also disable TLS termination at this point, but the system will still need to be accessed over HTTPS.
7473

7574
==== Using ACM TLS Certificates
7675

@@ -89,11 +88,11 @@ You will need to reroute your DNS records to the new loadbalancer once you have
8988

9089
NOTE: If you are selecting the option to use private load balancers, the Let's Encrypt option will no longer work and become unavailable.
9190

92-
* *Domain Name (required)* - Enter the domain name you specified when creating your Frontend TLS key and certificate.
91+
* *CircleCI Domain Name (required)* - Enter the domain name you specified when creating your Frontend TLS key and certificate.
9392

94-
* *Frontend Replicas (optional)* - Used to increase the amount of traffic that can be handled by the frontend.
93+
* *Frontend Replicas* - Used to increase the amount of traffic that can be handled by the frontend.
9594

96-
* *Frontend TLS Private Key (required)* - You created this during your pre-requisite steps. You can retrieve this value with the following command:
95+
* *Frontend TLS Private Key (required)* - You created this during your prerequisite steps. You can retrieve this value with the following command:
9796
+
9897
```bash
9998
cat /etc/letsencrypt/live/<CIRCLECI_SERVER_DOMAIN>/privkey.pem

0 commit comments

Comments
 (0)