OpenShift v4

Prisma Cloud Defenders are deployed as a DaemonSet, which ensures that an instance of Defender runs on every node in the cluster. You can run Defenders on OpenShift master and infrastructure nodes by removing the taint from them.
The Prisma Cloud Defender container images can be stored either in the internal OpenShift registry or your own Docker v2 compliant registry. Alternatively, you can configure your deployments to pull images from Prisma Cloud’s cloud registry.
This guide shows you how to generate deployment YAML files for both Console and Defender, and then deploy them to your OpenShift cluster with the oc client.
Prisma Cloud Defenders are deployed as a DaemonSet, which ensures that an instance of Defender runs on every node in the cluster. You can run Defenders on OpenShift master and infrastructure nodes using node selectors.
The Prisma Cloud Defender container image can be stored either in the internal OpenShift registry or your own Docker v2 compliant registry. Alternatively, you can configure your deployments to pull from Prisma Cloud’s cloud registry.
This guide shows you how to generate a deployment YAML file for Defender, and then deploy it to your OpenShift cluster with the oc client.
To better understand clusters, read our cluster context topic.

Preflight checklist

To ensure that your installation on supported versions of OpenShift v4.x goes smoothly, work through the following checklist and validate that all requirements are met.

Minimum system requirements

Validate that the components in your environment (nodes, host operating systems, orchestrator) meet the specs in System requirements.

Permissions

Validate that you have permission to:
  • Push to a private docker registry. For most OpenShift setups, the registry runs inside the cluster as a service. You must be able to authenticate with your registry with docker login.
  • Pull images from your registry. This might require the creation of a docker-registry secret.
  • Have the correct role bindings to pull and push to the registry. For more information, see Accessing the Registry.
  • Create and delete projects in your cluster. For OpenShift installations, a project is created when you run oc new-project.
  • Run oc create commands.

Network connectivity

Validate that outbound connections to your Console can be made on port 443.

Install Prisma Cloud

Use twistcli to install the Prisma Cloud Defenders in your OpenShift cluster. The twistcli utility is included with every release.

Create an OpenShift project for Prisma Cloud

Create a project named twistlock.
  1. Login to the OpenShift cluster and create the twistlock project:
    $ oc new-project twistlock

(Optional) Push the Prisma Cloud images to a private registry

When Prisma Cloud is deployed to your cluster, the images are retrieved from a registry. You have a number of options for storing the Prisma Cloud Console and Defender images:
  • OpenShift internal registry.
  • Private Docker v2 registry. You must create a docker-secret to authenticate with the registry.
Alternatively, you can pull the images from the Prisma Cloud cloud registry at deployment time. Your cluster nodes must be able to connect to the Prisma Cloud cloud registry (registry-auth.twistlock.com) with TLS on TCP port 443.
This guides shows you how to use both the OpenShift internal registry and the Prisma Cloud cloud registry. If you’re going to use the Prisma Cloud cloud registry, you can skip this section. Otherwise, this procedure shows you how to pull, tag, and upload the Prisma Cloud images to the OpenShift internal registry’s twistlock imageStream.
  1. Determine the endpoint for your OpenShift internal registry. Use either the internal registry’s service name or cluster IP.
    $ oc get svc -n default NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE docker-registry ClusterIP 172.30.163.181 <none> 5000/TCP 88d
  2. Pull the image from the Prisma Cloud cloud registry using your access token. The major, minor, and patch numerals in the <VERSION> string are separated with an underscore. For exampe, 18.11.128 would be 18_11_128.
    $ docker pull \ registry-auth.twistlock.com/tw_<ACCESS_TOKEN>/twistlock/defender:defender_<VERSION>
  3. Tag the image for the OpenShift internal registry.
    $ docker tag \ registry-auth.twistlock.com/tw_<ACCESS_TOKEN>/twistlock/defender:defender_<VERSION> \ 172.30.163.181:5000/twistlock/private:defender_<VERSION>
  4. Push the image to the twistlock project’s imageStream.
    $ docker push 172.30.163.181:5000/twistlock/private:defender_<VERSION>

Install Defender

