Skip to content

Commit 16ec981

Browse files
committed
Merge branch 'master' of https://github.com/circleci/circleci-docs into tjs/4679
2 parents edcb2c3 + bdd0a87 commit 16ec981

File tree

159 files changed

+775
-333
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

159 files changed

+775
-333
lines changed

jekyll/_cci2/add-ssh-key.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ title: "Adding an SSH Key to CircleCI"
44
short-title: "Adding an SSH Key"
55
description: "How to Add an SSH Key to CircleCI"
66
order: 20
7+
version:
8+
- Cloud
9+
- Server v2.x
710
---
811

912
If deploying to your servers requires SSH access,
@@ -20,10 +23,19 @@ to add SSH keys to CircleCI:
2023
If you are adding an SSH key for the first reason,
2124
refer to the [GitHub and Bitbucket Integration]({{ site.baseurl }}/2.0/gh-bb-integration/#enable-your-project-to-check-out-additional-private-repositories) document.
2225
Otherwise,
23-
follow the steps below to add an SSH key to your project.
26+
follow the steps below for the version of CircleCI you are using (Cloud/Server) to add an SSH key to your project.
2427

2528
## Steps
2629

30+
**Note:**
31+
Since CircleCI cannot decrypt SSH keys,
32+
every new key must have an empty passphrase.
33+
CircleCI also will not accept OpenSSH's default file format - use `ssh-keygen -m pem` if you are using OpenSSH to generate your key.
34+
35+
**Caution:** Recent updates in `ssh-keygen` don't generate the key in PEM format by default. If your private key does not start with `-----BEGIN RSA PRIVATE KEY-----`, enforce PEM format by generating the key with `ssh-keygen -m PEM -t rsa -C "[email protected]"`
36+
37+
### CircleCI Cloud
38+
2739
1. In a terminal, generate the key with `ssh-keygen -m PEM -t rsa -C "[email protected]"`. See the [(SSH) Secure Shell documentation](https://www.ssh.com/ssh/keygen/) web site for additional details.
2840

2941
2. In the CircleCI application,
@@ -48,13 +60,29 @@ you are adding.
4860

4961
8. Click the **Add SSH Key** button.
5062

51-
**Note:**
52-
Since CircleCI cannot decrypt SSH keys,
53-
every new key must have an empty passphrase.
54-
CircleCI also will not accept OpenSSH's default file format - use `ssh-keygen -m pem` if you are using OpenSSH to generate your key.
63+
### CircleCI Server
5564

56-
**Caution:** Recent updates in `ssh-keygen` don't generate the key in PEM format by default. If your private key does not start with `-----BEGIN RSA PRIVATE KEY-----`, enforce PEM format by generating the key with `ssh-keygen -m PEM -t rsa -C "[email protected]"`
65+
1. In a terminal, generate the key with `ssh-keygen -m PEM -t rsa -C "[email protected]"`. See the [(SSH) Secure Shell documentation](https://www.ssh.com/ssh/keygen/) web site for additional details.
66+
67+
2. In the CircleCI application,
68+
go to your project's settings
69+
by clicking the gear icon next to your project.
70+
71+
2. In the **Permissions** section,
72+
click on **SSH Permissions**.
73+
74+
3. Click the **Add SSH Key** button.
75+
76+
4. In the **Hostname** field,
77+
enter the key's associated host (for example, "git.heroku.com").
78+
If you don't specify a hostname,
79+
the key will be used for all hosts.
80+
81+
5. In the **Private Key** field,
82+
paste the SSH key
83+
you are adding.
5784

85+
6. Click the **Add SSH Key** button.
5886

5987
## Adding SSH Keys to a Job
6088

jekyll/_cci2/admin-faq.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
version:
3+
- Server v2.x
4+
- Admin
5+
---
16
= Frequently Asked Questions
27
:page-layout: classic-docs
38
:page-liquid:

jekyll/_cci2/api-developers-guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ short-title: "Developer's Guide"
55
description: "API cookbook for internal and external CircleCI developers"
66
categories: [getting-started]
77
order: 1
8+
version:
9+
- Cloud
810
---
911

1012
This *API Developer's Guide* was written to assist developers in quickly and easily making API calls to CircleCI services to return detailed information about users, pipelines, projects and workflows.

jekyll/_cci2/api-intro.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@ short-title: "API Reference"
55
description: "Introduction to the CircleCI API"
66
categories: [getting-started]
77
order: 1
8+
version:
9+
- Cloud
810
---
911

1012
The CircleCI API may be used to make API calls to retrieve detailed information about users, jobs, workflows and pipelines. There are currently two supported API versions:
1113

1214
* [API v1.1 Reference](https://circleci.com/docs/api/v1/)
1315
* [API v2 Reference](https://circleci.com/docs/api/v2/)
1416

15-
API v2 includes several powerful features (e.g. support for pipelines and pipeline parameters) that are unavailable in API v1.1. It is recommended that users migrate their scripts to API v2 stable endpoints as soon as possible.
17+
API v2 includes several powerful features (e.g. support for pipelines and pipeline parameters) that are unavailable in API v1.1. It is recommended that CircleCI Cloud users migrate their scripts to API v2 stable endpoints as soon as possible.
1618

1719
CircleCI API v1.1 and portions of API v2 are supported and generally available. CircleCI expects to eventually End-Of-Life (EOL) API v1.1 in favor of API v2 as more API v2 endpoints are announced as stable. Further guidance on when CircleCI API v1.1 will be discontinued will be communicated at a future date.
1820

jekyll/_cci2/api-job-trigger.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ short-title: "Using the API to Trigger Jobs"
55
description: "How to define and trigger non-build jobs"
66
categories: [configuring-jobs]
77
order: 80
8+
version:
9+
- Cloud
10+
- Server v2.x
811
---
912

1013

jekyll/_cci2/arch_components.png

-39.5 KB
Binary file not shown.

jekyll/_cci2/arch_server.png

-69.2 KB
Binary file not shown.

jekyll/_cci2/architecture.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
version:
3+
- Server v2.x
4+
---
15
= CircleCI Server Container Architecture
26
:page-layout: classic-docs
37
:page-liquid:

jekyll/_cci2/artifactory.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ layout: classic-docs
33
title: Upload to Artifactory
44
categories: [how-to]
55
description: How to upload Artifacts to Artifactory in CircleCI
6+
version:
7+
- Cloud
8+
- Server v2.x
69
---
710

811
CircleCI supports uploading directly to Artifactory.
@@ -14,9 +17,9 @@ CircleCI supports uploading directly to Artifactory.
1417

1518
Artifactory has great documentation explaining how to leverage their [REST API](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API).
1619

17-
We'll use this space to highlight some sample projects showing how to best leverage CircleCI and Artifactory together.
20+
We will use this space to highlight some sample projects showing how to best use CircleCI and Artifactory together.
1821

19-
Ensure that you've created your repository before starting this example, otherwise CircleCI won't have a place to store your dependencies.
22+
Ensure that you have created your repository before starting this example, otherwise CircleCI won't have a place to store your dependencies.
2023

2124
## Artifactory Plugins
2225
Popular tools like Maven and Gradle have Artifactory plugins, and can deploy to Artifactory using their respective deploy commands.
@@ -37,23 +40,23 @@ If you want to use the JFrog CLI, you can install it by adding the following to
3740
Now we need to configure JFrog to use our credentials securely. We configure the client to use our `$ARTIFACTORY_URL`, along with our `$ARTIFACTORY_USER` and `$ARTIFACTORY_APIKEY`. These can be entered under `Project Settings->Environment Variables`
3841

3942
```
40-
- run: ./jfrog rt config --url $ARTIFACTORY_URL --user $ARTIFACTORY_USER --apikey $ARTIFACTORY_APIKEY --interactive=false
43+
- run: ./jfrog rt config --url $ARTIFACTORY_URL --user $ARTIFACTORY_USER --apikey $ARTIFACTORY_APIKEY --interactive=false
4144
4245
```
4346

44-
If you'd like to upload JAR files use the following example:
47+
If you would like to upload JAR files use the following example:
4548

4649
```
47-
- run: ./jfrog rt u "multi*/*.jar" <artifactory_repo_name> --build-name=<name_you_give_to_build> --build-number=$CIRCLE_BUILD_NUM --flat=false
50+
- run: ./jfrog rt u "multi*/*.jar" <artifactory_repo_name> --build-name=<name_you_give_to_build> --build-number=$CIRCLE_BUILD_NUM --flat=false
4851
```
4952

50-
If you'd like to upload WAR files use the following example:
53+
If you would like to upload WAR files use the following example:
5154

5255
```
53-
- run: ./jfrog rt u "multi*/*.war" <artifactory_repo_name> --build-name=<name_you_give_to_build> --build-number=$CIRCLE_BUILD_NUM --flat=false
56+
- run: ./jfrog rt u "multi*/*.war" <artifactory_repo_name> --build-name=<name_you_give_to_build> --build-number=$CIRCLE_BUILD_NUM --flat=false
5457
```
5558

56-
The full .circleci/config.yml file would look something like the following:
59+
The full `.circleci/config.yml` file would look something like the following:
5760

5861
```yaml
5962
version: 2

jekyll/_cci2/artifacts.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ short-title: "Storing Build Artifacts"
55
description: "Example of uploading artifacts created during a build"
66
categories: [configuring-jobs]
77
order: 70
8+
version:
9+
- Cloud
10+
- Server v2.x
811
---
912

1013
This document describes how to work with Artifacts in the following sections:

jekyll/_cci2/authentication.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
version:
3+
- Server v2.x
4+
- Server Admin
5+
---
16
= Authentication
27
:page-layout: classic-docs
38
:page-liquid:

jekyll/_cci2/aws-manual.md

Lines changed: 0 additions & 189 deletions
This file was deleted.

jekyll/_cci2/aws-prereq.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
version:
3+
- Server v2.x
4+
---
15
= Installation Prerequisites
26
:page-layout: classic-docs
37
:page-liquid:

jekyll/_cci2/aws-teardown.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
version:
3+
- Server v2.x
4+
---
15
= Teardown
26
:page-layout: classic-docs
37
:page-liquid:

0 commit comments

Comments
 (0)