|
1 | 1 | ---
|
2 | 2 | layout: classic-docs
|
3 |
| -title: "Orb User - Configuration" |
4 |
| -short-title: "Orb Platform Configuration" |
5 |
| -description: "Configuring your platform to use orbs" |
| 3 | +title: "Setting Your Platform Version to Work With Orbs" |
| 4 | +short-title: "Setting Your Platform Version for Orbs" |
| 5 | +description: "How to set your platform version so you can work with CircleCI and Partner orbs" |
6 | 6 | categories: [getting-started]
|
7 | 7 | order: 1
|
8 | 8 | ---
|
9 | 9 |
|
10 | 10 | ## Introduction
|
11 | 11 |
|
12 |
| -Orbs are packages of configuration that you can use to quickly get started with the CircleCI platform. Orbs enable you to share, standardize, and simplify configurations across your projects without much customization and work. You may also want to use orbs as a refererence for configuration best practices. |
| 12 | +Before you can work with CircleCI and Partner-certified orbs, you must first ensure that your platform version is set to `2.1` in your `config.yml`. Previous versions do not currently support working with orbs. |
13 | 13 |
|
14 |
| -Refer to the [CircleCI Orbs Registry](https://circleci.com/orbs/registry/) for the complete list of available orbs. |
| 14 | +The section below describes how you can set your platform version to 2.1 so you can work with orbs. |
15 | 15 |
|
16 |
| -## Configure Your Platform to Work With Orbs |
| 16 | +## Setting Your Platform to Work With Orbs |
17 | 17 |
|
18 |
| -Configuring your platform to work with orbs is a very simple process, requiring you to invoke the orb you have chosen to use from the CircleCI Orbs Registry. |
| 18 | +Setting your platform version to work with orbs is a very simple process, requiring you to perform the following steps: |
19 | 19 |
|
20 |
| -To use an existing orb from the CircleCI Orbs Registry in your 2.1 `circleci/config.yml` file, invoke the orb with the `orbs` key. |
| 20 | +1) Use CircleCI version 2.1 at the top of your `.circleci/config.yml` file. |
| 21 | + |
| 22 | +`version: 2.1` |
| 23 | + |
| 24 | +**Note** If you do not already have Pipelines enabled, you'll need to go to **Project Settings -> Advanced Settings** and turn it on. |
| 25 | + |
| 26 | +2) Add the `orbs` stanza below your version, thereby invoking the orb. The example below shows how you can invoke the `aws-cli` orb. |
| 27 | + |
| 28 | +``` |
| 29 | +orbs: |
| 30 | + aws-cli: circleci/[email protected] |
| 31 | +``` |
| 32 | + |
| 33 | +3) Use the elements specific to your selected orb in your existing workflows and jobs. |
| 34 | + |
| 35 | +### Hello World Example |
21 | 36 |
|
22 | 37 | The example below demonstrates how you can invoke the `hello-build` orb in the `circleci` namespace.
|
23 | 38 |
|
|
0 commit comments