Chapter 3. Installing the proxy operator

Procedure

1. Edit the Streams for Apache Kafka Proxy installation files to use the namespace the operator is going to be installed into.

   For example, in this procedure the operator is installed into the namespace my-kroxylicious-operator-namespace.

   On Linux, use:

   sed -i 's/namespace: .*/namespace: my-kroxylicious-operator-namespace/' install/*.yaml

   On MacOS, use:

   sed -i '' 's/namespace: .*/namespace: my-kroxylicious-operator-namespace/' install/*.yaml

2. Deploy the Streams for Apache Kafka Proxy operator:

   oc create -f install

3. Check the status of the deployment:

   oc get deployments -n my-kroxylicious-operator-namespace

   Output shows the deployment name and readiness

   NAME                      READY  UP-TO-DATE  AVAILABLE
   kroxylicious-operator     1/1    1           1

   READY shows the number of replicas that are ready/expected. The deployment is successful when the AVAILABLE output shows 1.

Procedure

1. Navigate in the OpenShift web console to the Home > Projects page and create a project (namespace) for the installation.

   We use a project named streams-kafka-proxy in this example.

2. Navigate to the Operators > OperatorHub page.

3. Scroll or type a keyword into the Filter by keyword box to find the Streams for Apache Kafka Proxy operator.

   The operator is located in the Other category.

4. Click Streams for Apache Kafka Proxy to display the operator information.
5. Read the information about the operator and click Install.

6. On the Install Operator page, choose from the following installation and update options:

   • Update Channel: Choose the update channel for the operator.

     • The (default) alpha channel contains all the latest updates and releases, including major, minor, and micro releases, which are assumed to be well tested and stable.
     • An amq-streams-X.x channel contains the minor and micro release updates for a major release, where X is the major release version number.
     • An amq-streams-X.Y.x channel contains the micro release updates for a minor release, where X is the major release version number and Y is the minor release version number.

   • Installation Mode: Install the operator to all namespaces in the OpenShift cluster.

     A single instance of the operator will watch and manage proxies created throughout the OpenShift cluster.

   • Update approval: By default, the Streams for Apache Kafka Proxy operator is automatically upgraded to the latest proxy version by the Operator Lifecycle Manager (OLM). Optionally, select Manual if you want to manually approve future upgrades. For more information on operators, see the OpenShift documentation.
7. Click Install to install the operator to your selected namespace.

8. After the operator is ready for use, navigate to Operators > Installed Operators to verify that the operator has installed to the selected namespace.

   The status will show as Succeeded.

9. Use the proxy operator to deploy a proxy.