v4

package
v0.0.0-...-559238b Latest Latest
Warning

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

Go to latest
Published: Apr 7, 2025 License: UPL-1.0 Imports: 14 Imported by: 0

Documentation

Overview

Package v4 contains API Schema definitions for the observability v4 API group +kubebuilder:object:generate=true +groupName=observability.oracle.com

Index

Constants

View Source
const (
	AllowedExporterImage                       = "container-registry.oracle.com/database/observability-exporter"
	ErrorSpecValidationMissingConnString       = "a required field for database connection string secret is missing or does not have a value"
	ErrorSpecValidationMissingDBUser           = "a required field for database user secret is missing or does not have a value"
	ErrorSpecValidationMissingDBVaultField     = "a field for the OCI vault has a value but the other required field is missing or does not have a value"
	ErrorSpecValidationMissingOCIConfig        = "a field(s) for the OCI Config is missing or does not have a value when fields for the OCI vault has values"
	ErrorSpecValidationMissingDBPasswordSecret = "a required field for the database password secret is missing or does not have a value"
	ErrorSpecExporterImageNotAllowed           = "a different exporter image was found, only official database exporter container images are currently supported"
)

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "observability.oracle.com", Version: "v4"}

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

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type ConfigMapDetails

type ConfigMapDetails struct {
	Key  string `json:"key,omitempty"`
	Name string `json:"name,omitempty"`
}

ConfigMapDetails defines the configmap name

func (*ConfigMapDetails) DeepCopy

func (in *ConfigMapDetails) DeepCopy() *ConfigMapDetails

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

func (*ConfigMapDetails) DeepCopyInto

func (in *ConfigMapDetails) DeepCopyInto(out *ConfigMapDetails)

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

type DBSecret

type DBSecret struct {
	Key        string `json:"key,omitempty"`
	SecretName string `json:"secret,omitempty"`
}

DBSecret defines secrets used in reference

func (*DBSecret) DeepCopy

func (in *DBSecret) DeepCopy() *DBSecret

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

func (*DBSecret) DeepCopyInto

func (in *DBSecret) DeepCopyInto(out *DBSecret)

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

type DBSecretWithVault

type DBSecretWithVault struct {
	Key             string `json:"key,omitempty"`
	SecretName      string `json:"secret,omitempty"`
	VaultOCID       string `json:"vaultOCID,omitempty"`
	VaultSecretName string `json:"vaultSecretName,omitempty"`
}

DBSecretWithVault defines secrets used in reference with vault fields

func (*DBSecretWithVault) DeepCopy

func (in *DBSecretWithVault) DeepCopy() *DBSecretWithVault

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

func (*DBSecretWithVault) DeepCopyInto

func (in *DBSecretWithVault) DeepCopyInto(out *DBSecretWithVault)

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

type DatabaseObserver

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

	Spec   DatabaseObserverSpec   `json:"spec,omitempty"`
	Status DatabaseObserverStatus `json:"status,omitempty"`
}

DatabaseObserver is the Schema for the databaseobservers API +kubebuilder:printcolumn:JSONPath=".status.exporterConfig",name="ExporterConfig",type=string +kubebuilder:printcolumn:JSONPath=".status.status",name="Status",type=string +kubebuilder:printcolumn:JSONPath=".status.version",name="Version",type=string +kubebuilder:storageversion

func (*DatabaseObserver) DeepCopy

func (in *DatabaseObserver) DeepCopy() *DatabaseObserver

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

func (*DatabaseObserver) DeepCopyInto

func (in *DatabaseObserver) DeepCopyInto(out *DatabaseObserver)

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

func (*DatabaseObserver) DeepCopyObject

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

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

func (*DatabaseObserver) Default

func (r *DatabaseObserver) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*DatabaseObserver) SetupWebhookWithManager

func (r *DatabaseObserver) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*DatabaseObserver) ValidateCreate

func (r *DatabaseObserver) ValidateCreate() (admission.Warnings, error)

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*DatabaseObserver) ValidateDelete

func (r *DatabaseObserver) ValidateDelete() (admission.Warnings, error)

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*DatabaseObserver) ValidateUpdate

func (r *DatabaseObserver) ValidateUpdate(old runtime.Object) (admission.Warnings, error)

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type DatabaseObserverConfigMap

