You are viewing the documentation for the container-native version of IBM Event Streams.
Looking for the managed service on IBM Cloud? Click here.

Trying out Event Streams

To try out Event Streams, you can install a basic deployment of the Community Edition.

IBM Event Streams Community Edition is a free version intended for trial and demonstration purposes. It can be installed and used without charge.

Note: These instructions do not include setting up persistent storage, so your data and configuration settings are not retained in the event of a restart.

For more features and full IBM support, install IBM Event Streams.

On IBM Cloud Private

IBM Event Streams Community Edition is included in the IBM Cloud Private catalog.

  1. If you do not have IBM Cloud Private installed already, you can download and install IBM Cloud Private-CE.
  2. Log in to your IBM Cloud Private cluster management console as an administrator. For more information, see the IBM Cloud Private documentation.
  3. Create a namespace where you will install your Event Streams instance:
    1. From the navigation menu, click Manage > Namespaces.
    2. Click Create Namespace.
    3. Enter a name for your namespace.
    4. Ensure you have the ibm-restricted-psp PodSecurityPolicy selected for the target namespace.
    5. Click Create.
  4. Click Catalog in the top navigation menu.
  5. Search for ibm-eventstreams-dev and select it from the result. This is the Helm chart for the IBM Event Streams Community Edition. The README is displayed.
  6. Click Configure.
  7. Enter a release name that identifies your Event Streams installation, select the target namespace you created previously, select a target cluster (for example, local-cluster), and accept the terms of the license agreement.
    You can leave all other settings at their default values.
  8. Click Install.
  9. Verify your installation and log in to start using Event Streams.

These steps install a basic instance of IBM Event Streams Community Edition that you can try out. You can also configure your installation to change the default settings as required, for example, to set up persistent storage.

Note: Geo-replication is only available in the paid-for version of IBM Event Streams (not available in the Community Edition).

On OpenShift Container Platform

If you are using OpenShift Container Platform, you can set up an integration with IBM Cloud Private, and install the IBM Event Streams Community Edition included in the catalog.

  1. Ensure you have the right version of OpenShift installed and integrated with the right version of IBM Cloud Private. For supported versions, see the support table.

    For example, install OpenShift 3.11, and integrate it with IBM Cloud Private 3.2.1.

  2. Create a project in OpenShift. This will also create a namespace with the same name in IBM Cloud Private. You then use this namespace to install your Event Streams instance. For example, to create a project by using the web console:
    1. Log in to the OpenShift Container Platform web console by using the user name and password provided to you by your administrator.
    2. Click the Create project button, and type a unique name, display name, and description for the new project. This creates a project and a namespace.
  3. Download and run the setup script as follows:
    Important: You must perform the following steps by using a terminal opened on the host where the IBM Cloud Private master cluster is installed. If you are on a different host, you must first connect to the host machine by using SSH before logging in.
    1. Log in to your cluster as an administrator by using the IBM Cloud Private CLI:
      cloudctl login -a https://<cluster_address>:<cluster_router_https_port>
    2. Download the files from GitHub.
    3. Change to the location where you downloaded the files, and run the setup script as follows:
      ./scc.sh <namespace>
      Where <namespace> is the namespace (project) you created for your Event Streams installation earlier.
  4. Log in to your IBM Cloud Private cluster management console as an administrator. For more information, see the IBM Cloud Private documentation.
  5. Click Catalog in the top navigation menu.
  6. Search for ibm-eventstreams-dev and select it from the result. This is the Helm chart for the IBM Event Streams Community Edition. The README is displayed.
  7. Click Configure.
  8. Enter a release name that identifies your Event Streams installation, select the target namespace you created previously, select a target cluster (for example, local-cluster), and accept the terms of the license agreement. You can leave all other settings at their default values.

  9. Click Install.
  10. Verify your installation and log in to start using Event Streams.

These steps install a basic instance of IBM Event Streams Community Edition that you can try out. You can also configure your installation to change the default settings as required, for example, to set up persistent storage.

Note: Geo-replication is only available in the paid-for version of IBM Event Streams (not available in the Community Edition).