v1alpha1

Documentation

Overview

+groupName=config.kubedb.com

Index

• Constants
• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• func SOCATOption(retry int32) string
• type GaleraArbitratorConfiguration
  • func (g *GaleraArbitratorConfiguration) ClusterAddressWithListenOption() string
  • func (in *GaleraArbitratorConfiguration) DeepCopy() *GaleraArbitratorConfiguration
  • func (in *GaleraArbitratorConfiguration) DeepCopyInto(out *GaleraArbitratorConfiguration)
  • func (in *GaleraArbitratorConfiguration) DeepCopyObject() runtime.Object
  • func (g *GaleraArbitratorConfiguration) SSTRequestString(host string) string
• type MongoDBConfiguration
  • func (in *MongoDBConfiguration) DeepCopy() *MongoDBConfiguration
  • func (in *MongoDBConfiguration) DeepCopyInto(out *MongoDBConfiguration)
  • func (in *MongoDBConfiguration) DeepCopyObject() runtime.Object
• type RedisConfiguration
  • func (in *RedisConfiguration) DeepCopy() *RedisConfiguration
  • func (in *RedisConfiguration) DeepCopyInto(out *RedisConfiguration)
  • func (in *RedisConfiguration) DeepCopyObject() runtime.Object

Constants

const (
	// GarbdListenPort is the port at which Galera Arbitrator Daemon (garbd) listen
	GarbdListenPort = 4444

	// GarbdXtrabackupSSTMethod is the name of the method or script that is
	// used during a State SnapshotID Transfer to Galera Arbitrator Daemon (garbd).
	GarbdXtrabackupSSTMethod = "xtrabackup-v2"

	// GarbdXtrabackupSSTRequestSuffix denotes the suffix of sst request string for xtrabackup
	// used by Galera Arbitrator Daemon (garbd)
	GarbdXtrabackupSSTRequestSuffix = "/xtrabackup_sst//1"
	// GarbdLogFile is the name log file at which Galera Arbitrator Daemon (garbd) puts logs
	GarbdLogFile = "/tmp/garb.log"

	// SOCAT is needed after completing sst by Galera Arbitrator Daemon (garbd)
	// SOCATOptionReUseAddr is the SOCAT reuseaddr option
	SOCATOptionReUseAddr = "reuseaddr"
	// SOCATOptionRetry is the default retry value for `socat` binary
	SOCATOptionRetry = 30
)

const (
	// Resource Kind for GaleraArbitratorConfiguration
	ResourceKindGaleraArbitratorConfiguration = "GaleraArbitratorConfiguration"
)

const (
	ResourceKindMongoConfiguration = "MongoConfiguration"
)

const (
	ResourceKindRedisConfiguration = "RedisConfiguration"
)

Variables

var (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: config.GroupName, Version: "v1alpha1"}

Functions

func GetOpenAPIDefinitions

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

func SOCATOption

func SOCATOption(retry int32) string

SOCATOption returns the option string used for `SOCAT` in the percona xtradb backup process

Types

type GaleraArbitratorConfiguration

type GaleraArbitratorConfiguration struct {
	metav1.TypeMeta `json:",inline,omitempty"`

	// Address denotes the logical name of the galera cluster. It is
	// used as the value of the variable named "wsrep_cluster_name"
	// in the replication configuration for galera
	// Ref: https://galeracluster.com/library/documentation/mysql-wsrep-options.html#wsrep-cluster-name
	Address string `json:"address,omitempty"`

	// Group denotes the collection of cluster members by IP address
	// or resolvable domain name. This address is used as the value of the
	// variable named "wsrep_cluster_address" in the replication configuration
	// for galera. It must be in galera format.
	// Ref: https://galeracluster.com/library/documentation/mysql-wsrep-options.html#wsrep-cluster-address
	Group string `json:"group,omitempty"`

	// SSTMethod denotes the method or script the node uses during a State SnapshotID Transfer.
	// This method is needed to form the SST request string that contains SST request to
	// trigger state snapshot dump (state backup) on one of the other nodes.
	// Ref: https://galeracluster.com/library/documentation/mysql-wsrep-options.html#wsrep-sst-method
	SSTMethod string `json:"sstMethod,omitempty"`

	// Stash defines backup and restore task definitions.
	// +optional
	Stash appcat.StashAddonSpec `json:"stash,omitempty"`
}

