v1alpha1

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 26, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the banzaicloud v1alpha1 API group +kubebuilder:object:generate=true +groupName=kafka.banzaicloud.io

Index

Constants

View Source 
const (
	// KafkaAccessTypeRead states that a user wants consume access to a topic
	KafkaAccessTypeRead KafkaAccessType = "read"
	// KafkaAccessTypeWrite states that a user wants produce access to a topic
	KafkaAccessTypeWrite KafkaAccessType = "write"
	// Resource pattern types. More info: https://kafka.apache.org/20/javadoc/org/apache/kafka/common/resource/PatternType.html
	KafkaPatternTypeAny      KafkaPatternType = "any"
	KafkaPatternTypeLiteral  KafkaPatternType = "literal"
	KafkaPatternTypeMatch    KafkaPatternType = "match"
	KafkaPatternTypePrefixed KafkaPatternType = "prefixed"
	KafkaPatternTypeDefault  KafkaPatternType = "literal"
	// TopicStateCreated describes the status of a KafkaTopic as created
	TopicStateCreated TopicState = "created"
	// UserStateCreated describes the status of a KafkaUser as created
	UserStateCreated UserState = "created"
	// TLSJKSKeyStore is where a JKS keystore is stored in a user secret when requested
	TLSJKSKeyStore string = "keystore.jks"
	// TLSJKSTrustStore is where a JKS truststore is stored in a user secret when requested
	TLSJKSTrustStore string = "truststore.jks"
	// CoreCACertKey is where ca ceritificates are stored in user certificates
	CoreCACertKey string = "ca.crt"
	// CACertKey is the key where the CA certificate is stored in the operator secrets
	CACertKey string = "caCert"
	// CAPrivateKeyKey stores the private key for the CA
	CAPrivateKeyKey string = "caKey"
	// ClientCertKey stores the client certificate (cruisecontrol/operator usage)
	ClientCertKey string = "clientCert"
	// ClientPrivateKeyKey stores the client private key
	ClientPrivateKeyKey string = "clientKey"
	// PeerCertKey stores the peer certificate (broker certificates)
	PeerCertKey string = "peerCert"
	// PeerPrivateKeyKey stores the peer private key
	PeerPrivateKeyKey string = "peerKey"
	// PasswordKey stores the JKS password
	PasswordKey string = "password"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "kafka.banzaicloud.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type ClusterReference 

type ClusterReference struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace,omitempty"`
}

ClusterReference states a reference to a cluster for topic/user provisioning

func (*ClusterReference) DeepCopy 

func (in *ClusterReference) DeepCopy() *ClusterReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterReference.

func (*ClusterReference) DeepCopyInto 

func (in *ClusterReference) DeepCopyInto(out *ClusterReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KafkaAccessType 

type KafkaAccessType string

KafkaAccessType hold info about Kafka ACL

type KafkaPatternType 

type KafkaPatternType string

KafkaPatternType hold the Resource Pattern Type of kafka ACL

type KafkaTopic 

type KafkaTopic struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   KafkaTopicSpec   `json:"spec,omitempty"`
	Status KafkaTopicStatus `json:"status,omitempty"`
}

KafkaTopic is the Schema for the kafkatopics API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*KafkaTopic) DeepCopy 

func (in *KafkaTopic) DeepCopy() *KafkaTopic

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaTopic.

func (*KafkaTopic) DeepCopyInto 

func (in *KafkaTopic) DeepCopyInto(out *KafkaTopic)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KafkaTopic) DeepCopyObject 

func (in *KafkaTopic) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type KafkaTopicList 

type KafkaTopicList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []KafkaTopic `json:"items"`
}

KafkaTopicList contains a list of KafkaTopic

func (*KafkaTopicList) DeepCopy 

func (in *KafkaTopicList) DeepCopy() *KafkaTopicList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaTopicList.

func (*KafkaTopicList) DeepCopyInto 

func (in *KafkaTopicList) DeepCopyInto(out *KafkaTopicList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KafkaTopicList) DeepCopyObject 

func (in *KafkaTopicList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type KafkaTopicSpec 

type KafkaTopicSpec struct {
	Name              string            `json:"name"`
	Partitions        int32             `json:"partitions"`
	ReplicationFactor int32             `json:"replicationFactor"`
	Config            map[string]string `json:"config,omitempty"`
	ClusterRef        ClusterReference  `json:"clusterRef"`
}

KafkaTopicSpec defines the desired state of KafkaTopic +k8s:openapi-gen=true

func (*KafkaTopicSpec) DeepCopy 

func (in *KafkaTopicSpec) DeepCopy() *KafkaTopicSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaTopicSpec.

func (*KafkaTopicSpec) DeepCopyInto 

func (in *KafkaTopicSpec) DeepCopyInto(out *KafkaTopicSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KafkaTopicStatus 

type KafkaTopicStatus struct {
	State TopicState `json:"state"`
}

KafkaTopicStatus defines the observed state of KafkaTopic +k8s:openapi-gen=true

func (*KafkaTopicStatus) DeepCopy 

func (in *KafkaTopicStatus) DeepCopy() *KafkaTopicStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaTopicStatus.

func (*KafkaTopicStatus) DeepCopyInto 

func (in *KafkaTopicStatus) DeepCopyInto(out *KafkaTopicStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KafkaUser 

type KafkaUser struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   KafkaUserSpec   `json:"spec,omitempty"`
	Status KafkaUserStatus `json:"status,omitempty"`
}

KafkaUser is the Schema for the kafka users API +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*KafkaUser) DeepCopy 

func (in *KafkaUser) DeepCopy() *KafkaUser

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaUser.

func (*KafkaUser) DeepCopyInto 

func (in *KafkaUser) DeepCopyInto(out *KafkaUser)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KafkaUser) DeepCopyObject 