type DatabaseObserverConfigMap struct {
	Configmap ConfigMapDetails `json:"configMap,omitempty"`
}

DatabaseObserverConfigMap defines configMap used for metrics configuration

func (*DatabaseObserverConfigMap) DeepCopy

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

func (*DatabaseObserverConfigMap) DeepCopyInto

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

type DatabaseObserverDatabase

type DatabaseObserverDatabase struct {
	DBUser             DBSecret          `json:"dbUser,omitempty"`
	DBPassword         DBSecretWithVault `json:"dbPassword,omitempty"`
	DBWallet           DBSecret          `json:"dbWallet,omitempty"`
	DBConnectionString DBSecret          `json:"dbConnectionString,omitempty"`
}

DatabaseObserverDatabase defines the database details used for DatabaseObserver

func (*DatabaseObserverDatabase) DeepCopy

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

func (*DatabaseObserverDatabase) DeepCopyInto

func (in *DatabaseObserverDatabase) DeepCopyInto(out *DatabaseObserverDatabase)

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

type DatabaseObserverDeployment

type DatabaseObserverDeployment struct {
	ExporterImage         string                  `json:"image,omitempty"`
	SecurityContext       *corev1.SecurityContext `json:"securityContext,omitempty"`
	ExporterArgs          []string                `json:"args,omitempty"`
	ExporterCommands      []string                `json:"commands,omitempty"`
	ExporterEnvs          map[string]string       `json:"env,omitempty"`
	Labels                map[string]string       `json:"labels,omitempty"`
	DeploymentPodTemplate DeploymentPodTemplate   `json:"podTemplate,omitempty"`
}

DatabaseObserverDeployment defines the exporter deployment component of DatabaseObserver

func (*DatabaseObserverDeployment) DeepCopy

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

func (*DatabaseObserverDeployment) DeepCopyInto

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

type DatabaseObserverExporterConfig

type DatabaseObserverExporterConfig struct {
	Deployment DatabaseObserverDeployment `json:"deployment,omitempty"`
	Service    DatabaseObserverService    `json:"service,omitempty"`
}

DatabaseObserverExporterConfig defines the configuration details related to the exporters of DatabaseObserver

func (*DatabaseObserverExporterConfig) DeepCopy

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

func (*DatabaseObserverExporterConfig) DeepCopyInto

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

type DatabaseObserverList

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

DatabaseObserverList contains a list of DatabaseObserver

func (*DatabaseObserverList) DeepCopy

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

func (*DatabaseObserverList) DeepCopyInto

func (in *DatabaseObserverList) DeepCopyInto(out *DatabaseObserverList)

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

func (*DatabaseObserverList) DeepCopyObject

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

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

type DatabaseObserverService

type DatabaseObserverService struct {
	Ports  []corev1.ServicePort `json:"ports,omitempty"`
	Labels map[string]string    `json:"labels,omitempty"`
}

DatabaseObserverService defines the exporter service component of DatabaseObserver

func (*DatabaseObserverService) DeepCopy

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

func (*DatabaseObserverService) DeepCopyInto

func (in *DatabaseObserverService) DeepCopyInto(out *DatabaseObserverService)

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

type DatabaseObserverSpec

type DatabaseObserverSpec struct {
	Database         DatabaseObserverDatabase       `json:"database,omitempty"`
	Exporter         DatabaseObserverExporterConfig `json:"exporter,omitempty"`
	ExporterConfig   DatabaseObserverConfigMap      `json:"configuration,omitempty"`
	Prometheus       PrometheusConfig               `json:"prometheus,omitempty"`
	OCIConfig        OCIConfigSpec                  `json:"ociConfig,omitempty"`
	Replicas         int32                          `json:"replicas,omitempty"`
	Log              LogConfig                      `json:"log,omitempty"`
	InheritLabels    []string                       `json:"inheritLabels,omitempty"`
	ExporterSidecars []corev1.Container             `json:"sidecars,omitempty"`
	SideCarVolumes   []corev1.Volume                `json:"sidecarVolumes,omitempty"`
}

DatabaseObserverSpec defines the desired state of DatabaseObserver

func (*DatabaseObserverSpec) DeepCopy

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

func (*DatabaseObserverSpec) DeepCopyInto

func (in *DatabaseObserverSpec) DeepCopyInto(out *DatabaseObserverSpec)

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

