Documentation

Overview

Copyright 2020 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=operator.ibm.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=operator.ibm.com

Index

Constants

This section is empty.

Variables

View Source
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "operator.ibm.com", Version: "v1alpha1"}

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

Functions

Types

type DashboardConfig

type DashboardConfig struct {
	DashboardsStatus map[string]bool `json:"dashboardsStatus,omitempty"`
	MainOrg          string          `json:"mainOrg,omitempty"`
}

    DashboardConfig define dashboard config DashboardsStatus to disable/enable dashboards by name MainOrg to decide which org as the main org for all dashboards

    func (*DashboardConfig) DeepCopy

    func (in *DashboardConfig) DeepCopy() *DashboardConfig

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

      func (*DashboardConfig) DeepCopyInto

      func (in *DashboardConfig) DeepCopyInto(out *DashboardConfig)

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

        type Grafana

        type Grafana struct {
        	metav1.TypeMeta   `json:",inline"`
        	metav1.ObjectMeta `json:"metadata,omitempty"`
        
        	Spec   GrafanaSpec   `json:"spec,omitempty"`
        	Status GrafanaStatus `json:"status,omitempty"`
        }

          Grafana is the Schema for the grafanas API +kubebuilder:subresource:status +kubebuilder:resource:path=grafanas,scope=Namespaced

          func (*Grafana) DeepCopy

          func (in *Grafana) DeepCopy() *Grafana

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

            func (*Grafana) DeepCopyInto

            func (in *Grafana) DeepCopyInto(out *Grafana)

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

              func (*Grafana) DeepCopyObject

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

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

                type GrafanaList

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

                  GrafanaList contains a list of Grafana

                  func (*GrafanaList) DeepCopy

                  func (in *GrafanaList) DeepCopy() *GrafanaList

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

                    func (*GrafanaList) DeepCopyInto

                    func (in *GrafanaList) DeepCopyInto(out *GrafanaList)

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

                      func (*GrafanaList) DeepCopyObject

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

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

                        type GrafanaPersistentVolume

                        type GrafanaPersistentVolume struct {
                        	Enabled   bool   `json:"enabled,omitempty"`
                        	ClaimName string `json:"claimName,omitempty"`
                        }

                          GrafanaPersistentVolume setup persistent volumes.

                          func (*GrafanaPersistentVolume) DeepCopy

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

                            func (*GrafanaPersistentVolume) DeepCopyInto

                            func (in *GrafanaPersistentVolume) DeepCopyInto(out *GrafanaPersistentVolume)

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

                              type GrafanaResources

                              type GrafanaResources struct {
                              	Grafana   int `json:"grafana,omitempty"`
                              	Dashboard int `json:"dashboard,omitempty"`
                              	Router    int `json:"router,omitempty"`
                              }

                              func (*GrafanaResources) DeepCopy

                              func (in *GrafanaResources) DeepCopy() *GrafanaResources

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

                                func (*GrafanaResources) DeepCopyInto

                                func (in *GrafanaResources) DeepCopyInto(out *GrafanaResources)

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

                                  type GrafanaService

                                  type GrafanaService struct {
                                  	Annotations map[string]string    `json:"annotations,omitempty"`
                                  	Selector    map[string]string    `json:"selector,omitempty"`
                                  	Labels      map[string]string    `json:"labels,omitempty"`
                                  	Type        corev1.ServiceType   `json:"type,omitempty"`
                                  	Ports       []corev1.ServicePort `json:"ports,omitempty"`
                                  }

                                    GrafanaService provides a means to configure the service

                                    func (*GrafanaService) DeepCopy

                                    func (in *GrafanaService) DeepCopy() *GrafanaService

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

                                      func (*GrafanaService) DeepCopyInto

                                      func (in *GrafanaService) DeepCopyInto(out *GrafanaService)

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

                                        type GrafanaSpec

                                        type GrafanaSpec struct {
                                        	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
                                        	// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
                                        	// Add custom validation using kubebuilder tags: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html
                                        	Containers                  []corev1.Container       `json:"containers,omitempty"`
                                        	Service                     *GrafanaService          `json:"service,omitempty"`
                                        	ServiceAccount              string                   `json:"serviceAccount,omitempty"`
                                        	ClusterPort                 int32                    `json:"clusterPort,omitempty"`
                                        	BaseImage                   string                   `json:"baseImage,omitempty"`
                                        	BaseImageTag                string                   `json:"baseImageTag,omitempty"`
                                        	Resources                   *GrafanaResources        `json:"resources,omitempty"`
                                        	PersistentVolume            *GrafanaPersistentVolume `json:"persistentVolume,omitempty"`
                                        	IsHub                       bool                     `json:"isHub,omitempty"`
                                        	IPVersion                   string                   `json:"ipVersion,omitempty"`
                                        	ImagePullSecrets            []string                 `json:"imagePullSecrets,omitempty"`
                                        	PrometheusServiceName       string                   `json:"prometheusServiceName,omitempty"`
                                        	PrometheusServicePort       int32                    `json:"prometheusServicePort,omitempty"`
                                        	InitImage                   string                   `json:"initImage,omitempty"`
                                        	InitImageTag                string                   `json:"initImageTag,omitempty"`
                                        	RouterImage                 string                   `json:"routerImage,omitempty"`
                                        	RouterImageTag              string                   `json:"routerImageTag,omitempty"`
                                        	DashboardControllerImage    string                   `json:"dashboardCtlImage,omitempty"`
                                        	DashboardControllerImageTag string                   `json:"dashboardCtlImageTag,omitempty"`
                                        	TLSSecretName               string                   `json:"tlsSecretName,omitempty"`
                                        	TLSClientSecretName         string                   `json:"tlsClientSecretName,omitempty"`
                                        	DashboardsConfig            *DashboardConfig         `json:"dashboardConfig,omitempty"`
                                        }

                                          GrafanaSpec defines the desired state of Grafana

                                          func (*GrafanaSpec) DeepCopy

                                          func (in *GrafanaSpec) DeepCopy() *GrafanaSpec

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

                                            func (*GrafanaSpec) DeepCopyInto

                                            func (in *GrafanaSpec) DeepCopyInto(out *GrafanaSpec)

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

                                              type GrafanaStatus

                                              type GrafanaStatus struct {
                                              	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
                                              	// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
                                              	// Add custom validation using kubebuilder tags: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.htm
                                              	Phase   Status `json:"phase"`
                                              	Message string `json:"message"`
                                              }

                                                GrafanaStatus defines the observed state of Grafana

                                                func (*GrafanaStatus) DeepCopy

                                                func (in *GrafanaStatus) DeepCopy() *GrafanaStatus

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

                                                  func (*GrafanaStatus) DeepCopyInto

                                                  func (in *GrafanaStatus) DeepCopyInto(out *GrafanaStatus)

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

                                                    type Status

                                                    type Status string

                                                      Status describe status message of grafana