Documentation ¶
Overview ¶
Package v1 is the v1 version of the API. +groupName=enterprises.upmc.com
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type Authentication
- type CRDState
- type CRDStatus
- type Cerebro
- type ClusterSpec
- type ElasticsearchCluster
- type ElasticsearchClusterList
- type ImagePullSecrets
- type Instrumentation
- type Kibana
- type MemoryCPU
- type Resources
- type Scheduler
- type SchedulerAuthentication
- type Snapshot
- type Storage
Constants ¶
This section is empty.
Variables ¶
var ( // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: elasticsearchoperator.GroupName, Version: elasticsearchoperator.Version}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type Authentication ¶
Authentication defines credentials for snapshot requests
func (*Authentication) DeepCopy ¶
func (in *Authentication) DeepCopy() *Authentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Authentication.
func (*Authentication) DeepCopyInto ¶
func (in *Authentication) DeepCopyInto(out *Authentication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CRDStatus ¶
type CRDStatus struct { State CRDState `json:"state,omitempty"` Message string `json:"message,omitempty"` }
func (*CRDStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CRDStatus.
func (*CRDStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Cerebro ¶
type Cerebro struct { // Defines the image to use for deploying Cerebro Image string `json:"image"` Configuration string `json:"configuration"` }
Cerebro properties if wanting operator to deploy for user
func (*Cerebro) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cerebro.
func (*Cerebro) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterSpec ¶
type ClusterSpec struct { // ClientNodeSize defines how many client nodes to have in cluster ClientNodeReplicas int32 `json:"client-node-replicas"` // MasterNodeSize defines how many client nodes to have in cluster MasterNodeReplicas int `json:"master-node-replicas"` // DataNodeSize defines how many client nodes to have in cluster DataNodeReplicas int `json:"data-node-replicas"` // NodeSelector specifies a map of key-value pairs. For the pod to be eligible // to run on a node, the node must have each of the indicated key-value pairs as // labels. NodeSelector map[string]string `json:"nodeSelector,omitempty"` // Zones specifies a map of key-value pairs. Defines which zones // to deploy persistent volumes for data nodes Zones []string `json:"zones,omitempty"` // DataDiskSize specifies how large the persistent volume should be attached // to the data nodes in the ES cluster DataDiskSize string `json:"data-volume-size"` // DataDiskSize specifies the docker image to use (optional) ElasticSearchImage string `json:"elastic-search-image"` // Snapshot defines how snapshots are scheduled Snapshot Snapshot `json:"snapshot"` // Storage defines how volumes are provisioned Storage Storage `json:"storage"` // JavaOptions defines args passed to elastic nodes JavaOptions string `json:"java-options"` // ImagePullSecrets defines credentials to pull image from private repository (optional) ImagePullSecrets []ImagePullSecrets `json:"image-pull-secrets"` // Resources defines memory / cpu constraints Resources Resources `json:"resources"` // Instrumentation defines metrics for the cluster Instrumentation Instrumentation `json:"instrumentation"` // Specify how the container binds to network ports NetworkHost string `json:"network-host"` //NodePort NodePort int32 `json:"nodePort"` // Kibana Kibana Kibana `json:"kibana"` //Cerebro Cerebro Cerebro `json:"cerebro"` Scheduler Scheduler //KeepSecretsOnDelete tells the operator to not delete secrets when a cluster is destroyed KeepSecretsOnDelete bool `json:"keep-secrets-on-delete"` }
ClusterSpec defines cluster options
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ElasticsearchCluster ¶
type ElasticsearchCluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Type string `json:"type"` Spec ClusterSpec `json:"spec"` Status CRDStatus `json:"status,omitempty"` }
ElasticsearchCluster defines the cluster
func (*ElasticsearchCluster) DeepCopy ¶
func (in *ElasticsearchCluster) DeepCopy() *ElasticsearchCluster
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ElasticsearchCluster.
func (*ElasticsearchCluster) DeepCopyInto ¶
func (in *ElasticsearchCluster) DeepCopyInto(out *ElasticsearchCluster)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ElasticsearchCluster) DeepCopyObject ¶
func (in *ElasticsearchCluster) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ElasticsearchClusterList ¶
type ElasticsearchClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ElasticsearchCluster `json:"items"` }
ElasticsearchClusterList represents a list of ES Clusters
func (*ElasticsearchClusterList) DeepCopy ¶
func (in *ElasticsearchClusterList) DeepCopy() *ElasticsearchClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ElasticsearchClusterList.
func (*ElasticsearchClusterList) DeepCopyInto ¶
func (in *ElasticsearchClusterList) DeepCopyInto(out *ElasticsearchClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ElasticsearchClusterList) DeepCopyObject ¶
func (in *ElasticsearchClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ImagePullSecrets ¶
type ImagePullSecrets struct { // Name defines the name of the secret file that will be used Name string `json:"name"` }
ImagePullSecrets defines credentials to pull image from private repository
func (*ImagePullSecrets) DeepCopy ¶
func (in *ImagePullSecrets) DeepCopy() *ImagePullSecrets
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImagePullSecrets.
func (*ImagePullSecrets) DeepCopyInto ¶
func (in *ImagePullSecrets) DeepCopyInto(out *ImagePullSecrets)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Instrumentation ¶
type Instrumentation struct {
StatsdHost string `json:"statsd-host"`
}
Instrumentation handles all metrics for the cluster
func (*Instrumentation) DeepCopy ¶
func (in *Instrumentation) DeepCopy() *Instrumentation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Instrumentation.
func (*Instrumentation) DeepCopyInto ¶
func (in *Instrumentation) DeepCopyInto(out *Instrumentation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Kibana ¶
type Kibana struct { // Defines the image to use for deploying kibana Image string `json:"image"` }
Kibana properties if wanting operator to deploy for user
func (*Kibana) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Kibana.
func (*Kibana) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MemoryCPU ¶
type MemoryCPU struct { // Memory defines max amount of memory Memory string `json:"memory"` // CPU defines max amount of CPU CPU string `json:"cpu"` }
MemoryCPU defines memory cpu options
func (*MemoryCPU) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MemoryCPU.
func (*MemoryCPU) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Resources ¶
Resources defines CPU / Memory restrictions on pods
func (*Resources) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resources.
func (*Resources) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Scheduler ¶
type Scheduler struct { S3bucketName string CronSchedule string Enabled bool Auth SchedulerAuthentication ElasticURL string Namespace string ClusterName string }
Scheduler stores info about how to snapshot the cluster
func (*Scheduler) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Scheduler.
func (*Scheduler) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SchedulerAuthentication ¶
SchedulerAuthentication stores credentials used to authenticate against snapshot endpoint
func (*SchedulerAuthentication) DeepCopy ¶
func (in *SchedulerAuthentication) DeepCopy() *SchedulerAuthentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SchedulerAuthentication.
func (*SchedulerAuthentication) DeepCopyInto ¶
func (in *SchedulerAuthentication) DeepCopyInto(out *SchedulerAuthentication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Snapshot ¶
type Snapshot struct { // Enabled determines if snapshots are enabled SchedulerEnabled bool `json:"scheduler-enabled"` // BucketName defines the AWS S3 bucket to store snapshots BucketName string `json:"bucket-name"` // CronSchedule defines how to run the snapshots // SEE: https://godoc.org/github.com/robfig/cron CronSchedule string `json:"cron-schedule"` // Authentication defines credentials for snapshot requests Authentication Authentication `json:"authentication"` }
Snapshot defines all params to create / store snapshots
func (*Snapshot) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Snapshot.
func (*Snapshot) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Storage ¶
type Storage struct { // StorageType is the type of storage to create StorageType string `json:"type"` // StorageClassProvisoner is the storage provisioner type StorageClassProvisoner string `json:"storage-class-provisioner"` // StorageClass to use StorageClass string `json:"storage-class"` // Volume Reclaim Policy on Persistent Volumes VolumeReclaimPolicy string `json:"volume-reclaim-policy"` }
Storage defines how dynamic volumes are created https://kubernetes.io/docs/user-guide/persistent-volumes/
func (*Storage) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Storage.
func (*Storage) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.