API Reference
Resources Types
KasprApp
A program that runs components of a distributed stream processing application.
| Field | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | kaspr.io/v1alpha1 | Yes |
| kind | string | KasprApp | Yes |
| metadata | ObjectMeta | Metadata that all persisted resources must have. | Yes |
KasprAppSpec
Specification of the desired settings of the application.
| Field | Type | Description | Required |
|---|---|---|---|
| version | string | The kaspr version. Defaults to the latest. | No |
| replicas | integer | The number of desired instances. Defaults to 1. | No |
| image | string | The container image to use. Defaults to the corresponding image of the version configuration. | No |
| bootstrapServers | string | Bootstrap server names to connect to. This should be given as a comma separated list of <hostname>:<port> pairs. | Yes |
| tls | TLS | TLS configuration. Provide an empty entry | No |
| authentication | KafkaAuthentication | Authentication configuration for Kafka. | No |
| resources | ResourceRequirements | Compute Resources required by each instance on the application. | No |
| storage | StorageRequirements | Disk storage required by each instance of the application. | Yes |
KafkaAuthentication
Kafka authentication configuration.
| Field | Type | Description | Required |
|---|---|---|---|
| type | string | The type of authentication to use. Must be one of | No |
| username | string | Username used for authentication. | No |
| passwordSecret | PasswordSecret | Details of the kubernetes secret where the authentication password is stored. | No |
PasswordSecret
Kubernetes secret.
| Field | Type | Description | Required |
|---|---|---|---|
| secretName | string | The name of the Kubernetes secret resource containting the password. | Yes |
| passwordKey | string | The name of the key in the Secret under which the password is stored. | Yes |
StorageRequirements
Disk storage configuration (disk).
| Field | Type | Description | Required |
|---|---|---|---|
| type | string | Storage type, must be | Yes |
| class | string | The storage class to use for dynamic volume allocation. | Yes |
| deleteClaim | boolean | Specifies if the persistent volume claim has to be deleted when the app is undeployed. | No |