v1alpha1

package
v1.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 10, 2021 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

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

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

func GetOpenAPIDefinitions 

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

Types

type Container 

type Container struct {
	// IBM Licensing Service docker Image Registry, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment
	ImageRegistry string `json:"imageRegistry,omitempty"`
	// IBM Licensing Service docker Image Name, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment
	ImageName string `json:"imageName,omitempty"`
	// IBM Licensing Service docker Image Tag or Digest, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment
	ImageTagPostfix string `json:"imageTagPostfix,omitempty"`

	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// +kubebuilder:validation:Enum=Always;IfNotPresent;Never
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
}

func (*Container) DeepCopy 

func (in *Container) DeepCopy() *Container

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

func (*Container) DeepCopyInto 

func (in *Container) DeepCopyInto(out *Container)

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

func (*Container) GetFullImage 

func (container *Container) GetFullImage() string

type HTTPSCertsSource 

type HTTPSCertsSource string

HTTPSCertsSource describes how certificate is set in available APIs 

const (
	// OcpCertsSource means application will use cert manager
	OcpCertsSource HTTPSCertsSource = "ocp"
	// SelfSignedCertsSource means application will create certificate by itself and use it
	SelfSignedCertsSource HTTPSCertsSource = "self-signed"
	// CustomCertsSource means application will use certificate created by user
	CustomCertsSource HTTPSCertsSource = "custom"
)

type IBMLicenseServiceBaseSpec 

type IBMLicenseServiceBaseSpec struct {
	// Should application pod show additional information, options: DEBUG, INFO
	// +kubebuilder:validation:Enum=DEBUG;INFO
	LogLevel string `json:"logLevel,omitempty"`
	// Secret name used to store application token, either one that exists, or one that will be created
	APISecretToken string `json:"apiSecretToken,omitempty"`
	// Array of pull secrets which should include existing at InstanceNamespace secret to allow pulling IBM Licensing image
	ImagePullSecrets []string `json:"imagePullSecrets,omitempty"`
	// options: self-signed or custom
	// +kubebuilder:validation:Enum=self-signed;custom;ocp
	HTTPSCertsSource HTTPSCertsSource `json:"httpsCertsSource,omitempty"`
	// Route parameters
	RouteOptions *IBMLicenseServiceRouteOptions `json:"routeOptions,omitempty"`
	// Version
	Version string `json:"version,omitempty"`
}

func (*IBMLicenseServiceBaseSpec) DeepCopy 

func (in *IBMLicenseServiceBaseSpec) DeepCopy() *IBMLicenseServiceBaseSpec

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

func (*IBMLicenseServiceBaseSpec) DeepCopyInto 

func (in *IBMLicenseServiceBaseSpec) DeepCopyInto(out *IBMLicenseServiceBaseSpec)

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

type IBMLicenseServiceReporter 

type IBMLicenseServiceReporter struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   IBMLicenseServiceReporterSpec   `json:"spec,omitempty"`
	Status IBMLicenseServiceReporterStatus `json:"status,omitempty"`
}

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

func (*IBMLicenseServiceReporter) DeepCopy 

func (in *IBMLicenseServiceReporter) DeepCopy() *IBMLicenseServiceReporter

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

func (*IBMLicenseServiceReporter) DeepCopyInto 

func (in *IBMLicenseServiceReporter) DeepCopyInto(out *IBMLicenseServiceReporter)

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

func (*IBMLicenseServiceReporter) DeepCopyObject 

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

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

type IBMLicenseServiceReporterList 

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

IBMLicenseServiceReporterList contains a list of IBMLicenseServiceReporter

func (*IBMLicenseServiceReporterList) DeepCopy 

func (in *IBMLicenseServiceReporterList) DeepCopy() *IBMLicenseServiceReporterList

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

func (*IBMLicenseServiceReporterList) DeepCopyInto 

func (in *IBMLicenseServiceReporterList) DeepCopyInto(out *IBMLicenseServiceReporterList)

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

func (*IBMLicenseServiceReporterList) DeepCopyObject 

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

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

type IBMLicenseServiceReporterSpec 

type IBMLicenseServiceReporterSpec struct {
	// Receiver Settings
	ReceiverContainer Container `json:"receiverContainer,omitempty"`
	// Receiver Settings
	ReporterUIContainer Container `json:"reporterUIContainer,omitempty"`
	// Database Settings
	DatabaseContainer Container `json:"databaseContainer,omitempty"`
	// Common Parameters for operator
	IBMLicenseServiceBaseSpec `json:",inline"`
	// Storage class used by database to provide persistency
	StorageClass string `json:"storageClass,omitempty"`
	// Persistent Volume Claim Capacity
	Capacity resource.Quantity `json:"capacity,omitempty" protobuf:"bytes,2,opt,name=capacity"`
}