type DatabaseObserverStatus

type DatabaseObserverStatus struct {
	Conditions     []metav1.Condition `json:"conditions"`
	Status         string             `json:"status,omitempty"`
	ExporterConfig string             `json:"exporterConfig"`
	Version        string             `json:"version"`
	Replicas       int                `json:"replicas,omitempty"`
}

DatabaseObserverStatus defines the observed state of DatabaseObserver

func (*DatabaseObserverStatus) DeepCopy

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

func (*DatabaseObserverStatus) DeepCopyInto

func (in *DatabaseObserverStatus) DeepCopyInto(out *DatabaseObserverStatus)

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

type DeploymentPodTemplate

type DeploymentPodTemplate struct {
	SecurityContext *corev1.PodSecurityContext `json:"securityContext,omitempty"`
	Labels          map[string]string          `json:"labels,omitempty"`
}

DeploymentPodTemplate defines the labels for the DatabaseObserver pods component of a deployment

func (*DeploymentPodTemplate) DeepCopy

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

func (*DeploymentPodTemplate) DeepCopyInto

func (in *DeploymentPodTemplate) DeepCopyInto(out *DeploymentPodTemplate)

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

type LogConfig

type LogConfig struct {
	Path     string    `json:"path,omitempty"`
	Filename string    `json:"filename,omitempty"`
	Volume   LogVolume `json:"volume,omitempty"`
}

LogConfig defines the configuration details relation to the logs of DatabaseObserver

func (*LogConfig) DeepCopy

func (in *LogConfig) DeepCopy() *LogConfig

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

func (*LogConfig) DeepCopyInto

func (in *LogConfig) DeepCopyInto(out *LogConfig)

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

type LogVolume

type LogVolume struct {
	Name                  string           `json:"name,omitempty"`
	PersistentVolumeClaim LogVolumePVClaim `json:"persistentVolumeClaim,omitempty"`
}

func (*LogVolume) DeepCopy

func (in *LogVolume) DeepCopy() *LogVolume

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

func (*LogVolume) DeepCopyInto

func (in *LogVolume) DeepCopyInto(out *LogVolume)

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

type LogVolumePVClaim

type LogVolumePVClaim struct {
	ClaimName string `json:"claimName,omitempty"`
}

func (*LogVolumePVClaim) DeepCopy

func (in *LogVolumePVClaim) DeepCopy() *LogVolumePVClaim

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

func (*LogVolumePVClaim) DeepCopyInto

func (in *LogVolumePVClaim) DeepCopyInto(out *LogVolumePVClaim)

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

type OCIConfigSpec

type OCIConfigSpec struct {
	ConfigMapName string `json:"configMapName,omitempty"`
	SecretName    string `json:"secretName,omitempty"`
}

OCIConfigSpec defines the configmap name and secret name used for connecting to OCI

func (*OCIConfigSpec) DeepCopy

func (in *OCIConfigSpec) DeepCopy() *OCIConfigSpec

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

func (*OCIConfigSpec) DeepCopyInto

func (in *OCIConfigSpec) DeepCopyInto(out *OCIConfigSpec)

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

type PrometheusConfig

type PrometheusConfig struct {
	ServiceMonitor PrometheusServiceMonitor `json:"serviceMonitor,omitempty"`
}

PrometheusConfig defines the generated resources for Prometheus

func (*PrometheusConfig) DeepCopy

func (in *PrometheusConfig) DeepCopy() *PrometheusConfig

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

func (*PrometheusConfig) DeepCopyInto

func (in *PrometheusConfig) DeepCopyInto(out *PrometheusConfig)

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

type PrometheusServiceMonitor

type PrometheusServiceMonitor struct {
	Labels            map[string]string            `json:"labels,omitempty"`
	NamespaceSelector *monitorv1.NamespaceSelector `json:"namespaceSelector,omitempty"`
	Endpoints         []monitorv1.Endpoint         `json:"endpoints,omitempty"`
}

PrometheusServiceMonitor defines DatabaseObserver servicemonitor spec

func (*PrometheusServiceMonitor) DeepCopy

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

func (*PrometheusServiceMonitor) DeepCopyInto

func (in *PrometheusServiceMonitor) DeepCopyInto(out *PrometheusServiceMonitor)

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

type StatusEnum

type StatusEnum string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL