Prerequisites for using Helm to install CloudBees CI
Before using Helm, you need to do the following:
CloudBees CI must run on a Kubernetes cluster, and the cluster needs to meet these requirements:
A production release of Kubernetes and Helm; beta or test releases of Kubernetes and Helm are not supported.
Kubernetes cluster nodes in each availability zone.
Network access to container images (public Docker Hub or a private Docker Registry).
A namespace in the cluster (provided by your Kubernetes admin) with permissions to create
Access to the DNS record that points to your installation.
SSL certificates (needed when you deploy CloudBees CI).
CloudBees recommends using Kubernetes namespaces when you install CloudBees CI.
When combined with Kubernetes RBAC security, Kubernetes namespaces help a Kubernetes administrator restrict who has access to a namespace and its data.
To set up a Kubernetes namespace:
Type the following commands:
$ kubectl create namespace cloudbees-core $ kubectl config set-context $(kubectl config current-context) --namespace=cloudbees-core
The open-source tools
The administrator should choose which computer will be used to install, update, and maintain CloudBees CI.
This administration workstation may be either the CloudBees CI administrative workstation or a Kubernetes administrative workstation. It must be a workstation on which you have full command privileges for the following utilities:
kubectlKubernetes Control client application, version 1.10 or later.
The Helm client. Follow the instructions in the Helm project README to install the Helm client.
If you intend to use the Helm
CloudBees hosts the Helm chart on CloudBees' public Helm Chart Repository. To access it, you need to add the repository to your Helm environment.
Helm uses CloudBees' public chart repository to automatically download the CloudBees CI Helm chart. If you are unable or do not wish to use the CloudBees CI Helm Chart Repository, the you can download the CloudBees CI Helm Chart from same download site as the CloudBees CI installation package.
Before you can use the
CloudBees repository you must add it to your Helm environment with the
helm repo add command.
To add the CloudBees Public Helm Chart Repository to your Helm environment:
$ helm repo add cloudbees https://charts.cloudbees.com/public/cloudbees (1) $ helm repo update (2)
You can download, or fetch, the latest CloudBees CI Helm chart from the CloudBees Chart Repository using the
helm fetch command.
$ helm fetch cloudbees/cloudbees-core (1) --version 3.4.1 (2) --untar (3)
|1||Adding the optional
|2||Adding the optional
|3||The CloudBees CI download site also includes the CloudBees CI Helm chart archive.|
CloudBees CI requires an NGINX Ingress Controller.
You can skip this section if:
You already have an NGINX Ingress Controller installed. CloudBees CI can utilize an existing controller.
You plan to install a new controller as part of installing the CloudBees CI Helm chart. Using the Helm chart from CloudBees guarantees that the NGINX Ingress Controller meets CloudBees CI’s requirements.
If you do not already have an NGINX Ingress Controller installed and you do not want to install it while you are installing CloudBees CI, follow the steps below.
Before you can proceed, the Helm client needs to be installed. Install it, and then return to Creating the Ingress Controller to complete the setup.
If you already have the Helm client installed, proceed to Creating the Ingress Controller.
Since version 0.22.1 of stable/nginx-ingress chart,
To create an NGINX Ingress Controller:
values.yamlfile with the following content (assuming
cloudbees-coreis the namespace where CloudBees CI is deployed):
rbac: create: true defaultBackend: enabled: false controller: ingressClass: "nginx" scope: enabled: "true" namespace: cloudbees-core service: externalTrafficPolicy: "Local"
Type the following commands to deploy the configuration:
helm install nginx-ingress \ stable/nginx-ingress \ --namespace ingress-nginx \ --values values.yaml \ --version 1.31.0