constants

Documentation

Index

• Constants
• func GetAllStatuses() []string
• func GetDeletingStatuses() []string
• func GetMetricsMetaData() map[string]MetricsMetadata
• func GetSuspendedStatuses() []string
• func GetUpdateableStatuses() []string
• type BillingModel
  • func (b BillingModel) String() string
• type ClusterOperation
  • func (c ClusterOperation) String() string
• type KafkaOperation
  • func (k KafkaOperation) String() string
• type KafkaStatus
  • func (k KafkaStatus) CompareTo(k1 KafkaStatus) int
  • func (k KafkaStatus) String() string
• type MetricsMetadata

Constants

const (
	// ClusterOperationCreate - OpenShift/k8s cluster create operation
	ClusterOperationCreate ClusterOperation = "create"

	// ClusterOperationDelete - OpenShift/k8s cluster delete operation
	ClusterOperationDelete ClusterOperation = "delete"

	// ClusterOperationHardDelete - OpenShift/k8s cluster hard delete operation
	ClusterOperationHardDelete ClusterOperation = "hard_delete"

	// The DNS prefixes used for traffic ingress
	ManagedKafkaIngressDnsNamePrefix = "kas"
	DefaultIngressDnsNamePrefix      = "apps"

	//ImagePullSecretName is the name of the secret used to pull images
	ImagePullSecretName = "rhoas-image-pull-secret"
)

const (
	// KafkaRequestStatusAccepted - kafka request status when accepted by kafka worker
	KafkaRequestStatusAccepted KafkaStatus = "accepted"
	// KafkaRequestStatusPreparing - kafka request status of a preparing kafka
	KafkaRequestStatusPreparing KafkaStatus = "preparing"
	// KafkaRequestStatusProvisioning - kafka in provisioning state
	KafkaRequestStatusProvisioning KafkaStatus = "provisioning"
	// KafkaRequestStatusReady - completed kafka request
	KafkaRequestStatusReady KafkaStatus = "ready"
	// KafkaRequestStatusFailed - kafka request failed
	KafkaRequestStatusFailed KafkaStatus = "failed"
	// KafkaRequestStatusDeprovision - kafka request status when to be deleted by kafka
	KafkaRequestStatusDeprovision KafkaStatus = "deprovision"
	// KafkaRequestStatusDeleting - external resources are being deleted for the kafka request
	KafkaRequestStatusDeleting KafkaStatus = "deleting"
	// KafkaStatusSuspending - status of a kafka request to be put in suspended state
	KafkaRequestStatusSuspending KafkaStatus = "suspending"
	// KafkaStatusSuspended - suspended kafka request
	KafkaRequestStatusSuspended KafkaStatus = "suspended"
	// KafkaStatusResuming - kafka request being resumed from the suspended state
	KafkaRequestStatusResuming KafkaStatus = "resuming"
	// KafkaOperationCreate - Kafka cluster create operations
	KafkaOperationCreate KafkaOperation = "create"
	// KafkaOperationDelete = Kafka cluster delete operations
	KafkaOperationDelete KafkaOperation = "delete"
	// KafkaOperationDeprovision = Kafka cluster deprovision operations
	KafkaOperationDeprovision KafkaOperation = "deprovision"

	// ObservabilityCanaryPodLabelKey that will be used by the observability operator to scrap metrics
	ObservabilityCanaryPodLabelKey = "managed-kafka-canary"

	// ObservabilityCanaryPodLabelValue the value for ObservabilityCanaryPodLabelKey
	ObservabilityCanaryPodLabelValue = "true"

	// KafkaMaxDurationWithProvisioningErrs the maximum duration a Kafka request
	// might be in provisioning state while receiving 5XX errors
	KafkaMaxDurationWithProvisioningErrs = 5 * time.Minute

	// AcceptedKafkaMaxRetryDurationWhileWaitingForStrimziVersion the maximum duration, in minutes, where KAS Fleet Manager
	// will retry reconciliation of a Kafka request in an 'accepted' state in order to assign strimzi, kafka and kafka ibp versions
	AcceptedKafkaMaxRetryDurationWhileWaitingForStrimziVersion = 5 * time.Minute

	// AcceptedKafkaMaxRetryDurationWhileWaitingForClusterAssignment the maximum duration, in hours, where KAS Fleet Manager
	// will retry reconciliation of a Kafka request in an 'accepted' state in order to assign it into a data plane cluster.
	AcceptedKafkaMaxRetryDurationWhileWaitingForClusterAssignment = 1 * time.Hour

	//TrialKafkasDomainShard is the shard name where all the Trial Kafkas routes will be deployed.
	//For all the Trial Kafkas, their Kafka's URLs will be of the form "<unique-slug-specific-to-kafka>.trial.<kafka-domain-name>"
	//e.g when using the "kafka.bf2.dev" domain, an admin server URL of a developer Kafka may look like "admin-server-xxxx.trial.kafka.bf2.dev"
	//see ADR-90 https://github.com/bf2fc6cc711aee1a0c2a/architecture/blob/main/_adr/90/index.adoc for more context
	TrialKafkasDomainShard = "trial"
)

