You can modify the configuration settings for your existing Event Streams installation by using the OpenShift Container Platform web console or the Kubernetes command-line tool (kubectl
). The configuration changes are applied by updating the EventStreams
custom resource.
You can modify existing values and introduce new properties as outlined under configuration settings.
Note: Some settings might cause affected components of your Event Streams instance to restart.
For examples of changes you might want to make for performance reasons, see scaling your Event Streams instance.
Using the OpenShift Container Platform web console
To modify configuration settings by using 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.
- Click the YAML tab to edit the custom resource.
- Make the required changes on the page, or you can click Download and make the required changes in a text editor. If you clicked Download you will need to drag and drop the modified custom resource file onto the page so that it updates in the web console.
- Click the Save button to apply your changes.
Using the Kubernetes command-line tool (kubectl
)
To modify configuration settings by using the Kubernetes command-line tool (kubectl
):
- Log in to your Kubernetes cluster as a cluster administrator by setting your
kubectl
context. -
Run the following command to edit your
EventStreams
custom resource in your default editor:kubectl edit eventstreams <instance_name>
- Make the required changes in your editor.
- Save and quit the editor to apply your changes.
Modifying Kafka broker configuration settings
Kafka supports a number of key/value pair settings for broker configuration, typically provided in a properties file.
In Event Streams, these settings are defined in an EventStreams
custom resource under the spec.strimziOverrides.kafka.config
property.
For example, to set the number of I/O threads to 24
you can add the spec.strimziOverrides.kafka.config["num.io.threads"]
property:
apiVersion: eventstreams.ibm.com/v1beta2
kind: EventStreams
metadata:
name: example-broker-config
namespace: myproject
spec:
# ...
strimziOverrides:
kafka:
# ...
config:
# ...
num.io.threads: 24
You can specify all the broker configuration options supported by Kafka except those managed directly by Event Streams. For further information, see the list of supported configuration options.