You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: jekyll/_cci2/configuration-cookbook.md
+32-30Lines changed: 32 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ categories: [getting-started]
7
7
order: 1
8
8
---
9
9
10
-
The *CircleCI Configuration Cookbook* is a collection of individual use cases (referred to as "recipes") that provide you with detailed, step-by-step instructions on how to perform various configuration tasks using CircleCI resources (including CircleCI and partner-certified Orbs). This guide, and it associated sections, will enable you to quickly and easily perform repeatable tasks on the CircleCI platform.
10
+
The *CircleCI Configuration Cookbook* is a collection of individual use cases (referred to as "recipes") that provide you with detailed, step-by-step instructions on how to perform various configuration tasks using CircleCI resources (including CircleCI and partner-certified Orbs). This guide, and its associated sections, will enable you to quickly and easily perform repeatable tasks on the CircleCI platform.
11
11
12
12
* TOC
13
13
{:toc}
@@ -18,7 +18,7 @@ This page, and its associated "recipes," describes how you can perform specific
18
18
19
19
### What Are CircleCI Orbs?
20
20
21
-
CircleCI Orbs are configuration packages that enable you to get started with the CircleCI platform. Orbs enable you to share, standardize, and simplify configurations across your projects. You may also want to use orbs as a refererence for configuration best practices.
21
+
CircleCI orbs are configuration packages that enable you to get started with the CircleCI platform. Orbs enable you to share, standardize, and simplify configurations across your projects. You may also want to use orbs as a refererence for configuration best practices.
22
22
23
23
Refer to the [CircleCI Orbs Registry](https://circleci.com/orbs/registry/) for the complete list of available orbs.
24
24
@@ -44,29 +44,31 @@ For more detailed information about CircleCI orbs, please refer to the [Orbs Int
44
44
45
45
`version: 2.1`
46
46
47
-
**Note:** If you do not already have pipelines enabled, go to **Project Settings -> Advanced Settings** and enable them.
47
+
**Note:** If you do not already have pipelines enabled, go to **Settings > Project**, select settings for the project you are currently working on by clicking its cog icon, select **Advanced Settings** and scroll down to use the radio button to enable pipelines.
48
48
49
-
2) Add the orbs stanza below your version, which in turn invokes the orb:
3) Use the orbs element (e.g. `aws-ecs elements`) in your existing workflows and jobs.
57
+
3) Invoke the orbs element (e.g. `aws-ecs elements`) in your existing workflows and jobs.
56
58
57
59
### Configuration Recipes
58
60
59
-
The table below lists the different build configuration "recipes" you can perform using CircleCI Orbs.
61
+
The table below lists the different build configuration "recipes" you can perform using CircleCI orbs.
60
62
61
-
Configuration Recipe | Description
63
+
Configuration Recipe | Description
62
64
------------|-----------
63
-
Deploying Software Changes to Amazon Elastic Container Service (ECS) | This section describes how you can deploy changes to the Amazon Elastic Container Service (ECS) using a CircleCI-certified ECS orb.
64
-
Deploying Software Changes to Google Kubernetes Engine (GKE) | This section describes how you can deploy changes to the Google Kubernetes Engine (GKE) using a CircleCI-certified GKE orb.
65
-
Using Amazon Elastic Container Service for Kubernetes (Amazon EKS) | This section describes how you can use the Amazon ECS service for Kubernetes for Kubernetes-related tasks and operations.
66
-
Deploying Applications to Heroku | This section describes how you can deploy application to the Heroku platform using the CircleCI Heroku orb.
67
-
Enabling Custom Slack Notifications in CircleCI Jobs | This section describes how you can enable customized Slack notifications in CircleCI jobs.
65
+
[Deploying Software Changes to Amazon Elastic Container Service (ECS)](#header1) | This section describes how you can deploy changes to the Amazon Elastic Container Service (ECS) using a CircleCI-certified ECS orb.
66
+
[Deploying Software Changes to Google Kubernetes Engine (GKE)](#header2) | This section describes how you can deploy changes to the Google Kubernetes Engine (GKE) using a CircleCI-certified GKE orb.
67
+
[Using Amazon Elastic Container Service for Kubernetes (Amazon EKS)](#header3) | This section describes how you can use the Amazon ECS service for Kubernetes for Kubernetes-related tasks and operations.
68
+
[Deploying Applications to Heroku](#header4) | This section describes how you can deploy application to the Heroku platform using the CircleCI Heroku orb.
69
+
[Enabling Custom Slack Notifications in CircleCI Jobs](#header5) | This section describes how you can enable customized Slack notifications in CircleCI jobs.
68
70
69
-
## Deploying Software Changes to Amazon ECS
71
+
## Deploying Software Changes to Amazon ECS {#header1}
70
72
71
73
The Amazon Elastic Container Service (ECS) is a scalable container orchestration service that enables you to support Docker containers and allows you to run and scale containerized applications on AWS. By using Amazon ECS, you will be able to use this service without installing and configuring your own container orchestration software, thereby eliminating the complexity of your deployment and ensuring you have a simple and optimized container deployment on the CircleCI platform. Although this documentation enables you to quickly and easily deploy software changes to the Amazon ECS service using CircleCI orbs, if you would like more detailed information about the how Amazon ECS service works, and its underlying components and architecture, please refer to the [Amazon ECS]( https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html) documentation.
72
74
@@ -176,7 +178,7 @@ This example illustrates how you can use the orb to install and configure the AW
176
178
177
179
For more detailed information about the CircleCI Amazon ECS/ECR orb, refer to the [CircleCI Orb Registry](https://circleci.com/orbs/registry/orb/circleci/aws-ecs).
178
180
179
-
## Deploying Software Changes to Google Kubernetes Engine (GKE)
181
+
## Deploying Software Changes to Google Kubernetes Engine (GKE) {#header2}
180
182
181
183
The Google Kubernetes Engine (GKE) enables you to automate CI/CD strategies to quickly and easily deploy code and application updates to your customers without requiring significant time to deliver these updates. Using the GKE, CircleCI has leveraged this technology, along with development of a GKE-specific CircleCI orb, to enable you to interact with GKE within a specific job. Before working with GKE, you may wish to read Google's technical documentation, which can be found on the [GKE](https://cloud.google.com/kubernetes-engine/docs/) documentation page.
182
184
@@ -235,7 +237,7 @@ commands:
235
237
236
238
### Publishing and Rolling Out The Image to the GKE Cluster
237
239
238
-
Now that you have installed (if necessary) and initialized `gcloud` and updated the docker image, you may then publish and roll out this updated image to the GKE cluster for later use.
240
+
Now that you have installed (if necessary) and initialized `gcloud` and updated the docker image, you may then publish and roll out this updated image to the GKE cluster for later use.
239
241
240
242
```yaml
241
243
version: 2.1
@@ -307,7 +309,7 @@ The example below shows how you can use the CircleCI GKE orb to log into the Goo
307
309
```yaml
308
310
publish-and-rollout-image:
309
311
description: |
310
-
"The simplest example of using this Orb. Logs into GCP, builds and
312
+
"The simplest example of using this Orb. Logs into GCP, builds and
311
313
publishes a Docker image, and then rolls the image out to a GKE cluster."
312
314
usage:
313
315
version: 2.1
@@ -324,7 +326,7 @@ The example below shows how you can use the CircleCI GKE orb to log into the Goo
324
326
tag: "2"
325
327
```
326
328
327
-
## Using Amazon Elastic Container Service for Kubernetes (Amazon EKS)
329
+
## Using Amazon Elastic Container Service for Kubernetes (Amazon EKS) {#header3}
328
330
329
331
CircleCI has developed a Kubernetes orb you can use in coordination with the Amazon Elastic Container Service (ECS) to perform the following tasks:
330
332
@@ -345,7 +347,7 @@ Before using the Amazon EKS service, make sure you meet the following requiremen
345
347
346
348
#### Configuring Your Environment to Use the CircleCI Platform and Orbs
347
349
348
-
To configure your environment to use CircleCI and Orbs, perform the following steps:
350
+
To configure your environment to use CircleCI and orbs, perform the following steps:
349
351
350
352
1) Use CircleCI version 2.1 at the top of your `.circleci/config.yml` file.
351
353
@@ -470,7 +472,7 @@ steps:
470
472
471
473
### Create an EKS Cluster
472
474
473
-
Once you meet the requirements for using the CircleCI AWS-EKS Orb, you may create an EKS cluster using the code sample shown below.
475
+
Once you meet the requirements for using the CircleCI AWS-EKS orb, you may create an EKS cluster using the code sample shown below.
474
476
475
477
```yaml
476
478
Version: 2.1
@@ -520,7 +522,7 @@ After creating a Kubernetes cluster, you may wish to create a Kubernetes deploym
520
522
* update the Kubernetes configuration with the authenticator
521
523
* update the container image
522
524
523
-
The code example below illustrates how you can create the Kubernetes deployment.
525
+
The code example below illustrates how you can create the Kubernetes deployment.
524
526
525
527
```yaml
526
528
Version: 2.1
@@ -575,7 +577,7 @@ workflows:
575
577
576
578
### Install Helm On Your Cluster
577
579
578
-
To simplify the Helm installation on your cluster,
580
+
To simplify the Helm installation on your cluster,
579
581
580
582
```yaml
581
583
Version: 2.1
@@ -687,7 +689,7 @@ steps:
687
689
688
690
#### Install a Helm Chart in Your Cluster
689
691
690
-
Helm is an powerful application package manager that runs on top of a Kubernetes cluster that allows you to describe the application structure by using helm-charts and managing the structure using simple commands. Helm uses a packaging format called charts, which is a collection of files that describe a related set of Kubernetes resources. A single chart might be used to deploy something simple, like a memcached pod, or something complex, like a full web app stack with HTTP servers, databases, caches, and so on.
692
+
Helm is a powerful application package manager that runs on top of a Kubernetes cluster and allows you to describe the application structure by using helm-charts and manage the structure using simple commands. Helm uses a packaging format called charts, which is a collection of files that describe a related set of Kubernetes resources. A single chart might be used to deploy something simple, like a memcached pod, or something complex, like a full web app stack with HTTP servers, databases, caches, and so on.
691
693
692
694
Once Helm is installed in your Kubernetes cluster, you can then install Helm charts using the code example shown below.
693
695
@@ -913,7 +915,7 @@ steps:
913
915
watch-timeout: << parameters.watch-timeout >>
914
916
```
915
917
916
-
## Deploying Applications to Heroku
918
+
## Deploying Applications to Heroku {#header4}
917
919
918
920
The Heroku platform is a cloud-based, fully-scalable platform that enables you to quickly and easily deliver and deploy applications. Using CircleCI builds and orbs, you can simplify the deployment process in a few simple steps by following the steps described in the sections below.
919
921
@@ -922,7 +924,7 @@ The Heroku platform is a cloud-based, fully-scalable platform that enables you t
922
924
Before you can deploy an applications to the Heroku platform, make sure the following requirements are met:
923
925
924
926
* Your environment is configured to use the CircleCI platform and CircleCI orbs.
925
-
* You have installed the Heroku CLI.
927
+
* You have installed the Heroku CLI.
926
928
927
929
#### Installing the Heroku CLI
928
930
@@ -961,7 +963,7 @@ Notice in the above example, when the CircleCI Heroku orb (`circleci/[email protected].
961
963
962
964
For more detailed information about the CircleCI Heroku orb, refer to the [CircleCI Orb Registry](https://circleci.com/orbs/registry/orb/circleci/heroku).
963
965
964
-
## Enabling Custom Slack Notifications in CircleCI Jobs
966
+
## Enabling Custom Slack Notifications in CircleCI Jobs {#header5}
965
967
966
968
Slack is a real-time collaboration application where team members can work together to perform routine tasks and projects through custom channels and workspaces. When using the CircleCI platform, you may find it useful to enable custom notifications with the Slack app based on specific team needs and requirements.
967
969
@@ -991,7 +993,7 @@ For more detailed information about this orb and its functionality, refer to the
991
993
992
994
### Notifying a Slack Channel With Custom Messages
993
995
994
-
Another type of notification you can create using the CircleCI Slack orb is a notification with a custom message created by you. This type of notification is useful when you want to deliver a detailed message to your recipients that is specific to a workflow, job, or project.
996
+
Another type of notification you can create using the CircleCI Slack orb is a notification with a custom message created by you. This type of notification is useful when you want to deliver a detailed message to your recipients that is specific to a workflow, job, or project.
995
997
996
998
The example shown below details how you can create a custom message that will be delivered in a specific Slack channel for users.
997
999
@@ -1018,10 +1020,10 @@ workflows:
1018
1020
1019
1021
After building a Docker image, perform the following steps to create your custom notification:
1020
1022
1021
-
1) Specify the `color` of the text in the message.
1022
-
2) Identify the recipients (`mentions`) of the message.
1023
-
3) Provide the text in the `message` you want delivered.
1024
-
4) Specify the `webhook` for the message.
1023
+
1. Specify the `color` of the text in the message.
1024
+
2. Identify the recipients (`mentions`) of the message.
1025
+
3. Provide the text in the `message` you want delivered.
1026
+
4. Specify the `webhook` for the message – see this [guide](https://api.slack.com/incoming-webhooks) for more on creating Slack webhooks.
1025
1027
1026
1028
Once you have performed these steps, invoke the CircleCI Slack orb (`circleci/[email protected]`) to initiate the workflow to deliver your notification.
Copy file name to clipboardExpand all lines: jekyll/_cci2/orb-intro.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ categories: [getting-started]
7
7
order: 1
8
8
---
9
9
10
-
CircleCI Orbs are shareable packages of configuration elements, including jobs, commands, and executors. CircleCI provides certified orbs, along with 3rd-party orbs authored by CircleCI partners. It is best practice to first evaluate whether any of these existing orbs will help you in your configuration workflow. Refer to the [CircleCI Orbs Registry](https://circleci.com/orbs/registry/) for the complete list of certified orbs.
10
+
CircleCI orbs are shareable packages of configuration elements, including jobs, commands, and executors. CircleCI provides certified orbs, along with 3rd-party orbs authored by CircleCI partners. It is best practice to first evaluate whether any of these existing orbs will help you in your configuration workflow. Refer to the [CircleCI Orbs Registry](https://circleci.com/orbs/registry/) for the complete list of certified orbs.
In the above example, two orbs are imported into your config, the [Slack orb](https://circleci.com/orbs/registry/orb/circleci/slack) and the [Heroku orb](https://circleci.com/orbs/registry/orb/circleci/heroku).
24
+
In the above example, two orbs are imported into your config, the [Slack orb](https://circleci.com/orbs/registry/orb/circleci/slack) and the [Heroku orb](https://circleci.com/orbs/registry/orb/circleci/heroku).
25
25
26
26
**Note:** If your project was added to CircleCI prior to 2.1, you must enable "pipelines" to use the `orbs` key.
- Refer to [Reusing Config]({{site.baseurl}}/2.0/reusing-config/) for more detailed examples of reusable orbs, commands, parameters, and executors.
111
111
- Refer to [Testing Orbs]({{site.baseurl}}/2.0/testing-orbs/) for information about how to test the orbs you have created.
112
112
- Refer to [Orbs Registry](https://circleci.com/orbs/registry/licensing) for more detailed information about legal terms and conditions when using orbs.
113
-
- Refer to [Configuration Cookbook](({{site.baseurl}}/2.0/configuration-cookbook/#configuration-recipes) for more detailed information about how you can use CircleCI orb recipes in your configurations.
113
+
- Refer to [Configuration Cookbook]({{site.baseurl}}/2.0/configuration-cookbook/) for more detailed information about how you can use CircleCI orb recipes in your configurations.
0 commit comments