search

QualiNext / cloudshell-colony-orb

CloudShell orb for CircleCI
0 stars 1 forks source link
circleci-orbs

readme

CloudShell Colony Orb for CircleCI

The CloudShell Colony Orb

CloudShell Colony provides on-demands sandbox environments integrating with test tools and storage providers to pull the artifacts and push to Production.

Using this orb you can integrate the CloudShell Colony sandboxes into your CI/CD pipeline configure in CircleCI

How to use CloudShell Colony Orb

  1. Follow the instructions at the Orb Quick Start Guide to enable usage of Orbs in your projects workflow.

  2. Set up the following environment variables in CircleCI project settings:

    CS_COLONY_SERVER - The url of CloudShell Colony server

    CS_COLONY_TOKEN - The Colony Token which could be generate on integrations page of Colony Settings

    CS_COLONY_SPACE - The name of your CloudShell Colony space

  3. In the config.yml, call the cloudshell-colony/start-sandbox and cloudshell-colony/end-sandbox to start and stop sandbox in Colony

  4. Supply parameters to customize orb behaviour (see the list of parameters for orb commands here

  5. After starting colony sandbox (cloudshell-colony/start-sandbox command) you can use the following environment variables in your job steps (the names of variable could be overridden):

    SANDBOX_ID - the id of launched sandbox

    SANDBOX_DETAILS - the full description of sandbox in json format

    SB_<SANDBOX_ID>_SHORTCUT_<1...N> - quick links of the sandbox