GaleraArbitratorConfiguration defines Galera ARBitrator Daemon (garbd) configuration. Ref: https://galeracluster.com/library/documentation/arbitrator.html

https://galeracluster.com/library/documentation/backup-cluster.html

func (*GaleraArbitratorConfiguration) ClusterAddressWithListenOption

func (g *GaleraArbitratorConfiguration) ClusterAddressWithListenOption() string

ClusterAddressWithListenOption method returns the galera cluster address with the listening option (address at which Galera Cluster listens to connections from other nodes) for `--address` option in `garbd` Here, ‘?gmcast.listen_addr=tcp://0.0.0.0:4444‘ is an arbitrary listen socket address that Galera Arbitrator opens to communicate with the cluster. https://galeracluster.com/library/documentation/backup-cluster.html

func (*GaleraArbitratorConfiguration) DeepCopy

func (in *GaleraArbitratorConfiguration) DeepCopy() *GaleraArbitratorConfiguration

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

func (*GaleraArbitratorConfiguration) DeepCopyInto

func (in *GaleraArbitratorConfiguration) DeepCopyInto(out *GaleraArbitratorConfiguration)

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

func (*GaleraArbitratorConfiguration) DeepCopyObject

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

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

func (*GaleraArbitratorConfiguration) SSTRequestString

func (g *GaleraArbitratorConfiguration) SSTRequestString(host string) string

SSTRequestString method form the sst request string for `--sst` option in `garbd`

type MongoDBConfiguration

type MongoDBConfiguration struct {
	metav1.TypeMeta `json:",inline,omitempty"`

	// ConfigServer is the dsn of config server of mongodb sharding. The dsn includes the port no too.
	ConfigServer string `json:"configServer,omitempty"`

	// ReplicaSets contains the dsn of each replicaset of sharding. The DSNs are in key-value pair, where
	// the keys are host-0, host-1 etc, and the values are DSN of each replicaset. If there is no sharding
	// but only one replicaset, then ReplicaSets field contains only one key-value pair where the key is
	// host-0 and the value is dsn of that replicaset.
	ReplicaSets map[string]string `json:"replicaSets,omitempty"`

	// Stash defines backup and restore task definitions.
	// +optional
	Stash appcat.StashAddonSpec `json:"stash,omitempty"`
}

MongoDBConfiguration defines a MongoDB app configuration. https://www.vaultproject.io/api/secret/databases/index.html https://www.vaultproject.io/api/secret/databases/mongodb.html#configure-connection

func (*MongoDBConfiguration) DeepCopy

func (in *MongoDBConfiguration) DeepCopy() *MongoDBConfiguration

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

func (*MongoDBConfiguration) DeepCopyInto

func (in *MongoDBConfiguration) DeepCopyInto(out *MongoDBConfiguration)

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

func (*MongoDBConfiguration) DeepCopyObject

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

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

type RedisConfiguration

type RedisConfiguration struct {
	metav1.TypeMeta `json:",inline,omitempty"`

	// ClientCertSecret is the client secret name which needs to provide when the Redis client need to authenticate with client key and cert.
	// It will be used when `tls-auth-clients` value is set to `required` or `yes`.
	// +optional
	ClientCertSecret *v1.LocalObjectReference `json:"clientCertSecret,omitempty"`

	// Stash defines backup and restore task definitions.
	// +optional
	Stash appcat.StashAddonSpec `json:"stash,omitempty"`
}

RedisConfiguration defines a Redis appBinding configuration.

func (*RedisConfiguration) DeepCopy

func (in *RedisConfiguration) DeepCopy() *RedisConfiguration

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

func (*RedisConfiguration) DeepCopyInto

func (in *RedisConfiguration) DeepCopyInto(out *RedisConfiguration)

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

func (*RedisConfiguration) DeepCopyObject

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

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