Skip to content

Commit 3f665aa

Browse files
Merge pull request circleci#3418 from rosieyohannan/fix/orbs-cookbook-link
fix orbs cookbook link
2 parents dbb75b9 + 576c39b commit 3f665aa

File tree

6 files changed

+84
-79
lines changed

6 files changed

+84
-79
lines changed

jekyll/_cci2/configuration-cookbook.md

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

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.
1111

1212
* TOC
1313
{:toc}
@@ -18,7 +18,7 @@ This page, and its associated "recipes," describes how you can perform specific
1818

1919
### What Are CircleCI Orbs?
2020

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.
2222

2323
Refer to the [CircleCI Orbs Registry](https://circleci.com/orbs/registry/) for the complete list of available orbs.
2424

@@ -44,29 +44,31 @@ For more detailed information about CircleCI orbs, please refer to the [Orbs Int
4444

4545
`version: 2.1`
4646

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.
4848

49-
2) Add the orbs stanza below your version, which in turn invokes the orb:
49+
![Enable Pipelines]( {{ site.baseurl }}/assets/img/docs/enable_pipelines.png))
50+
51+
2) Add the orbs stanza below your version, which in turn imports the orb:
5052

5153
```yaml
5254
aws-ecs: circleci/[email protected]
5355
```
5456

55-
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.
5658

5759
### Configuration Recipes
5860

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.
6062

61-
Configuration Recipe | Description
63+
Configuration Recipe | Description
6264
------------|-----------
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.
6870

69-
## Deploying Software Changes to Amazon ECS
71+
## Deploying Software Changes to Amazon ECS {#header1}
7072

7173
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.
7274

@@ -176,7 +178,7 @@ This example illustrates how you can use the orb to install and configure the AW
176178

177179
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).
178180

179-
## Deploying Software Changes to Google Kubernetes Engine (GKE)
181+
## Deploying Software Changes to Google Kubernetes Engine (GKE) {#header2}
180182

181183
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.
182184

@@ -235,7 +237,7 @@ commands:
235237
236238
### Publishing and Rolling Out The Image to the GKE Cluster
237239
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.
239241

240242
```yaml
241243
version: 2.1
@@ -307,7 +309,7 @@ The example below shows how you can use the CircleCI GKE orb to log into the Goo
307309
```yaml
308310
publish-and-rollout-image:
309311
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
311313
publishes a Docker image, and then rolls the image out to a GKE cluster."
312314
usage:
313315
version: 2.1
@@ -324,7 +326,7 @@ The example below shows how you can use the CircleCI GKE orb to log into the Goo
324326
tag: "2"
325327
```
326328

327-
## Using Amazon Elastic Container Service for Kubernetes (Amazon EKS)
329+
## Using Amazon Elastic Container Service for Kubernetes (Amazon EKS) {#header3}
328330

329331
CircleCI has developed a Kubernetes orb you can use in coordination with the Amazon Elastic Container Service (ECS) to perform the following tasks:
330332

@@ -345,7 +347,7 @@ Before using the Amazon EKS service, make sure you meet the following requiremen
345347

346348
#### Configuring Your Environment to Use the CircleCI Platform and Orbs
347349

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:
349351

350352
1) Use CircleCI version 2.1 at the top of your `.circleci/config.yml` file.
351353

@@ -470,7 +472,7 @@ steps:
470472

471473
### Create an EKS Cluster
472474

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.
474476

475477
```yaml
476478
Version: 2.1
@@ -520,7 +522,7 @@ After creating a Kubernetes cluster, you may wish to create a Kubernetes deploym
520522
* update the Kubernetes configuration with the authenticator
521523
* update the container image
522524

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.
524526

525527
```yaml
526528
Version: 2.1
@@ -575,7 +577,7 @@ workflows:
575577

576578
### Install Helm On Your Cluster
577579

578-
To simplify the Helm installation on your cluster,
580+
To simplify the Helm installation on your cluster,
579581

580582
```yaml
581583
Version: 2.1
@@ -687,7 +689,7 @@ steps:
687689

688690
#### Install a Helm Chart in Your Cluster
689691

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.
691693

692694
Once Helm is installed in your Kubernetes cluster, you can then install Helm charts using the code example shown below.
693695

@@ -913,7 +915,7 @@ steps:
913915
watch-timeout: << parameters.watch-timeout >>
914916
```
915917
916-
## Deploying Applications to Heroku
918+
## Deploying Applications to Heroku {#header4}
917919
918920
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.
919921
@@ -922,7 +924,7 @@ The Heroku platform is a cloud-based, fully-scalable platform that enables you t
922924
Before you can deploy an applications to the Heroku platform, make sure the following requirements are met:
923925
924926
* 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.
926928
927929
#### Installing the Heroku CLI
928930
@@ -961,7 +963,7 @@ Notice in the above example, when the CircleCI Heroku orb (`circleci/[email protected].
961963

962964
For more detailed information about the CircleCI Heroku orb, refer to the [CircleCI Orb Registry](https://circleci.com/orbs/registry/orb/circleci/heroku).
963965

964-
## Enabling Custom Slack Notifications in CircleCI Jobs
966+
## Enabling Custom Slack Notifications in CircleCI Jobs {#header5}
965967

966968
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.
967969

@@ -991,7 +993,7 @@ For more detailed information about this orb and its functionality, refer to the
991993

992994
### Notifying a Slack Channel With Custom Messages
993995

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.
995997

996998
The example shown below details how you can create a custom message that will be delivered in a specific Slack channel for users.
997999

@@ -1018,10 +1020,10 @@ workflows:
10181020

10191021
After building a Docker image, perform the following steps to create your custom notification:
10201022

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.
10251027

10261028
Once you have performed these steps, invoke the CircleCI Slack orb (`circleci/[email protected]`) to initiate the workflow to deliver your notification.
10271029

jekyll/_cci2/orb-intro.md

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

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.
1111

1212
## Importing an Existing Orb
1313

@@ -21,7 +21,7 @@ orbs:
2121
heroku: circleci/[email protected]
2222
```
2323
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).
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).
2525
2626
**Note:** If your project was added to CircleCI prior to 2.1, you must enable "pipelines" to use the `orbs` key.
2727

@@ -58,7 +58,7 @@ orbs:
5858
<orb reference string>
5959
```
6060

61-
Partner Orb Registry Link | Orb Reference String
61+
Partner Orb Registry Link | Orb Reference String
6262
------------|-----------
6363
[Anchore](https://circleci.com/orbs/registry/orb/anchore/anchore-engine) | `anchore: anchore/[email protected]`
6464
[Aqua Security](https://circleci.com/orbs/registry/orb/aquasecurity/microscanner) | `aqua: aquasecurity/[email protected]`
@@ -110,4 +110,4 @@ Partner Orb Registry Link | Orb Reference String
110110
- Refer to [Reusing Config]({{site.baseurl}}/2.0/reusing-config/) for more detailed examples of reusable orbs, commands, parameters, and executors.
111111
- Refer to [Testing Orbs]({{site.baseurl}}/2.0/testing-orbs/) for information about how to test the orbs you have created.
112112
- 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

Comments
 (0)