Pre-installation requirements for OpenShift

2 minute read

For details about supported platforms for CloudBees CI on modern cloud platforms, such as supported Kubernetes, Helm, and NFS versions, refer to Supported platforms for CloudBees CI on modern cloud platforms.

Installing cbsupport

Before installing CloudBees CI on modern cloud platforms, you should install the cbsupport command-line tool. You can use cbsupport to collect data commonly required for supporting CloudBees products. You can then send that data to the CloudBees Support team to troubleshoot any issues with your CloudBees CI on modern cloud platforms solution.

For instructions on how to install cbsupport, refer to the cbsupport CLI documentation.

OpenShift requirements

An OpenShift cluster with the following specifications is required:

  • A currently supported version of OpenShift. See Supported platforms for CloudBees CI on modern cloud platforms

  • Network access to container images (public Docker Hub or a private Docker Registry).

  • A project with permissions to create Role and RoleBinding objects.

  • Access to the DNS record that points to your installation and TLS certificates for the CloudBees CI on modern cloud platforms deployment.

  • A defined Default Storage Class. See the Storage Requirements section in the AWS or On-premise Reference Architectures for more information.

Additionally, there are some security considerations when running Jenkins agents on OpenShift:

  • Containers must run as a non-root user and group.

  • Containers must not be privileged.

Make sure to read Why do my applications run as a random user ID? and instructions to create images to make sure you are running Docker images that behave correctly on this platform.

Preparing your environment

Before you begin the CloudBees CI on modern cloud platforms installation, you should complete the following steps.

  1. Create an OpenShift project, then set it as the current OpenShift project:

    $ oc new-project cjoc $ oc project cjoc
  2. Set up an administrative workstation. The 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:

    • The OpenShift CLI, installed and configured to work with your OpenShift cluster.

    • The Helm client.

  3. Set up the Helm client. Follow the instructions in the Helm project README to install the Helm client. Detailed instructions for specific operating systems are provided in the installation section.

    If you intend to use the Helm template option, after installing the Helm client, you can skip to Using Helm template command to install CloudBees CI.
  4. Add the CloudBees Helm Chart Repository.

    helm repo add cloudbees (1) helm repo update (2)
    1 The helm repo add adds a new Helm Chart Repository to your Helm installation.
    2 The helm repo update updates your local Helm Chart Repository cache. Your local Helm Chart Repository cache is used by Helm commands like helm search to improve performance.
    Always run helm repo update before you execute a Helm search using helm search. This ensures your cache is up to date.