Redpanda Topic CRD Reference
Custom resource definitions for the Topic resource. Use the Topic resource to create and manage topics with the Redpanda Operator.
cluster.redpanda.com/v1alpha1
Package v1alpha1 contains API Schema definitions for the cluster.redpanda.com v1alpha1 API group
ConfigSynonyms
ConfigSynonyms was copied from https://github.com/twmb/franz-go/blob/01651affd204d4a3577a341e748c5d09b52587f8/pkg/kmsg/generated.go#L24569-L24578
Field | Description |
---|---|
|
|
|
|
|
|
|
UnknownTags are tags Kafka sent that we do not know the purpose of. |
Configuration
Configuration was copied from https://github.com/twmb/franz-go/blob/01651affd204d4a3577a341e748c5d09b52587f8/pkg/kmsg/generated.go#L24593-L24634
Field | Description |
---|---|
|
Name is a key this entry corresponds to (e.g. segment.bytes). |
|
Value is the value for this config key. If the key is sensitive, the value will be null. |
|
ReadOnly signifies whether this is not a dynamic config option. Note that this field is not always correct, and you may need to check whether the Source is any dynamic enum. See franz-go#91 for more details. |
|
IsDefault is whether this is a default config option. This has been replaced in favor of Source. |
|
Source is where this config entry is from. This field has a default of -1. |
|
IsSensitive signifies whether this is a sensitive config key, which is either a password or an unknown type. |
|
ConfigSynonyms contains fallback key/value pairs for this config entry, in order of preference. That is, if a config entry is both dynamically configured and has a default, the top level return will be the dynamic configuration, while its "synonym" will be the default. |
|
ConfigType specifies the configuration data type. |
|
Documentation is optional documentation for the config entry. |
|
UnknownTags are tags Kafka sent that we do not know the purpose of. |
KafkaAPISpec
KafkaAPISpec configures client configuration settings for connecting to Redpanda brokers.
Field | Description |
---|---|
|
Specifies a list of broker addresses in the format <host>:<port> |
|
Defines TLS configuration settings for Redpanda clusters that have TLS enabled. |
|
Defines authentication configuration settings for Redpanda clusters that have authentication enabled. |
KafkaSASL
KafkaSASL configures credentials to connect to Redpanda cluster that has authentication enabled.
Field | Description |
---|---|
|
Specifies the username. |
|
Specifies the password. |
|
Specifies the SASL/SCRAM authentication mechanism. |
|
|
|
|
|
KafkaSASLAWSMskIam
KafkaSASLAWSMskIam is the config for AWS IAM SASL mechanism, see: https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html
Field | Description |
---|---|
|
|
|
|
|
SessionToken, if non-empty, is a session / security token to use for authentication. See: https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html |
|
UserAgent is the user agent to for the client to use when connecting to Kafka, overriding the default "franz-go/<runtime.Version()>/<hostname>". Setting a UserAgent allows authorizing based on the aws:UserAgent condition key; see the following link for more details: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-useragent |
KafkaSASLGSSAPI
KafkaSASLGSSAPI represents the Kafka Kerberos config.
Field | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
EnableFAST enables FAST, which is a pre-authentication framework for Kerberos. It includes a mechanism for tunneling pre-authentication exchanges using armored KDC messages. FAST provides increased resistance to passive password guessing attacks. |
KafkaSASLOAuthBearer
KafkaSASLOAuthBearer is the config struct for the SASL OAuthBearer mechanism
Field | Description |
---|---|
|
KafkaTLS
KafkaTLS specifies TLS configuration settings for Redpanda clusters that have authentication enabled.
Field | Description |
---|---|
|
CaCert is the reference for certificate authority used to establish TLS connection to Redpanda |
|
Cert is the reference for client public certificate to establish mTLS connection to Redpanda |
|
Key is the reference for client private certificate to establish mTLS connection to Redpanda |
|
InsecureSkipTLSVerify can skip verifying Redpanda self-signed certificate when establish TLS connection to Redpanda |
SecretKeyRef
SecretKeyRef contains enough information to inspect or modify the referred Secret data See https://pkg.go.dev/k8s.io/api/core/v1#ObjectReference.
Field | Description |
---|---|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
Key in Secret data to get value from |
Topic
Topic defines the CRD for Topic resources. See https://docs.redpanda.com/current/manage/kubernetes/manage-topics/.
Field | Description |
---|---|
|
|
|
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
Refer to the Kubernetes API documentation for fields of |
|
Defines the desired state of the Topic resource. |
|
Represents the current status of the Topic resource. |
TopicList
TopicList contains a list of Topic objects.
Field | Description |
---|---|
|
|
|
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
Refer to the Kubernetes API documentation for fields of |
|
Specifies a list of Topic resources. |
TopicSpec
TopicSpec defines the desired state of the topic. See https://docs.redpanda.com/current/manage/kubernetes/manage-topics/.
For descriptions and default values of topic properties, see Topic Configuration Properties.
Field | Description |
---|---|
|
Specifies the number of topic shards that are distributed across the brokers in a cluster. This number cannot be decreased after topic creation. It can be increased after topic creation, but it is important to understand the consequences that has, especially for topics with semantic partitioning. When absent this will default to the Redpanda cluster configuration |
|
Specifies the number of replicas the topic should have. Must be odd value. When absent this will default to the Redpanda cluster configuration |
|
Changes the topic name from the value of |
|
Adds extra topic configurations. This is a free-form map of any configuration options that topics can have. Examples: |
|
Defines client configuration for connecting to Redpanda brokers. |
|
Overwrites the fully-qualified name of the metric. This should be easier to identify if multiple operator instances runs inside the same Kubernetes cluster. By default, it is set to |
|
Defines when the topic controller will schedule the next reconciliation. Default is 3 seconds. |
TopicStatus
TopicStatus defines the observed state of the Topic resource.
Field | Description |
---|---|
|
ObservedGeneration is the last observed generation of the Topic. |
|
Conditions holds the conditions for the Topic. |
|
TopicConfiguration is the last snapshot of the topic configuration during successful reconciliation. |