const (
	KafkaServerBrokertopicmetricsMessagesInTotalDesc         = "" /* 126-byte string literal not displayed */
	KafkaServerBrokertopicmetricsBytesInTotalDesc            = "Attribute exposed for management (kafka.server<type=BrokerTopicMetrics, name=BytesInPerSec, topic=__strimzi_canary><>Count)"
	KafkaServerBrokertopicmetricsBytesOutTotalDesc           = "Attribute exposed for management (kafka.server<type=BrokerTopicMetrics, name=BytesOutPerSec, topic=__strimzi_canary><>Count)"
	KafkaControllerKafkacontrollerOfflinePartitionsCountDesc = "Attribute exposed for management (kafka.controller<type=KafkaController, name=OfflinePartitionsCount><>Value)"
	KafkaControllerKafkacontrollerGlobalPartitionCountDesc   = "Attribute exposed for management (kafka.controller<type=KafkaController, name=GlobalPartitionCount><>Value)"
	KafkaTopicKafkaLogLogSizeSumDesc                         = "Attribute exposed for management (kafka.log<type=Log, name=Size, topic=__consumer_offsets, partition=18><>Value)"
	KafkaTopicPartitionLogSizeBytesDesc                      = "Size in bytes of each topic partition on each kafka broker"
	KafkaBrokerPartitionLogSizeBytesTop50Desc                = "Sizes in bytes of the top 50 topic partitions for each kafka broker"
	KafkaBrokerQuotaSoftlimitbytesDesc                       = "Attribute exposed for management (io.strimzi.kafka.quotas<type=StorageChecker, name=SoftLimitBytes><>Value)"
	KafkaBrokerQuotaHardlimitbytesDesc                       = "Attribute exposed for management (io.strimzi.kafka.quotas<type=StorageChecker, name=HardLimitBytes><>Value)"
	KafkaBrokerQuotaTotalstorageusedbytesDesc                = "Attribute exposed for management (io.strimzi.kafka.quotas<type=StorageChecker, name=TotalStorageUsedBytes><>Value)"
	KafkaBrokerClientQuotaLimitDesc                          = "Produce/fetch/request client quota limits imposed by broker quota-plugin"
	KubeletVolumeStatsAvailableBytesDesc                     = "Number of available bytes in the volume"
	KubeletVolumeStatsUsedBytesDesc                          = "Number of used bytes in the volume"
	HaproxyServerBytesInTotalDesc                            = "Current total of incoming bytes"
	HaproxyServerBytesOutTotalDesc                           = "Current total of outgoing bytes"
	KafkaTopicPartitionsSumDesc                              = "Number of topic partitions for this Kafka"
	KafkaTopicPartitionsCountDesc                            = "Number of Topics for this Kafka"
	KafkaConsumergroupMembersDesc                            = "Amount of members in a consumer group"
	KafkaServerSocketServerMetricsConnectionCountDesc        = "Current number of total kafka connections"
	KafkaServerSocketServerMetricsConnectionCreationRateDesc = "Current rate of connections creation"
	KafkaTopicIncomingMessagesRateDesc                       = "Current rate of incoming messages over the last 5 minutes"
	KafkaTopicTotalIncomingBytesRateDesc                     = "Current total rate of incoming bytes over the last 5 minutes"
	KafkaTopicTotalOutgoingBytesRateDesc                     = "Current total rate of outgoing bytes over the last 5 minutes"
	KafkaInstanceSpecBrokersDesiredCountDesc                 = "Desired number of brokers for this Kafka"
	KafkaInstanceMaxMessageSizeLimitDesc                     = "Maximum message size for this Kafka"
	KafkaInstancePartitionLimitDesc                          = "Maximum number of partitions for this Kafka"
	KafkaInstanceConnectionLimitDesc                         = "Maximum number of connections for this Kafka"
	KafkaInstanceConnectionCreationRateLimitDesc             = "Maximum rate of new connections for this Kafka"
)

Functions

func GetAllStatuses

func GetAllStatuses() []string

func GetDeletingStatuses

func GetDeletingStatuses() []string

func GetMetricsMetaData

func GetMetricsMetaData() map[string]MetricsMetadata

func GetSuspendedStatuses

func GetSuspendedStatuses() []string

func GetUpdateableStatuses

func GetUpdateableStatuses() []string

Types

type BillingModel

type BillingModel string

const (
	BillingModelEnterprise BillingModel = "enterprise"
)

func (BillingModel) String

func (b BillingModel) String() string

type ClusterOperation

type ClusterOperation string

ClusterOperation type

func (ClusterOperation) String

func (c ClusterOperation) String() string

type KafkaOperation

type KafkaOperation string

KafkaOperation type

func (KafkaOperation) String

func (k KafkaOperation) String() string

type KafkaStatus

type KafkaStatus string

KafkaStatus type

func (KafkaStatus) CompareTo

func (k KafkaStatus) CompareTo(k1 KafkaStatus) int

CompareTo - Compare this status with the given status returning an int. The result will be 0 if k==k1, -1 if k < k1, and +1 if k > k1

func (KafkaStatus) String

func (k KafkaStatus) String() string

KafkaStatus Methods

type MetricsMetadata

type MetricsMetadata struct {
	Name           string
	Help           string
	Type           prometheus.ValueType
	TypeName       string
	VariableLabels []string
	ConstantLabels prometheus.Labels
}