Defender is installed as a DaemonSet, which ensures that an instance of Defender runs on every node in the cluster. Use twistcli to generate a YAML configuration file or Helm chart for the Defender DaemonSet, then deploy it using oc. You can use the same method to deploy Defender DaemonSets from both macOS and Linux.
The benefit of declarative object management, where you work directly with YAML configuration files, is that you get the full "source code" for the objects you create in your cluster. You can use a version control tool to manage and track modifications to config files so that you can delete and reliably recreate DaemonSets in your environment.
If you don’t have kubectl access to your cluster (or oc access for OpenShift), you can deploy Defender DaemonSets directly from the Console UI.
The following procedure shows you how to deploy Defender DaemonSets with twistcli using declarative object management. Alternatively, you can generate Defender DaemonSet install commands in the Console UI under
Manage > Defenders > Deploy > DaemonSet
. Install scripts work on Linux hosts only. For macOS and Windows hosts, use twistcli to generate Defender DaemonSet YAML configuration files, and then deploy it with oc, as described in the following procedure.

Get connection strings

When calling twistcli to generate your YAML files and Helm charts, you’ll need to specify a couple of addresses.
  1. Retrieve Console’s URL (PRISMA_CLOUD_COMPUTE_CONSOLE_URL).
    1. Sign into Prisma Cloud.
    2. Go to
      Compute > Manage > System > Utilities
      .
    3. Copy the URL under
      Path to Console
      .
  2. Retrieve Console’s hostname (PRISMA_CLOUD_COMPUTE_HOSTNAME).
    The hostname can be derived from the URL by removing the protocol scheme and path. It is simply the host part of the URL. You can also retrieve the hostname directly.
    1. Go to
      Compute > Manage > Defenders > Deploy > Defenders > Orchestrator
    2. Select
      OpenShift
      from
      Step 2
      (
      Choose the orchestrator type
      )
    3. Copy the hostname from
      Step 3
      (
      The name that Defender will use to connect to this Console
      )

Option #1: Deploy with YAML files

Deploy the Defender DaemonSet with YAML files.
The twistcli defender export command can be used to generate native Kubernetes YAML files to deploy the Defender as a DaemonSet.
  1. Generate a defender.yaml file, where:
    The following command connects to Console (specified in --address) as user <ADMIN> (specified in --user), and generates a Defender DaemonSet YAML config file according to the configuration options passed to twistcli. The --cluster-address option specifies the address Defender uses to connect to Console.
    $ <PLATFORM>/twistcli defender export openshift \ --user <ADMIN_USER> \ --address <PRISMA_CLOUD_COMPUTE_CONSOLE_URL> \ --cluster-address <PRISMA_CLOUD_COMPUTE_HOSTNAME> \ --cri
    • <PLATFORM> can be linux, osx, or windows.
    • <ADMIN_USER> is the name of a Prisma Cloud user with the System Admin role.
  2. Deploy the Defender DaemonSet.
    $ oc create -f ./defender.yaml

Option #2: Deploy with Helm chart

