Setup

Prerequisite CLI tools

The following CLI tools are required for running the exercises in this tutorial. Please have them installed and configured before you get started with any of the tutorial chapters.

Tool macOS Fedora windows

Tool	macOS	Fedora	windows
`Git`	Download	Download	Download
`Docker`	Docker for Mac	`dnf install docker`	Docker for Windows
`VirtualBox`	Download	Download	Download
Minikube v1.29.0	Download	Download	Download
`kubectl v1.26.1`	Download	Download	Download
`Apache Maven 3.9.0`	Download	Download	Download
`Operator SDK CLI`	Download	Download	Download

Git

Docker

dnf install docker

VirtualBox

Minikube v1.29.0

kubectl v1.26.1

Apache Maven 3.9.0

Operator SDK CLI

The following CLI tools are optional for running the exercises in this tutorial. Although they are used in the tutorial, you could use others without any problem.

Tool macOS Fedora windows

Tool	macOS	Fedora	windows
yq v2.4.1	Download	Download	Download
jq v1.6.0	Download	Download	Download
httpie	`brew install httpie`	`dnf install httpie`	https://httpie.org/doc#windows-etc
watch	`brew install watch`	`dnf install procps-ng`
kubectx and kubens	`brew install kubectx`	https://github.com/ahmetb/kubectx
hey	`brew install hey`	Download	Download

brew install httpie

dnf install httpie

https://httpie.org/doc#windows-etc

watch

brew install watch

dnf install procps-ng

kubectx and kubens

brew install kubectx

https://github.com/ahmetb/kubectx

hey

brew install hey

Download

Setup Kubernetes

The profile operators is created to run the tutorial:

Minikube
OpenShift

Having minikube installed and in your PATH, then run:

MacOS

minikube start --memory=8192 --cpus=3 --kubernetes-version=v1.26.1 --vm-driver=virtualbox -p operators

Linux

minikube start --memory=8192 --cpus=3 --kubernetes-version=v1.26.1 --vm-driver=kvm2 -p operators

Windows:

minikube start --memory=8192 --cpus=3 --kubernetes-version=v1.26.1 --vm-driver=hyperv -p operators

And the output must be something similar like:

😄  [operators] minikube v1.20.0 on Darwin 11.3
✅  Created a new profile : operators
✅  minikube profile was successfully set to operators
😄  [default] minikube v1.29.0 on Darwin 11.3
✨  Selecting 'virtualbox' driver from user configuration (alternates: [hyperkit])
🔥  Creating virtualbox VM (CPUs=2, Memory=8192MB, Disk=50000MB) ...
🐳  Preparing Kubernetes v1.26.1 on Docker '20.10.6' ...
    ▪ apiserver.enable-admission-plugins=LimitRanger,NamespaceExists,NamespaceLifecycle,ResourceQuota,ServiceAccount,DefaultStorageClass,MutatingAdmissionWebhook
🚜  Pulling images ...
🚀  Launching Kubernetes ...
⌛  Waiting for cluster to come online ...
🏄  Done! kubectl is now configured to use "operators"

Finally configure to use minikube internal docker as docker host:

eval $(minikube docker-env -p operators)

To run OpenShift4, you need to have one provisioned using try.openshift.com or can use any existing OpenShift4 cluster. Once you have your cluster, you can download the latest OpenShift client(oc) from here and add to your path.

oc version

You can check the OpenShift version using:

oc version

The output should show oc version >=4.7:

Client Version: 4.7.0-202102130115.p0-c66c03f
Kubernetes Version: v1.26.1

Then login into the OpenShift cluster using oc login

Get tutorial sources

Before we start setting up the environment, let’s clone the tutorial sources and set the TUTORIAL_HOME environment variable to point to the root directory of the tutorial:

git clone https://github.com/redhat-scholars/operators-sdk-tutorial operators-sdk-tutorial

export TUTORIAL_HOME="$(pwd)/operators-sdk-tutorial"

cd $TUTORIAL_HOME