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 |
The operations center distributes CasC bundles to controllers from local storage.
The type of controller determines how you can make the configuration bundle available for distribution by the operations center:
Client controllers: Deploying a bundle to the operations center
Managed controllers: Manipulating CasC bundles using kubectl
To deploy a CasC bundle to the operations center for client controllers:
Copy the directory containing the bundle files to your
Ensure the owner and group of the bundle directory and files match those of other files under
$JENKINS_HOMEand are sufficient to allow the CloudBees CI user to read the files.
Configuration bundles are stored on the operations center in the same way as on traditional platforms, but some additional steps are required to manipulate the files. The following sections explain how to manipulate the bundles using kubectl, the Kubernetes command-line tool. The following sample text will be used where you need to substitute your own values:
<NAMESPACE>- the Kubernetes namespace into which you installed CloudBees CI on modern cloud platforms
<BUNDLE_DIR>- the local directory containing your bundle files
|Users loading bundles from an SCM do not need to use kubectl to manage bundles. For more information, see [Loading CasC bundles from a SCM tool].|
Run the following command to display a list of the bundles that are currently deployed to the operations center and available for use:
kubectl exec --namespace <NAMESPACE> cjoc-0 -- ls /var/jenkins_home/jcasc-bundles-store
Example command to list the bundles deployed to the operations center running in namespace
kubectl exec --namespace cloudbees-core cjoc-0 -- ls /var/jenkins_home/jcasc-bundles-store
Copy the directory containing the bundle files to the operations center using the following command:
kubectl cp --namespace <NAMESPACE> <BUNDLE_DIR> \ cjoc-0:/var/jenkins_home/jcasc-bundles-store/
Example command to deploy the bundle directory
my-new-bundle to the operations center running in namespace
kubectl cp --namespace cloudbees-core my-new-bundle \ cjoc-0:/var/jenkins_home/jcasc-bundles-store/
Put all bundles into a directory named
jcasc-bundles-store. Copy the
jcasc-bundles-store directory to the operations center using the following command:
kubectl cp --namespace <NAMESPACE> <BUNDLE_DIR> \ cjoc-0:/var/jenkins_home
Example command to deploy all bundles to the operations center running in namespace
kubectl cp --namespace cloudbees-core jcasc-bundles-store \ cjoc-0:/var/jenkins_home
Delete the bundle directory on the operations center using the following command:
kubectl exec --namespace <NAMESPACE> cjoc-0 -- \ rm -rf /var/jenkins_home/jcasc-bundles-store/<BUNDLE_DIR>
Example command to delete the bundle named
my-old-bundle from the operations center running in namespace
kubectl exec --namespace cloudbees-core cjoc-0 -- \ rm -rf /var/jenkins_home/jcasc-bundles-store/my-old-bundle
To update a bundle on the operations center, overwrite the bundle files with the updated bundle files.
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.|
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
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:
Ensure you are signed in to the operations center as a user with the Administer permission.
From the operations center dashboard, select New Item in the left pane.
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.
Scroll down to Source Code Management, select an SCM, and then enter the repository location.
Scroll down to Build, and then select Add build step.
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 CI. 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.
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.
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.