Installation methods

2 minute read

The following installation methods are available:

  • Helm - This is the recommended installation method. You should be familiar with Helm before you use it to install CloudBees CI. See installing using Helm for instructions.

  • Helm template - This method generates the required YAML manifests in order to be used through kubectl CLI. This method is recommended if for some reason you are unable to install directly via Helm. See installing using Helm for instructions.

Installation via the CloudBees installer has been deprecated as of the release of CloudBees CI on modern cloud platforms

About using Helm to install CloudBees CI

Using Helm to install CloudBees CI provides the following advantages:

  • It lets you customize the CloudBees CI installation without resorting to error-prone modification of the CloudBees CI YAML files.

  • It provides a history of changes applied to the CloudBees CI release.

  • It provides a simpler and more robust rollback option.

  • It provides a straightforward method of creating custom environment deployments of CloudBees CI.

For example: development, staging, and production CloudBees CI environments.

Things you should know before using Helm

Using the Internet to download the Helm chart and the chart dependencies is the preferred method, but you can install a chart from a local archive that has been downloaded beforehand.

About Helm charts

A Helm chart is a package that defines a Kubernetes application and its dependencies.

The chart is a combination of YAML templates for Kubernetes resources, such as pods, replica sets, deployments or ingresses. It also provides a values file that populates default configuration values for the templates.

Instead of manually editing files, Helm manages the process by merging the templates files and the values into a custom YAML file. It then applies and tracks the deployment of the YAML file on the Kubernetes cluster.

Working with Helm in an airgapped environment

When working in an airgapped environment, the following method can be applied:

  1. Use helm fetch to download a Helm chart from the chart repository.

  2. Copy the Helm chart archive over to the airgapped environment.

  3. Use helm install [NAME] [CHART] [flags] where [CHART] refers to the Helm chart archive to install the Helm chart in the airgapped Kubernetes cluster.