Skip to content

Commit cf5d03a

Browse files
committed
fix some cross refs and formatting
1 parent 905075c commit cf5d03a

12 files changed

+48
-51
lines changed

README-server-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ In order to make tables display correctly in the web version of Server docs, ass
6363
### Inter-document cross refs
6464
Cross references should be made in the form: `<<overview#services-machine,Services Machine>>` where `overview` is the name of the file the destination is in, `services-machine` is the anchor heading, and `Services Machine` is what to display in the prose.
6565

66-
This is a little trickier when cross referencing between the install and ops guides as the xref needs to work for the PDF, where they are two separate docs as well as the Jekyll site where you will be dealing with two regular pages as with any xref. So in this instance reference the URL of the Jekyll version, so instead of using the `<<>>` described above, use a normal link URL[text to display].
66+
This is a little trickier when cross referencing between the install and ops guides as the xref needs to work for the PDF, across two separate docs, as well as the Jekyll site where you will be dealing with two regular pages as with any xref. In this instance, reference the URL of the Jekyll version, so instead of using the `<<>>` described above, use a normal link `URL[text to display]`.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ For larger edits or new articles, you'll want to set up a local environment for
88

99
If you have a question or need help debugging, please head to [CircleCI Discuss](https://discuss.circleci.com/) where our support team will help you out.
1010

11+
Docs for CircleCI Server Administration are built in a slightly different way so there is a [separate README](README-server-docs.md) for this section.
12+
1113
## License Information
1214
Documentation (guides, references, and associated images) is licensed as Creative Commons Attribution-NonCommercial-ShareAlike CC BY-NC-SA. The full license can be found [here](http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode), and the human-readable summary [here](http://creativecommons.org/licenses/by-nc-sa/4.0/).
1315

jekyll/_cci2/aws-prereq.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Have available the following information and policies before starting the instal
4343
* AWS instances must have outbound access to pull Docker containers and to verify your license. If you don't want to give open outbound access, see our https://help.replicated.com/community/t/customer-firewalls/55[list of ports] that will need access.
4444
* In order to provision required AWS entities with Terraform you will require an IAM User with the following permissions (See the https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html[AWS guidance] on creating IAM users):
4545
+
46-
[source,json,linenums]
46+
[source,json]
4747
----
4848
{
4949
"Version": "2012-10-17",

jekyll/_cci2/aws.adoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -185,26 +185,22 @@ image::privacy.png[]
185185
.Storage Options
186186
image::storage.png[]
187187

188-
. Enhanced AWS Integration TBD
188+
. Complete enhanced AWS Integration options.
189189
// explain enhanced AWS integration 1.0 or just say ignore
190190

191191
. Complete the Email section if you wish to configure your own email server for sending build update emails. Leave this section is you wish to use our default email server.
192192
+
193193
NOTE: Due to an issue with our third party tooling, Replicated, the Test SMTP Authentication button is not currently working
194194

195-
// explain email server options, test button doesnt work etc
196-
197195
. Configure VM service if you plan to use https://circleci.com/docs/2.0/building-docker-images/[Remote Docker] or `machine` executor features. We recommend using an IAM instance profile for authentication, as described in the <<aws-prereq#planning,planning>> section of this document. With this section completed, instances will automatically be provisioned to execute jobs in Remote Docker or use the `machine` executor.
198196
+
199197
.Configure VM Service
200198
image::vmprovider.png[]
201-
199+
+
202200
You can preallocate instances to always be up and running, reducing the time taken for Remote Docker and `machine` executor jobs to start. If preallocation is set, a cron job will cycle through your preallocated instances once per day to prevent them getting into a bad/dead state.
203-
201+
+
204202
CAUTION: If Docker Layer Caching (DLC) is to be used VM preallocation must be set to `0` – on-demand – for both Remote Docker and `machine` executor.
205203

206-
//<!--Advanced settings to cover here too - make a section in ops guide for this and list of OK instance types for VM provider-->
207-
208204
. If you wish to use AWS Cloudwatch or Datadog for collating metrics for your installation, set this up here. For more infomration see our https://circleci.com/docs/2.0/monitoring/[Monitoring guidance]:
209205
+
210206
.Metrics

jekyll/_cci2/backup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ While filesystem-level data integrity issues are rare and preventable, there wil
5959
If you want to clean up any abnormal build records in your database after a recovery, you can delete them by running the following commands on the Services machine replacing the example build URL with an actual URL from your CircleCI application:
6060

6161
```shell
62-
$ circleci dev-console
62+
circleci dev-console
6363
# Wait for console to load
6464
user=> (admin/delete-build "https://my-circleci-hostname.com/gh/my-org/my-project/1234")
6565
```

jekyll/_cci2/install-overview.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@
55
:toc: macro
66
:toc-title:
77

8-
NOTE: CircleCI Server v2.17 uses the CircleCI 2.0 architecture.
8+
NOTE: CircleCI Server v2.17.x uses the CircleCI 2.0 architecture.
99

10-
The following sections provide step-by-step instructions for installing CircleCI Server v2.17 on Amazon Web Services (AWS) with Terraform. Refer to the https://circleci.com/server/changelog[changelog] for what's new and fixed in this release.
10+
The following sections provide planning information, system requirements and step-by-step instructions for installing CircleCI Server on Amazon Web Services (AWS) with Terraform.
11+
12+
Refer to the https://circleci.com/server/changelog[changelog] for what's new and fixed in this release.
13+
14+
If you are looking to update an existing installation, see our guide to <<updating-server#updating-a-server-installation,Updating a Server Installation>>.
1115

1216
toc::[]
1317

jekyll/_cci2/overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ image::arch_server.png[Services Architecture]
1717
<<<
1818
== Build Environments
1919

20-
CircleCI 2.0 uses Nomad as the primary job scheduler. Refer to our <<nomad#basic-terminology-and-architecture,Nomad Introduction>> to learn more about the job scheduler and how to perform basic client and cluster operations.
20+
CircleCI 2.0 uses Nomad as the primary job scheduler. Refer to our <<nomad#introduction-to-nomad-cluster-operation,Introduction to Nomad Cluster Operation>> to learn more about the job scheduler and how to perform basic client and cluster operations.
2121

2222
By default, CircleCI 2.0 Nomad clients automatically provision containers according to the image configured for each job in your `.circleci/config.yml` file.
2323

@@ -42,7 +42,7 @@ image::arch_components.png[CircleCI Core Components]
4242

4343
=== Services Machine
4444

45-
The Services machine must must not be restarted and may be backed up using VM snapshotting. If you must restart the Services machine, do so only as a last resort, because a restart will result in downtime. Refer to the <<backup#disaster-recovery,Disaster Recovery>> chapter for instructions.
45+
The Services machine must must not be restarted and may be backed up using VM snapshotting. If you must restart the Services machine, do so only as a last resort, because a restart will result in downtime. Refer to the <<backup#backup-and-recovery,Backup and Recovery>> chapter for instructions.
4646
//I feel like this is going in to telling you stuff you shouldn't do too quickly - feels negative
4747

4848
DNS resolution may point to the IP address of the Services machine. It is also possible to point to a load balancer, for example an ELB in AWS. The following table describes the ports used for traffic on the Service machine:

jekyll/_cci2/updating-server.adoc

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ To take a snapshot of your installation:
2727
NOTE: It is also possible to automate this process with the AWS API. Subsequent AMIs/snapshots are only as large as the difference (changed blocks) since the last snapshot, such that storage costs are not necessarily larger for more frequent snapshots, see Amazon's EBS snapshot billing document for details.
2828
Once you have the snapshot you are free to make changes on the Services machine.
2929

30-
If you do need to rollback at any point, see our <<backup#restoring-from-backup,Restore from Backup>> guide.
30+
If you do need to rollback at any point, see our https://circleci.com/docs/2.0/backup/#restoring-from-backup[guide to restoring from a backup].
3131

3232
== Updating Replicated
3333

34-
=== Perquisites
34+
=== Prerequisites
3535

3636
* Your installation is Ubuntu 14.04 or 16.04 based.
3737
* You are running replicated version 2.10.3<= on your services machine. Check by running the following:
3838
+
39-
```
39+
```shell
4040
replicated --version
4141
```
4242
* Your installation is **not** airgapped and you can access the internet from it
@@ -48,19 +48,19 @@ CAUTION: Remember to take a snapshot (described above) before starting the Repli
4848

4949
. Stop the CircleCI application:
5050
+
51-
```
52-
replicatedctl app stop
51+
```shell
52+
replicatedctl app stop
5353
```
5454
+
5555
Application shutdown takes a few minutes. Please check the administration dashboard and wait for the status to become “Stopped” before continuing. You can also run the following command to view the app status:
5656
+
57-
```
58-
replicatedctl app status inspect
57+
```shell
58+
replicatedctl app status inspect
5959
```
6060
+
6161
Example Output:
6262
+
63-
```
63+
```shell
6464
[
6565
{
6666
"AppID": "edd9471be0bc4ea04dfca94718ddf621",
@@ -77,46 +77,46 @@ Example Output:
7777

7878
. For the replicated update to succeed, it is necessary to update docker to the recommended version, 17.12.1:
7979
+
80-
```
81-
sudo apt-get install docker-ce=17.12.1~ce-0~ubuntu
80+
```shell
81+
sudo apt-get install docker-ce=17.12.1~ce-0~ubuntu
8282
```
8383

8484
. Pin the Docker version using the following command:
8585
+
86-
```
87-
sudo apt-mark hold docker-ce
86+
```shell
87+
sudo apt-mark hold docker-ce
8888
```
8989

9090
=== Perform Update
9191

9292
. Perform the Replicated update by executing the update script as follows:
9393
+
94-
```
95-
curl -sSL "https://get.replicated.com/docker?replicated_tag=2.34.1" | sudo bash
94+
```shell
95+
curl -sSL "https://get.replicated.com/docker?replicated_tag=2.34.1" | sudo bash
9696
```
9797
+
9898
Double-check your replicated and docker versions:
9999
+
100-
```
101-
replicatedctl version # 2.34.1
102-
docker -v # 17.12.1
100+
```shell
101+
replicatedctl version # 2.34.1
102+
docker -v # 17.12.1
103103
```
104104

105105
. Restart the app with
106106
+
107-
```
108-
replicatedctl app start
107+
```shell
108+
replicatedctl app start
109109
```
110110
+
111111
The application will take a few minutes to spin up. You can check the progress in the administration dashboard or by executing;
112112
+
113-
```
114-
replicatedctl app status inspect
113+
```shell
114+
replicatedctl app status inspect
115115
```
116116
+
117117
Example output:
118118
+
119-
```
119+
```shell
120120
[
121121
{
122122
"AppID": "edd9471be0bc4ea04dfca94718ddf621",

jekyll/_cci2/v.2.17-overview.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories: [getting-started]
77
order: 1
88
---
99

10-
This document provides a summary of features and product notes for the release of CircleCI Server v2.17.
10+
This document provides a summary of features and product notes for the release of CircleCI Server v2.17. For a full list of changes, including patch releases, refer to the [changelog](https://circleci.com/server/changelog).
1111

1212
## What's New in Release 2.17
1313

@@ -18,11 +18,6 @@ This document provides a summary of features and product notes for the release o
1818
* Improved the cache in front of GraphQL API resulting in overall improved performance.
1919
* Added backpressure to avoid overwhelming nomad with requests, this will result in increased performance from existing nomad clusters.
2020

21-
22-
- PDF installation and operations documentation:
23-
- [*CircleCI v2.17 Installation Guide*](https://circleci.com/docs/2.0/circleci-install-doc-v2-17.pdf)
24-
- [*CircleCI v2.17 Operations Guide*](https://circleci.com/docs/2.0/circleci-ops-guide-v2-17.pdf)
25-
2621
## Fixed in Release 2.17
2722

2823
* Fixed some bugs related to GitHub API response handling and webhook handling.

jekyll/_data/sidenav.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -268,11 +268,9 @@ en:
268268
- name: Server Administration
269269
icon: docs/admin.svg
270270
children:
271-
- name: Server v2.17.3 Install and Upgrade
271+
- name: Server v2.17.x Install
272272
link: 2.0/install-overview/
273273
children:
274-
- name: Trial Single-box Install
275-
link: 2.0/single-box/
276274
- name: Overview
277275
link: 2.0/install-overview/
278276
- name: System Requirements
@@ -287,7 +285,9 @@ en:
287285
link: 2.0/updating-server/
288286
- name: Upgrades from 1.0 to 2.0
289287
link: 2.0/upgrading/
290-
- name: Server v2.17.3 Operations
288+
- name: Trial Single-box Install
289+
link: 2.0/single-box/
290+
- name: Server v2.17.x Operations
291291
link: 2.0/overview/
292292
children:
293293
- name: Overview
@@ -332,15 +332,15 @@ en:
332332
link: 2.0/architecture/
333333
- name: Acknowledgments
334334
link: 2.0/open-source/
335-
- name: CircleCI Server v2.17 PDFs
335+
- name: CircleCI Server v2.17.3 PDFs
336336
link: 2.0/v.2.17-overview/
337337
children:
338338
- name: What's New in v2.17
339339
link: 2.0/v.2.17-overview/
340-
- name: v2.17 Installation Guide
341-
link: 2.0/circleci-install-doc-v2-17.pdf
342-
- name: v2.17 Operations Guide
343-
link: 2.0/circleci-ops-guide-v2-17.pdf
340+
- name: v2.17.3 Installation Guide
341+
link: 2.0/CircleCI-Server-Installation-Guide.pdf
342+
- name: v2.17.3 Operations Guide
343+
link: 2.0/CircleCI-Server-Operations-Guide.pdf
344344
- name: CircleCI Server v2.16 PDFs
345345
link: 2.0/v.2.16-overview/
346346
children:

0 commit comments

Comments
 (0)