11.5 Change Version

Post-installation tasks

Consider the following tasks after installing Event Streams.

Verifying an installation

To verify that your Event Streams installation deployed successfully, you can check the status of your instance through the OpenShift Container Platform web console or command line.

Check the status of the EventStreams instance through the OpenShift Container Platform web console

Log in to the OpenShift Container Platform web console using your login credentials.
Expand the Operators dropdown and select Installed Operators to open the Installed Operators page.
Expand the Project dropdown and select the project the instance is installed in. Click the operator called IBM Event Streams managing the project.
Select the Event Streams tab and search the Name column for the installed instance and click it.
The Phase field will display the current state of the EventStreams custom resource. When the Event Streams instance is ready, the phase will display Ready, meaning the deployment has completed.

Check the status of the Event Streams instance through the command line

After all the components of an Event Streams instance are active and ready, the EventStreams custom resource will have a Ready phase in the status. To verify the status:

Log in to your Kubernetes cluster as a cluster administrator by setting your kubectl context.
Run the kubectl get command as follows:
```
kubectl get eventstreams
```

For example, the installation of the instance called development is complete when the STATUS returned by the kubectl get command displays Ready.

An example output:

$ kubectl get eventstreams
>
NAME             STATUS
development      Ready

Note: It might take several minutes for all the resources to be created and the EventStreams instance to become ready.

Installing the Event Streams command-line interface

The Event Streams CLI is a plugin for the kubectl and cloudctl CLI. Use the Event Streams CLI to manage your Event Streams instance from the command line.

Note: For completing tasks by using the Event Streams CLI, you can use cloudctl es commands if your deployment is on the OpenShift Container Platform with foundational services. This documentation set includes instructions that use the kubectl command, except for cases where the task is specific to OpenShift with foundational services.

Examples of management activities include:

Creating, deleting, and updating Kafka topics.
Creating, deleting, and updating Kafka users.
Creating, deleting, and updating Kafka message schemas.
Managing geo-replication.
Displaying the cluster configuration and credentials.

Note: The Event Streams CLI kafka-user commands can be run only when the Event Streams CLI has access to Kubernetes resources, which can be provided by IAM authentication. If your Event Streams instance uses SCRAM-SHA-512 authentication, you can create a Kafka User by using the OpenShift web console or the Kubernetes CLI. You can also use the Event Streams UI to generate the Kafka users.

Kubernetes plugin (`kubectl es`)

For OpenShift and other Kubernetes platforms running without foundational services, install the Event Streams CLI with the Kubernetes command-line tool (kubectl) as follows:

Ensure you have the Kubernetes command-line tool (kubectl) installed.
Log in to your Event Streams instance as an administrator.
Click Toolbox in the primary navigation.
Go to the Event Streams command-line interface section and click Find out more.
Download the Event Streams CLI plug-in for your system by using the appropriate link.
Rename the plugin file to kubectl-es and move it into a directory on the user’s PATH. For example, on Linux and MacOS, move and rename the plugin file by running the following command:
```
sudo mv ./kubectl-es-plugin.bin /usr/local/bin/kubectl-es
```

For more information about kubectl plugins, see the Kubernetes documentation.

To start the Event Streams CLI and check all available command options in the CLI, use the kubectl es command. For an exhaustive list of commands, you can run:

kubectl es --help

To get help for a specific command, run:

kubectl es <command> --help

To run commands after installing, log in and initialize the CLI as described in logging in.

IBM Cloud Pak CLI plugin (`cloudctl es`)

For OpenShift Container Platform with IBM Cloud Pak foundational services, install the Event Streams CLI with the IBM Cloud Pak CLI (cloudctl) as follows:

Ensure you have the IBM Cloud Pak CLI (cloudctl) installed either by retrieving the binary from your cluster or downloading the binary from a release on the GitHub project.

Note: Ensure you download the correct binary for your architecture and operating system.
Log in to your Event Streams instance as an administrator.
Click Toolbox in the primary navigation.
Go to the Event Streams command-line interface section and click Find out more.
Download the Event Streams CLI plug-in for your system by using the appropriate link.
Install the plugin using the following command:
```
cloudctl plugin install <path-to-plugin>
```

To start the Event Streams CLI and check all available command options in the CLI, use the cloudctl es command. For an exhaustive list of commands, you can run:

cloudctl es --help

To get help for a specific command, run:

cloudctl es <command> --help

Firewall and load balancer settings

In your firewall settings, ensure you enable communication for the endpoints that Event Streams services use.

If you have load balancing set up to manage traffic for your cluster, ensure that it is set up to handle the Event Streams endpoints.

On the OpenShift Container Platform, Event Streams uses routes. If you are using OpenShift, ensure your router is set up as required.

On other Kubernetes platforms, Event Streams uses ingress for external access. You can configure ingress to provide load balancing through an ingress controller. Ensure your ingress is set up as required for your Kubernetes platform.

Connecting clients

For instructions about connecting a client to your Event Streams instance, see connecting clients.

Setting up access

Secure your installation by managing the access your users and applications have to your Event Streams resources.

For example, if you are using IBM Cloud Pak foundational services, associate your foundational services teams with your Event Streams instance to grant access to resources based on roles.

Scaling your Kafka Environment

Depending on the size of the environment that you are installing, consider scaling and sizing options. You might also need to change scale and size settings for your services over time. For example, you might need to add additional Kafka brokers over time.

See how to scale your Kafka environment.

Consider the requirements for GDPR, including encrypting your data for protecting it from loss or unauthorized access.

Enable metrics for monitoring

To display metrics in the monitoring dashboards of the Event Streams UI, ensure that you enable the Monitoring dashboard by following the instructions in the post-upgrade tasks before accessing the dashboard.