Search Results for ""

Orbs Introduction

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 for the complete list of certified orbs.

Importing an Existing Orb

To import an existing orb, add a single line to to your version 2.1 .circleci/config.yml file for each orb, for example:

version: 2.1

  slack: circleci/slack@0.1.0
  heroku: circleci/heroku@0.0.1

In the above example, two orbs are imported into your config, the Slack orb and the Heroku orb.

Note: If your project was added to CircleCI prior to 2.1, you must enable “pipelines” to use the orbs key.

Authoring Your Own Orb

If you find that there are no existing orbs that meet your needs, you may author your own orb to meet your specific environment or configuration requirements by using the CircleCI CLI as shown in the circleci orb help output below. Although this is more time-consuming than using the import feature, authoring your own orb enables you to create a world-readable orb for sharing your configuration. See Creating Orbs for more information.

$ circleci orb help
Operate on orbs

  circleci orb [command]

Available Commands:
  create      Create an orb in the specified namespace
  list        List orbs
  process     Validate an orb and print its form after all pre-registration processing
  publish     Publish an orb to the registry
  source      Show the source of an orb
  validate    Validate an orb.yml

Note When authoring an orb, you will agree to CircleCI’s Code Sharing Terms of Service when your organization opts-in to 3rd party orb use and authoring. CircleCI thereby licenses all orbs back to users under the MIT License agreement.

Importing Partner Orbs

Import the following Partner Orbs by using the orbs key in your .circleci.yml/config.yml file and replacing <orb reference string> with one from the table.

version: 2.1

  <orb reference string>
Partner Orb Registry Link Orb Reference String
Anchore anchore: anchore/anchore-engine@1.0.0
Aqua Security aqua: aquasecurity/microscanner@0.0.1
AWS ECR ecr: circleci/aws-ecr@4.0.1
Amazon EKS eks: circleci/aws-eks@0.1.0
Azure ACR acr: circleci/azure-acr@0.1.1
Azure AKS aks: circleci/azure-aks@0.1.0
Codecov codecov: codecov/codecov@1.0.1
CodeScene codescene: empear/codescene-ci-cd@1.0.0
Contrast Security contrastsecurity: contrastsecurity/verify@0.1.2
CryptoMove cryptomove: cryptomove/tholos@0.0.11
Cypress-io cypress-io: cypress-io/cypress@1.0.0
Datree datree: datree/policy@1.0.6
DeployHub deployhub: deployhub/deployhub-orb@1.2.0
Docker Hub dockerhub: circleci/docker@0.1.0
Ghost Inspector ghostinspector: ghostinspector/test-runner@1.0.0
Google Container Registry gcr: circleci/gcp-gcr@0.0.7
Google Kubernetes Engine gke: circleci/gcp-gke@0.1.0
Happo happo: happo/happo@1.0.1
Helm helm: circleci/helm@0.1.1
Honeybadger-io honeybadger-io: honeybadger-io/deploy@1.1.1
Honeycomb buildevents: honeycombio/buildevents@0.1.1
Kublr kublr: kublr/kublr-api@0.0.1
LogDNA logdna: logdna/logdna@0.0.1
Nirmata nirmata: nirmata/nirmata@1.1.0
Nowsecure nowsecure: nowsecure/ci-auto-orb@1.0.5
Packagecloud packagecloud: packagecloud/packagecloud@0.1.0
Pantheon pantheon: pantheon-systems/pantheon@0.1.0
Percy percy: percy/agent@0.1.2
Postman postman: postman/newman@0.0.1
Probely probely: probely/security-scan@1.0.0
Provar provar: provartesting/provar@1.9.10
Pulumi pulumi: pulumi/pulumi@1.0.0
Red Hat OpenShift redhat: circleci/redhat-openshift@0.1.0
Rocro rocro: rocro/inspecode@1.0.0
Rollbar rollbar: rollbar/deploy@1.0.0
Rookout rookout: rookout/rookout-node@0.0.2
Sauce Labs saucelabs: saucelabs/sauce-connect@1.0.1
Sonatype sonatype: sonatype/nexus-platform-orb@1.0.2
Styra styra: styra/cli@0.0.7
Testim testim: testimio/runner@1.1.1
Twistlock twistlock: twistlock/twistcli-scan@1.0.4
VMware Code Stream vmware/codestream@1.0.0
WhiteSource whitesource: whitesource/whitesource-scan@18.10.2
xMatters xmatters: xmatters/xmatters-orb@0.0.1

Note: As a prerequisite, you must enable use of 3rd-party orbs on the Settings > Security page for your org.

See Also

  • Refer to Using Orbs, for more about how to use existing orbs.
  • Refer to Creating Orbs, where you will find step-by-step instructions on how to create your own orb.
  • Refer to the Orbs FAQ, where you will find answers to common questions.
  • Refer to Reusing Config for more detailed examples of reusable orbs, commands, parameters, and executors.
  • Refer to Testing Orbs for information about how to test the orbs you have created.
  • Refer to Orbs Registry for more detailed information about legal terms and conditions when using orbs.
  • Refer to Configuration Cookbook for more detailed information about how you can use CircleCI orb recipes in your configurations.