Skip to content

Commit d6ae13a

Browse files
authored
Merge pull request circleci#5056 from circleci/Orb-Intro-Updated-21-01-28
added private orb content
2 parents a999ba8 + 62c7687 commit d6ae13a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

jekyll/_cci2/orb-intro.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,32 @@ CircleCI orbs are open-source, shareable packages of parameterizable [reusable c
1919

2020
Published orbs can be found on our [Orb Registry](https://circleci.com/developer/orbs), or you can [author your own orb]({{site.baseurl}}/2.0/orb-author-intro/).
2121

22+
## Private orbs vs. public orbs
23+
24+
There are two different types of orbs you can use in your configuration, depending on how you want to publish your orbs. If you prefer to publish your orb internally, and not to the [CircleCI Orb Registry](https://circleci.com/developer/orbs), you will want to use a private orb. However, if you want to publish your orb to the [CircleCI Orb Registry](https://circleci.com/developer/orbs), use a public orb. Descriptions of each type of orb is described in the sections below.
25+
26+
### Private orbs
27+
28+
**Note:** Private orbs are currently only available if you are on the [Scale Plan](https://circleci.com/pricing). Please reach out to your sales representative for information on how to sign up for the Scale Plan.
29+
30+
Using a private orb enables you to author an orb while ensuring the following:
31+
32+
* your orb does not appear in the CircleCI Orb Registry.
33+
34+
* your orb cannot be viewed or used by someone outside of your organization.
35+
36+
* your orb cannot be used in a pipeline that does not belong to your organization.
37+
38+
By choosing to use a private orb instead of a public orb, you also need to understand certain limitations inherent in using private orbs, which include:
39+
40+
* you will be unable to use the `circleci config validate` command to validate your configuration. You may, however, paste the content of the orb into the "orbs" stanza of your configuration inline.
41+
42+
* you cannot use private orbs from one organization in another organization's pipelines, regardless of the relationship between organizations. This means that even if you commit code and start a pipeline, and have the necessary membership in both organizations, you can use a private orb from your configuration file, but not from another orb.
43+
44+
### Public orbs
45+
46+
Public orbs are used by most users when authoring and publishing orbs to the [CircleCI Orb Registry](https://circleci.com/developer/orbs). When authoring a public orb, you are enabling all CircleCI users to use your orb in their own configurations.
47+
2248
## Benefits of using orbs
2349

2450
Orbs provide parameterizable configuration elements that can greatly simplify your configuration. To illustrate this, the following example shows a typical configuration for testing a Node.js application – defining a job with the required steps for testing the application – versus using the `test` job provided by the [`circleci/node`](https://circleci.com/developer/orbs/orb/circleci/node) orb. With orbs, it is possible to write a parameterized configuration once and utilize it across multiple similar projects.

0 commit comments

Comments
 (0)