deployer

Documentation

Index

• type CreateEtcdClusterOptions
• type CreateGreptimeDBClusterOptions
• type CreateGreptimeDBOperatorOptions
• type DeleteEtcdClusterOption
• type DeleteGreptimeDBClusterOption
• type GetGreptimeDBClusterOptions
• type GreptimeDBCluster
• type Interface
• type ListGreptimeDBClustersOptions
• type UpdateGreptimeDBClusterOptions

Types

type CreateEtcdClusterOptions

type CreateEtcdClusterOptions struct {
	EtcdChartVersion string

	ImageRegistry        string `helm:"image.registry"`
	EtcdStorageClassName string `helm:"storage.storageClassName"`
	EtcdStorageSize      string `helm:"storage.volumeSize"`
	EtcdDataDir          string `helm:"storage.dataDir"`
	ConfigValues         string `helm:"*"`
}

CreateEtcdClusterOptions is the options to create an etcd cluster.

type CreateGreptimeDBClusterOptions

type CreateGreptimeDBClusterOptions struct {
	GreptimeDBChartVersion string

	ImageRegistry               string `helm:"image.registry"`
	InitializerImageRegistry    string `helm:"initializer.registry"`
	DatanodeStorageClassName    string `helm:"datanode.storage.storageClassName"`
	DatanodeStorageSize         string `helm:"datanode.storage.storageSize"`
	DatanodeStorageRetainPolicy string `helm:"datanode.storage.storageRetainPolicy"`
	EtcdEndPoint                string `helm:"etcdEndpoints"`
	ConfigValues                string `helm:"*"`
}

CreateGreptimeDBClusterOptions is the options to create a GreptimeDB cluster.

type CreateGreptimeDBOperatorOptions

type CreateGreptimeDBOperatorOptions struct {
	GreptimeDBOperatorChartVersion string

	ImageRegistry string `helm:"image.registry"`
	ConfigValues  string `helm:"*"`
}

CreateGreptimeDBOperatorOptions is the options to create a GreptimeDB operator.

type DeleteEtcdClusterOption

type DeleteEtcdClusterOption struct{}

DeleteEtcdClusterOption is the options to delete an etcd cluster.

type DeleteGreptimeDBClusterOption

type DeleteGreptimeDBClusterOption struct{}

DeleteGreptimeDBClusterOption is the options to delete a GreptimeDB cluster.

type GetGreptimeDBClusterOptions

type GetGreptimeDBClusterOptions struct{}

GetGreptimeDBClusterOptions is the options to get a GreptimeDB cluster.

type GreptimeDBCluster

type GreptimeDBCluster struct {
	// Raw can be *greptimedbclusterv1alpha1.GreptimeDBCluster.
	Raw interface{}
}

GreptimeDBCluster is the internal type of gtctl to describe GreptimeDB cluster. We want to make the Deployer decouple from K8s or any other specified environment.

type Interface

type Interface interface {
	// GetGreptimeDBCluster get the current deployed GreptimeDBCluster by its name.
	// The name is the namespaced name(<namespace>/<name>) in Kubernetes.
	GetGreptimeDBCluster(ctx context.Context, name string, options *GetGreptimeDBClusterOptions) (*GreptimeDBCluster, error)

	// ListGreptimeDBClusters list all the deployed GreptimeDBClusters.
	ListGreptimeDBClusters(ctx context.Context, options *ListGreptimeDBClustersOptions) ([]*GreptimeDBCluster, error)

	// CreateGreptimeDBCluster create a GreptimeDBCluster with the given cluster name.
	// The name is the namespaced name(<namespace>/<name>) in Kubernetes.
	CreateGreptimeDBCluster(ctx context.Context, name string, options *CreateGreptimeDBClusterOptions) error

	// UpdateGreptimeDBCluster update the GreptimeDBCluster spec with the given cluster name.
	// The name is the namespaced name(<namespace>/<name>) in Kubernetes.
	UpdateGreptimeDBCluster(ctx context.Context, name string, options *UpdateGreptimeDBClusterOptions) error

	// DeleteGreptimeDBCluster delete the GreptimeDBCluster with the given cluster name.
	// The name is the namespaced name(<namespace>/<name>) in Kubernetes.
	DeleteGreptimeDBCluster(ctx context.Context, name string, options *DeleteGreptimeDBClusterOption) error

	// CreateEtcdCluster create etcd cluster with the given cluster name.
	// The name is the namespaced name(<namespace>/<name>) in Kubernetes.
	CreateEtcdCluster(ctx context.Context, name string, options *CreateEtcdClusterOptions) error

	// DeleteEtcdCluster delete the etcd cluster with the given cluster name.
	// The name is the namespaced name(<namespace>/<name>) in Kubernetes.
	DeleteEtcdCluster(ctx context.Context, name string, options *DeleteEtcdClusterOption) error

	// CreateGreptimeDBOperator create a GreptimeDBOperator with the given operator name.
	// The name is the namespaced name(<namespace>/<name>) in Kubernetes.
	// The API only works for Kubernetes.
	CreateGreptimeDBOperator(ctx context.Context, name string, options *CreateGreptimeDBOperatorOptions) error
}

Interface is the general interface to handle the deployment of GreptimeDB cluster in different environment.

type ListGreptimeDBClustersOptions

type ListGreptimeDBClustersOptions struct{}

ListGreptimeDBClustersOptions is the options to list all the GreptimeDB clusters.

type UpdateGreptimeDBClusterOptions

type UpdateGreptimeDBClusterOptions struct {
	NewCluster *GreptimeDBCluster
}

UpdateGreptimeDBClusterOptions is the options to update a GreptimeDB cluster.