func (in *KafkaUser) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type KafkaUserList 

type KafkaUserList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []KafkaUser `json:"items"`
}

KafkaUserList contains a list of KafkaUser

func (*KafkaUserList) DeepCopy 

func (in *KafkaUserList) DeepCopy() *KafkaUserList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaUserList.

func (*KafkaUserList) DeepCopyInto 

func (in *KafkaUserList) DeepCopyInto(out *KafkaUserList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KafkaUserList) DeepCopyObject 

func (in *KafkaUserList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type KafkaUserSpec 

type KafkaUserSpec struct {
	SecretName string           `json:"secretName"`
	ClusterRef ClusterReference `json:"clusterRef"`
	// Annotations defines the annotations placed on the certificate or certificate signing request object
	Annotations    map[string]string `json:"annotations,omitempty"`
	DNSNames       []string          `json:"dnsNames,omitempty"`
	TopicGrants    []UserTopicGrant  `json:"topicGrants,omitempty"`
	IncludeJKS     bool              `json:"includeJKS,omitempty"`
	CreateCert     *bool             `json:"createCert,omitempty"`
	PKIBackendSpec *PKIBackendSpec   `json:"pkiBackendSpec,omitempty"`
}

KafkaUserSpec defines the desired state of KafkaUser +k8s:openapi-gen=true

func (*KafkaUserSpec) DeepCopy 

func (in *KafkaUserSpec) DeepCopy() *KafkaUserSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaUserSpec.

func (*KafkaUserSpec) DeepCopyInto 

func (in *KafkaUserSpec) DeepCopyInto(out *KafkaUserSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KafkaUserSpec) GetAnnotations 

func (spec *KafkaUserSpec) GetAnnotations() map[string]string

GetAnnotations returns Annotations to use for certificate or certificate signing request object

func (*KafkaUserSpec) GetIfCertShouldBeCreated 

func (spec *KafkaUserSpec) GetIfCertShouldBeCreated() bool

type KafkaUserStatus 

type KafkaUserStatus struct {
	State UserState `json:"state"`
	ACLs  []string  `json:"acls,omitempty"`
}

KafkaUserStatus defines the observed state of KafkaUser +k8s:openapi-gen=true

func (*KafkaUserStatus) DeepCopy 

func (in *KafkaUserStatus) DeepCopy() *KafkaUserStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KafkaUserStatus.

func (*KafkaUserStatus) DeepCopyInto 

func (in *KafkaUserStatus) DeepCopyInto(out *KafkaUserStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PKIBackendSpec 

type PKIBackendSpec struct {
	IssuerRef *cmmeta.ObjectReference `json:"issuerRef,omitempty"`
	// +kubebuilder:validation:Enum={"cert-manager","vault","k8s-csr"}
	PKIBackend string `json:"pkiBackend"`
	// SignerName indicates requested signer, and is a qualified name.
	SignerName string `json:"signerName,omitempty"`
}

func (*PKIBackendSpec) DeepCopy 

func (in *PKIBackendSpec) DeepCopy() *PKIBackendSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PKIBackendSpec.

func (*PKIBackendSpec) DeepCopyInto 

func (in *PKIBackendSpec) DeepCopyInto(out *PKIBackendSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TopicState 

type TopicState string

TopicState defines the state of a KafkaTopic

type UserState 

type UserState string

UserState defines the state of a KafkaUser

type UserTopicGrant 

type UserTopicGrant struct {
	TopicName string `json:"topicName"`
	// +kubebuilder:validation:Enum={"read","write"}
	AccessType KafkaAccessType `json:"accessType"`
	// +kubebuilder:validation:Enum={"literal","match","prefixed","any"}
	PatternType KafkaPatternType `json:"patternType,omitempty"`
}

UserTopicGrant is the desired permissions for the KafkaUser

func (*UserTopicGrant) DeepCopy 

func (in *UserTopicGrant) DeepCopy() *UserTopicGrant

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserTopicGrant.

func (*UserTopicGrant) DeepCopyInto 

func (in *UserTopicGrant) DeepCopyInto(out *UserTopicGrant)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.