Adding a CasC bundle for controllers to the operations center

3 minute readScalabilityAutomation

Configuration bundles are made available from the operations center to connected controllers using HTTP/HTTPS. Configuration bundles are stored on the operations center server as a folder containing the bundle files.

Multiple Configuration as Code (CasC) for Controllers bundles can be deployed to the operations center server and are all stored in $JENKINS_HOME/jcasc-bundles-store. For example:

$JENKINS_HOME/jcasc-bundles-store/
├── bundle-1
│   ├── bundle.yaml
│   ├── jenkins.yaml
│   ├── plugins.yaml
│   ├── plugin-catalog.yaml
│   ├── items.yaml
│   └── rbac.yaml
└── bundle-2
    ├── bundle.yaml
    ├── jenkins.yaml
    ├── plugins.yaml
    ├── plugin-catalog.yaml
    ├── items.yaml
    └── rbac.yaml
While the operations center simplifies the management of bundles, it is possible to configure a controller with a bundle without the operations center using the -Dcore.casc.config.bundle=/path/to/casc-bundle Java system property.

Adding files to the operations center manually

The operations center distributes CasC bundles to controllers from local storage.

To deploy a CasC bundle to the operations center for client controllers:

  1. Copy the directory containing the bundle files to your $JENKINS_HOME/jcasc-bundles-store directory.

  2. Ensure the owner and group of the bundle directory and files match those of other files under $JENKINS_HOME and are sufficient to allow the CloudBees Jenkins Platform user to read the files.

Loading CasC bundles from a source control management (SCM) tool

The operations center distributes CasC bundles to controllers from local storage. CasC controller bundles can also be synchronized with an external SCM tool using a Freestyle job that can be triggered manually or triggered automatically using webhooks.

The executor must be configured in an operations center instance and is not supported on an agent or a controller. If the Freestyle job is triggered on an agent or controller that is attached to the operations center, the build will fail.

Prerequisites

CasC bundles can be stored in one or more SCM repositories. However, this guide assumes all bundles are in the same Git repository, with the following layout:

mycompany.com/config-bundles.git
- bundle-1
  -- bundle.yaml
  -- jenkins.yaml
  -- plugins.yaml
  -- plugin-catalog.yaml
  -- items.yaml
  -- rbac.yaml
- bundle-2
  -- bundle.yaml
  -- jenkins.yaml
  -- plugins.yaml
  -- plugin-catalog.yaml
  -- items.yaml
  -- rbac.yaml

Creating a Freestyle job in the operations center

The operations center distributes bundles from local storage. To synchronize CasC bundles from an external SCM tool, you must create a Freestyle job to pull the bundles from the SCM tool to the operations center’s local storage.

To create a Freestyle job to synchronize CasC bundles:

  1. Ensure you are signed in to the operations center as a user with the Administer permission.

  2. From the operations center dashboard, select New Item in the left pane.

  3. Specify an item name, select Freestyle project, and then select OK.

    You must use a Freestyle job because Pipeline jobs are not supported in the operations center.
  4. Scroll down to Source Code Management, select an SCM, and then enter the repository location.

  5. Scroll down to Build, and then select Add build step.

  6. Select the type of build step. You have two options:

    • Option 1: Select the Synchronize bundles from workspace with internal storage build step.

      Optionally, select Purge deleted bundles to automatically purge bundles from the operations center that have been deleted from the SCM tool.

    • Option 2: Select the Execute shell build step and add the following script:

      cp -r my-controller-1 $JENKINS_HOME/jcasc-bundles-store
      cp -r my-controller-2 $JENKINS_HOME/jcasc-bundles-store
      • $JENKINS_HOME/ is the default Jenkins home directory in CloudBees Jenkins Platform. Update the script if your Jenkins home directory is in a different location.

      • The Execute shell build step can synchronize new bundles or update existing bundles stored in the operations center. However, bundles that have been deleted from the SCM tool are not automatically purged from the operations center’s local storage.

  7. Select Save, and then trigger a build.

The CasC bundles should now be available in the operations center’s local storage and ready to be used by controllers.

Triggering the Freestyle job automatically using webhooks

One way to trigger a Freestyle job to pull CasC bundles from an SCM is through the use of webhooks. If your SCM supports webhooks, configure a webhook in the SCM to trigger builds on the importing job on push events.

Setting up a webhook through your SCM will ensure a change made in the repository will be automatically available to controllers using the CasC bundle.

In August 2020, the Jenkins project voted to replace the term master with controller. We have taken a pragmatic approach to cleaning these up, ensuring the least amount of downstream impact as possible. CloudBees is committed to ensuring a culture and environment of inclusiveness and acceptance - this includes ensuring the changes are not just cosmetic ones, but pervasive. As this change happens, please note that the term master has been replaced through the latest versions of the CloudBees documentation with controller (as in managed controller, client controller, team controller) except when still used in the UI or in code.