Starting KSML Applications
Creating KSML Applications
-
Open the "Applications" page in the Self-Service portal
-
Click the New Application button. This window will open
-
Fill the required information in the form:
-
Owner: All members of the selected group will be authorized to edit this KSML Application.
-
Visibility: Controls read access. Public applications are readable to the entire organisation.
Private applications are only visible to its owners. -
Description: A short summary describing the purpose of this application.
-
Click the Add Application button in the bottom-right of the screen.
Upon creating the KSML Application in the Self-Service portal, you will be directed to the application detail page.
Here you can "instantiate" this KSML Application onto multiple environments.
Configuring and starting KSML Applications
A KSML Application needs 2 sets of configuration for every environment in which it’s deployed:
-
Definition: The KSML YAML definition.
-
Security: The means to authenticate and authorize the Application against the Kafka cluster. Can be either user provided certificate and private key PEM files or generated SASL credentials depending on the Instance Cluster Configuration.
|
|
Definition
-
Click on the Gear button in the application box (hovering on the button will show the text 'Configuration'). A window similar to this will show up:
Here you will provide the KSML Application Definition either by typing into the modal or by dragging and dropping an existing YAML file. Click Save when done.
Security configuration
|
Use the authentication method that matches your Kafka Cluster configuration. |
Using mTLS
The certificate and private key are used to authorize the KSML-Application against kafka when accessing the topics. At least one certificate and private key must be configured for every environment this application intends to use.
-
The certificate must be
X.509formatted and contained within aPEMfile. Ideally, it should contain the whole certification chain. -
The private key must be
pkcs8formatted and contained within aPEMfile.
| If your key material is currently in JKS format, you can extract the certificate and private key using a tool such as Keystore Explorer. |
Considering you have both these files available, let’s configure the KSML Application’s security:
-
From the environment dropdown, select the environment for which you want to configure the certificate and private key.
-
Click on the Padlock button in the application box (hovering on the button will show the text 'Authorization'). The following window will show up:
-
Upload the Certificate file your Application will use in this environment.
The window will indicate the certificate was successfully uploaded, and request you follow-up with a private key. -
Upload the private-key file that matches the certificate.
The private key will not be displayed on the screen. You will only see whether it was successfully uploaded or not. The window will indicate the private key was successfully uploaded
-
Click Apply
Using SASL
-
From the environment dropdown, select the environment for which you want to configure sasl authentication.
-
Click on the Padlock button in the application box (hovering on the button will show the text 'Authorization'). The following window will show up:
-
Click the Generate Pair button in the SASL section
-
Credentials will be generated and will appear above the button. Only the username is shown
Requesting Topic Access
Your KSML Application needs to be authorised to produce/consume a kafka topic before it can be started.
Follow the docs to grant it access.
Application Lifecycle
Start
You can start the KSML Application by clicking the 'START' button. Within seconds, the status should change to 'RUNNING'. The result is a pod initializing with the KSML definition you have provided.
If the status changed to FAILED, you can observe the Application through the logging (see below).
Viewing KSML Logging
As soon as you have started your KSML application, you can consult the KSML Application logs to get a deeper insight into the status of the application beyond the status indicator.
On the KSML Application card, click on the "Logs" button. The following screen shows.
Log contents can be refreshed or downloaded
by hitting the top right Refresh Logs icon or the bottom right Download button respectively.
Stop
Stopping the application can be done by clicking the button on the Application card resulting in the started pod being undeployed.
Deleting A KSML Application
Follow the docs to remove the application.
| Deleting the KSML Application results in all KSML deployments being stopped on all environments |