IBMLicenseServiceReporterSpec defines the desired state of IBMLicenseServiceReporter

func (*IBMLicenseServiceReporterSpec) DeepCopy 

func (in *IBMLicenseServiceReporterSpec) DeepCopy() *IBMLicenseServiceReporterSpec

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

func (*IBMLicenseServiceReporterSpec) DeepCopyInto 

func (in *IBMLicenseServiceReporterSpec) DeepCopyInto(out *IBMLicenseServiceReporterSpec)

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

func (*IBMLicenseServiceReporterSpec) FillDefaultValues 

func (spec *IBMLicenseServiceReporterSpec) FillDefaultValues(reqLogger logr.Logger, r client_reader.Reader) error

type IBMLicenseServiceReporterStatus 

type IBMLicenseServiceReporterStatus struct {
	// 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
	LicensingReporterPods []corev1.PodStatus `json:"LicensingReporterPods"`
}

IBMLicenseServiceReporterStatus defines the observed state of IBMLicenseServiceReporter

func (*IBMLicenseServiceReporterStatus) DeepCopy 

func (in *IBMLicenseServiceReporterStatus) DeepCopy() *IBMLicenseServiceReporterStatus

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

func (*IBMLicenseServiceReporterStatus) DeepCopyInto 

func (in *IBMLicenseServiceReporterStatus) DeepCopyInto(out *IBMLicenseServiceReporterStatus)

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

type IBMLicenseServiceRouteOptions 

type IBMLicenseServiceRouteOptions struct {
	TLS *routev1.TLSConfig `json:"tls,omitempty"`
}

func (*IBMLicenseServiceRouteOptions) DeepCopy 

func (in *IBMLicenseServiceRouteOptions) DeepCopy() *IBMLicenseServiceRouteOptions

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

func (*IBMLicenseServiceRouteOptions) DeepCopyInto 

func (in *IBMLicenseServiceRouteOptions) DeepCopyInto(out *IBMLicenseServiceRouteOptions)

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

type IBMLicensing 

type IBMLicensing struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   IBMLicensingSpec   `json:"spec,omitempty"`
	Status IBMLicensingStatus `json:"status,omitempty"`
}

IBMLicensing is the Schema for the ibmlicensings API +kubebuilder:printcolumn:name="Pod Phase",type=string,JSONPath=`.status..phase` +kubebuilder:subresource:status +kubebuilder:resource:path=ibmlicensings,scope=Cluster

func (*IBMLicensing) DeepCopy 

func (in *IBMLicensing) DeepCopy() *IBMLicensing

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

func (*IBMLicensing) DeepCopyInto 

func (in *IBMLicensing) DeepCopyInto(out *IBMLicensing)

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

func (*IBMLicensing) DeepCopyObject 

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

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

type IBMLicensingIngressOptions 

type IBMLicensingIngressOptions struct {
	// Path after host where API will be available f.e. https://<hostname>:<port>/ibm-licensing-service-instance
	Path *string `json:"path,omitempty"`
	// Additional annotations that should include f.e. ingress class if using not default ingress controller
	Annotations map[string]string `json:"annotations,omitempty"`
	// TLS Options to enable secure connection
	TLS []extensionsv1.IngressTLS `json:"tls,omitempty"`
	// If you use non-default host include it here
	Host *string `json:"host,omitempty"`
}

func (*IBMLicensingIngressOptions) DeepCopy 

func (in *IBMLicensingIngressOptions) DeepCopy() *IBMLicensingIngressOptions

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

func (*IBMLicensingIngressOptions) DeepCopyInto 

func (in *IBMLicensingIngressOptions) DeepCopyInto(out *IBMLicensingIngressOptions)

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

type IBMLicensingList 

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

IBMLicensingList contains a list of IBMLicensing

func (*IBMLicensingList) DeepCopy 

func (in *IBMLicensingList) DeepCopy() *IBMLicensingList

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

func (*IBMLicensingList) DeepCopyInto 

func (in *IBMLicensingList) DeepCopyInto(out *IBMLicensingList)

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

func (*IBMLicensingList) DeepCopyObject 

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

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

type IBMLicensingRouteOptions 

type IBMLicensingRouteOptions struct {
	TLS *routev1.TLSConfig `json:"tls,omitempty"`
}

func (*IBMLicensingRouteOptions) DeepCopy 

func (in *IBMLicensingRouteOptions) DeepCopy() *IBMLicensingRouteOptions

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

func (*IBMLicensingRouteOptions) DeepCopyInto 

func (in *IBMLicensingRouteOptions) DeepCopyInto(out *IBMLicensingRouteOptions)

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

type IBMLicensingSecurityContext 

type IBMLicensingSecurityContext struct {
	RunAsUser int64 `json:"runAsUser"`
}

func (*IBMLicensingSecurityContext) DeepCopy 

func (in *IBMLicensingSecurityContext) DeepCopy() *IBMLicensingSecurityContext

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

func (*IBMLicensingSecurityContext) DeepCopyInto 

func (in *IBMLicensingSecurityContext) DeepCopyInto(out *IBMLicensingSecurityContext)

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

type IBMLicensingSenderSpec 

type IBMLicensingSenderSpec struct {
	// URL for License Service Reporter receiver that collects and aggregate multi cluster licensing data.
	ReporterURL string `json:"reporterURL,omitempty"`
	// License Service Reporter authentication token, provided by secret that you need to create in instance namespace
	ReporterSecretToken string `json:"reporterSecretToken,omitempty"`
	// What is the name of this reporting cluster in multi-cluster system. If not provided, CLUSTER_ID will be used as CLUSTER_NAME at Operand level
	ClusterName string `json:"clusterName,omitempty"`
	// Unique ID of reporting cluster
	ClusterID string `json:"clusterID,omitempty"`
}

func (*IBMLicensingSenderSpec) DeepCopy 

func (in *IBMLicensingSenderSpec) DeepCopy() *IBMLicensingSenderSpec

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

func (*IBMLicensingSenderSpec) DeepCopyInto 

func (in *IBMLicensingSenderSpec) DeepCopyInto(out *IBMLicensingSenderSpec)

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

type IBMLicensingSpec 

type IBMLicensingSpec struct {
	// Container Settings
	Container `json:",inline"`
	// Common Parameters for Operator
	IBMLicenseServiceBaseSpec `json:",inline"`
	// Where should data be collected, options: metering, datacollector
	// +kubebuilder:validation:Enum=metering;datacollector
	Datasource string `json:"datasource"`
	// Enables https access at pod level, httpsCertsSource needed if true
	HTTPSEnable bool `json:"httpsEnable"`
	// Existing or to be created namespace where application will start. In case metering data collection is used,
	// should be the same namespace as metering components
	InstanceNamespace string `json:"instanceNamespace"`
	// If default SCC user ID fails, you can set runAsUser option to fix that
	SecurityContext *IBMLicensingSecurityContext `json:"securityContext,omitempty"`
	// Should Route be created to expose IBM Licensing Service API? (only on OpenShift cluster)
	RouteEnabled *bool `json:"routeEnabled,omitempty"`
	// Should Ingress be created to expose IBM Licensing Service API?
	IngressEnabled *bool `json:"ingressEnabled,omitempty"`
	// If ingress is enabled, you can set its parameters
	IngressOptions *IBMLicensingIngressOptions `json:"ingressOptions,omitempty"`
	// Sender configuration, set if you have multi-cluster environment from which you collect data
	Sender *IBMLicensingSenderSpec `json:"sender,omitempty"`
}

IBMLicensingSpec defines the desired state of IBMLicensing

func (*IBMLicensingSpec) DeepCopy 

func (in *IBMLicensingSpec) DeepCopy() *IBMLicensingSpec

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

func (*IBMLicensingSpec) DeepCopyInto 

func (in *IBMLicensingSpec) DeepCopyInto(out *IBMLicensingSpec)

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

func (*IBMLicensingSpec) FillDefaultValues 

func (spec *IBMLicensingSpec) FillDefaultValues(isOCP4CertManager bool, isRouteEnabled bool) error

func (*IBMLicensingSpec) GetDefaultReporterTokenName 

func (spec *IBMLicensingSpec) GetDefaultReporterTokenName() string

func (*IBMLicensingSpec) IsDebug 

func (spec *IBMLicensingSpec) IsDebug() bool

func (*IBMLicensingSpec) IsIngressEnabled 

func (spec *IBMLicensingSpec) IsIngressEnabled() bool

func (*IBMLicensingSpec) IsMetering 

func (spec *IBMLicensingSpec) IsMetering() bool

func (*IBMLicensingSpec) IsRouteEnabled 

func (spec *IBMLicensingSpec) IsRouteEnabled() bool

func (*IBMLicensingSpec) RemoveDefaultSenderParameters 

func (spec *IBMLicensingSpec) RemoveDefaultSenderParameters() bool

func (*IBMLicensingSpec) SetDefaultSenderParameters 

func (spec *IBMLicensingSpec) SetDefaultSenderParameters() bool

type IBMLicensingStatus 

type IBMLicensingStatus struct {

	// LicensingPods are the names of the licensing pods
	LicensingPods []corev1.PodStatus `json:"licensingPods"`
}

IBMLicensingStatus defines the observed state of IBMLicensing

func (*IBMLicensingStatus) DeepCopy 

func (in *IBMLicensingStatus) DeepCopy() *IBMLicensingStatus

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

func (*IBMLicensingStatus) DeepCopyInto 

func (in *IBMLicensingStatus) DeepCopyInto(out *IBMLicensingStatus)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.