Deploy the Defender DaemonSet with a Helm chart.
Prisma Cloud Defenders Helm charts fail to install on OpenShift 4 clusters due to a Helm bug. If you generate a Helm chart, and try to install it in an OpenShift 4 cluster, you’ll get the following error:
Error: unable to recognize "": no matches for kind "SecurityContextConstraints" in version "v1"
To work around the issue, manually modify the generated Helm chart.
  1. Generate the Defender DaemonSet helm chart.
    A number of command variations are provided. Use them as a basis for constructing your own working command.
    The following commands connects to Console (specified in --address) as user <ADMIN> (specified in --user), and generates a Defender DaemonSet YAML config file according to the configuration options passed to twistcli. The --cluster-address option specifies the address Defender uses to connect to Console.
    Outside the OpenShift cluster + pull the Defender image from the Prisma Cloud cloud registry.
    Use the OpenShift external route for your Prisma Cloud Console, --address https://twistlock-console.apps.ose.example.com. Designate Prisma Cloud’s cloud registry by omitting the --image-name flag. Defining CRI-O as the default container engine by using the -cri flag.
    $ <PLATFORM>/twistcli defender export openshift \ --user <ADMIN_USER> \ --address <PRISMA_CLOUD_COMPUTE_CONSOLE_URL> \ --cluster-address <PRISMA_CLOUD_COMPUTE_HOSTNAME> \ --cri \ --helm
    Outside the OpenShift cluster + pull the Defender image from the OpenShift internal registry.
    Use the --image-name flag to designate an image from the OpenShift internal registry. Defining CRI-O as the default container engine by using the -cri flag.
    $ <PLATFORM>/twistcli defender export openshift \ --user <ADMIN_USER> \ --address <PRISMA_CLOUD_COMPUTE_CONSOLE_URL> \ --cluster-address <PRISMA_CLOUD_COMPUTE_HOSTNAME> \ --image-name 172.30.163.181:5000/twistlock/private:defender_<VERSION> \ --cri \ --helm
    Inside the OpenShift cluster + pull the Defender image from the Prisma Cloud cloud registry.
    When generating the Defender DaemonSet YAML with twistcli from a node inside the cluster, use Console’s service name (twistlock-console) or cluster IP in the --cluster-address flag. This flag specifies the endpoint for the Prisma Cloud Compute API and must include the port number. Defining CRI-O as the default container engine by using the -cri flag.
    $ <PLATFORM>/twistcli defender export openshift \ --user <ADMIN_USER> \ --address <PRISMA_CLOUD_COMPUTE_CONSOLE_URL> \ --cluster-address <PRISMA_CLOUD_COMPUTE_HOSTNAME> \ --cri \ --helm
    Inside the OpenShift cluster + pull the Defender image from the OpenShift internal registry.
    Use the --image-name flag to designate an image in the OpenShift internal registry. Defining CRI-O as the default container engine by using the -cri flag.
    $ <PLATFORM>/twistcli defender export openshift \ --user <ADMIN_USER> \ --address <PRISMA_CLOUD_COMPUTE_CONSOLE_URL> \ --cluster-address <PRISMA_CLOUD_COMPUTE_HOSTNAME> \ --image-name 172.30.163.181:5000/twistlock/private:defender_<VERSION> \ --cri \ --helm
  2. Unpack the chart into a temporary directory.
    $ mkdir helm-defender $ tar xvzf twistlock-defender-helm.tar.gz -C helm-defender/
  3. {{- if .Values.openshift }} apiVersion: security.openshift.io/v1 kind: SecurityContextConstraints metadata: name: twistlock-console ...
  4. Repack the Helm chart
    $ cd helm-defender/ $ tar cvzf twistlock-defender-helm.tar.gz twistlock-defender/
  5. Install the new helm chart via the helm command
    $ helm install --namespace=twistlock -g twistlock-defender-helm.tar.gz

Confirm Defenders were deployed

Confirm the installation was successful.
  1. In Prisma Cloud Console, go to
    Compute > Manage > Defenders > Manage
    to see a list of deployed Defenders.
  2. In the OpenShift Web Console, go to the Prisma Cloud project’s monitoring window to see which pods are running.
  3. Use the OpenShift CLI to see the DaemonSet pod count.
    $ oc get ds -n twistlock
    NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE twistlock-defender-ds 4 3 3 3 3 <none> 29m
    The desired and current pod counts do not match. This is a job for the nodeSelector.

Control Defender deployments with taint

You can deploy Defenders to all nodes in an OpenShift cluster (master, infra, compute). OpenShift Container Platform automatically taints infra and master nodes These taints have the NoSchedule effect, which means no pod can be scheduled on them.
To run the Defenders on these nodes, you can either remove the taint or add a toleration to the Defender DaemonSet. Once this is done, the Defender Daemonset will automatically be deployed to these nodes (no need to redeploy the Daemonset). Adjust the guidance in the following procedure according to your organization’s deployment strategy.
  • Option 1 - remove taint all nodes:
    $ oc adm taint nodes --all node-role.kubernetes.io/master-
  • Option 2 - remove taint from specific nodes:
    $ oc adm taint nodes <node-name> node-role.kubernetes.io/master-
  • Option 3 - add tolerations to the twistlock-defender-ds DaemonSet:
    $ oc edit ds twistlock-defender-ds -n twistlock
    Add the following toleration in PodSpec (DaemonSet.spec.template.spec)
    tolerations: - key: "node-role.kubernetes.io/master" operator: "Exists" effect: "NoSchedule"

Uninstall

To uninstall Prisma Cloud, delete the twistlock project.
  1. Delete the twistlock Project
    $ oc delete project twistlock

Recommended For You