package
3.4.3+incompatible
Repository: https://github.com/oracle/coherence-operator.git
Documentation: pkg.go.dev

# Functions

AddEnvVarIfAbsent adds the specified EnvVar to the destination slice if one with the same name does not already exist.
BoolPtrToString converts a bool pointer to a string.
ComputeHash returns a hash value calculated from Coherence spec and The hash will be safe encoded to avoid bad words.
No description provided by the author
EnsureContainer ensures that the StatefulSet has a container with the specified name.
EnsureContainerInPod ensures that the Pod has a container with the specified name.
EnsureCRDs ensures that the Operator configuration secret exists in the namespace.
No description provided by the author
EnsureV1CRDs ensures that the Operator configuration secret exists in the namespace.
FindContainer finds the StatefulSet container with the specified name.
FindContainerForJob finds the Job container with the specified name.
FindContainerInPodTemplate finds the Job container with the specified name.
FindInitContainer finds the StatefulSet init-container with the specified name.
FindInitContainerInJob finds the Job init-container with the specified name.
FindInitContainerInPodTemplate finds the PodTemplateSpec init-container with the specified name.
Int32PtrToString converts an int32 pointer to a string.
Int32PtrToStringWithDefault converts an int32 pointer to a string using the default if the pointer is nil.
Int32ToString converts an int32 to a string.
NewConditions initializes a set of conditions with the given list of conditions.
ReplaceContainer ensures that the StatefulSet has a container with the specified name.
ReplaceContainerInPod ensures that the Pod has a container with the specified name.
ReplaceVolume ensures that the StatefulSet has a volume with the specified name.
ReplaceVolume ensures that the StatefulSet has a volume with the specified name.
SetCommonDefaults sets defaults common to both a Job and StatefulSet.
No description provided by the author
ValidateJobUpdate tests if required fields in the Job are set.
ValidateStatefulSetUpdate tests if required fields in the StatefulSet are set.

# Constants

AnnotationFeatureSuspend is the feature annotations.
AnnotationIstioConfig is the Istio config annotation applied to Pods.
AnnotationOperatorVersion is the Operator version annotations.
AppProtocolHttp is the appProtocol value for ports that use http.
AppProtocolTcp is the appProtocol value for ports that use tcp.
CoherenceFinalizer is the name of the finalizer that the Operator adds to Coherence deployments.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
Coherence resource Condition Types The different eight types of state that a deployment may be in.
ContainerNameCoherence is the Coherence container name.
ContainerNameOperatorInit is the Operator init-container name.
DefaultClusterPort is the default Coherence cluster port.
DefaultCnbpLauncher is the Cloud Native Build Pack launcher executable.
DefaultDebugPort is the default debug port.
DefaultHealthPort is the default health port.
DefaultIstioConfigAnnotationValue is the default for the istio config annotation.
DefaultJobReplicas is the default number of replicas that will be created for a Job deployment if no value is specified in the spec.
DefaultLivenessPath is the default liveness endpoint path.
DefaultManagementPort is the Coherence manaement debug port.
DefaultMetricsPort is the default Coherence metrics port.
DefaultReadinessPath is the default readiness endpoint path.
DefaultReplicas is the default number of replicas that will be created for a deployment if no value is specified in the spec.
DefaultServiceAccount is the default k8s service account name.
DefaultUnicastPort is the default Coherence unicast port.
DefaultUnicastPortAdjust is the default Coherence unicast port adjust value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HeadlessServiceNameSuffix is the suffix appended to a deployment name to give the StatefulSet headless-service name.
JobMutatingWebHookPath This const MUST match the path in the kubebuilder annotation above.
JobValidatingWebHookPath This const MUST match the path in the kubebuilder annotation above.
LabelApp is an optional application label that can be applied to resources.
LabelCoherenceCluster is the label containing the Coherence cluster name.
LabelCoherenceDeployment is the label containing the name of the owning Coherence resource.
LabelCoherenceHash is the label for the Coherence resource spec hash.
LabelCoherenceRole is the label containing a Coherence role name.
LabelCoherenceStore is the component label value for a Coherence state storage Secret.
LabelCoherenceWKAMember is the label applied to WKA members.
LabelComponent is the label containing a component name.
LabelComponentCoherenceHeadless is the component label value for a Coherence StatefulSet headless Service resource.
LabelComponentCoherencePod is the component label value for a Coherence Pod.
LabelComponentCoherenceStatefulSet is the component label value for a Coherence StatefulSet resource.
LabelComponentPortService is the component label value for a Coherence Service.
LabelComponentPortServiceMonitor is the component label value for a Coherence ServiceMonitor.
LabelComponentPVC is the component label value for Coherence PersistentVolumeClaim.
LabelComponentWKA is the component label value for a Coherence WKA Service.
LabelPort is the label associated to an exposed port name.
LabelVersion is the label containing a resource version.
MutatingWebHookPath This const MUST match the path in the kubebuilder annotation above.
OperatorConfigKeyHost is the key used in the Operator configuration Secret.
OperatorConfigName is the Operator configuration Secret name.
OperatorRackURL is the default Operator rack query URL.
OperatorSiteURL is the default Operator site query URL.
ParallelScaling means that a deployment will be scaled up or down by adding or removing members in parallel.
ParallelUpSafeDownScaling means that a deployment will be scaled up by adding or removing members in parallel but will be scaled down in a safe manner to ensure no data loss.
PortNameCoherence is the name of the Coherence port.
PortNameCoherenceCluster is the name of the Coherence cluster port.
PortNameCoherenceLocal is the name of the Coherence local port.
PortNameDebug is the name of the debug port.
PortNameHealth is the name of the health port.
PortNameMetrics is the name of the Coherence management port.
PortNameMetrics is the name of the Coherence metrics port.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RunnerCommand is the start command for the runner.
RunnerInit is the command line argument for the Operator init-container.
RunnerInitCommand is the start command for the Operator init-container.
SafeScaling means that a deployment will be scaled up or down in a safe manner to ensure no data loss.
ServiceMonitorGroup is the Prometheus ServiceMonitor resource API Group.
ServiceMonitorGroupVersion is the Prometheus ServiceMonitor resource API group version.
ServiceMonitorKind is the Prometheus ServiceMonitor resource API Kind.
ServiceMonitorVersion is the Prometheus ServiceMonitor resource API version.
StatusSelectorTemplate is the string template for a WKA service selector.
UpgradeByNode indicates that updates will be applied to all Pods on a Node at the same time.
UpgradeByNodeLabel indicates that updates will be applied to all Pods on a Node with the same label value at the same time.
UpgradeByPod indicates that updates will be applied to all Pods in the StatefulSet with respect to the StatefulSet ordering constraints one Pod at a time.
UpgradeManual is equivalent to using "OnDelete" as a StatefulSet upgrade strategy.
ValidatingWebHookPath This const MUST match the path in the kubebuilder annotation above.
VolumeMountPathJVM is the JVM diagnostics volume mount.
VolumeMountPathManagementCerts is the management certs volume mount.
VolumeMountPathMetricsCerts is the metrics certs volume mount.
VolumeMountPathPersistence is the persistence volume mount.
VolumeMountPathSnapshots is the snapshot's volume mount.
VolumeMountPathUtils is the utils volume mount.
VolumeMountRoot is the root path for volume mounts.
VolumeNameJVM is the name of the JVM diagnostics volume.
VolumeNameManagementSSL is the name of the management TLS volume.
VolumeNameMetricsSSL is the name of the metrics TLS volume.
VolumeNamePersistence is the name of the persistence volume.
VolumeNameSnapshots is the name of the snapshots volume.
VolumeNameUtils is the name of the utils volume.
VolumePathAttributes is the container attributes file volume.
WKAServiceNameSuffix is the suffix appended to a deployment name to give the WKA service name.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
AffinityTopologyKey is the affinity topology key for fault domains.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.

# Structs

Action is an action to execute when the StatefulSet becomes ready.
No description provided by the author
ApplicationSpec is the specification of the application deployed into the Coherence.
CloudNativeBuildPackSpec is the configuration when using a Cloud Native Buildpack Image.
Coherence is the top level schema for the Coherence API and custom resource definition (CRD).
CoherenceJob is the top level schema for the CoherenceJob API and custom resource definition (CRD) for configuring Coherence Job workloads.
CoherenceJobList is a list of CoherenceJob resources.
No description provided by the author
No description provided by the author
CoherenceJobResourceSpec defines the specification of a CoherenceJob resource.
No description provided by the author
CoherenceList is a list of Coherence resources.
CoherenceResourceSpec defines the specification of a Coherence resource.
CoherenceResourceStatus defines the observed state of Coherence resource.
CoherenceSpec is the section of the CRD configures settings specific to Coherence.
CoherenceStatefulSetResourceSpec defines the specification of a Coherence resource.
CoherenceTracingSpec configures Coherence tracing.
CoherenceWKASpec configures Coherence well-known-addressing to use an existing Coherence deployment for WKA.
No description provided by the author
Condition represents an observation of an object's state.
ConfigMapVolumeSpec represents a ConfigMap that will be added to the deployment's Pods as an additional Volume and as a VolumeMount in the containers.
GlobalSpec is attributes that will be applied to all resources managed by the Operator.
ImageSpec defines the settings for a Docker image +k8s:openapi-gen=true.
JvmDebugSpec the JVM Debug specific configuration.
JvmGarbageCollectorSpec is options for managing the JVM garbage collector.
JvmMemorySpec is options for managing the JVM memory.
JvmOutOfMemorySpec is options for managing the JVM behaviour when an OutOfMemoryError occurs.
JVMSpec is the JVM configuration.
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
NamedPortSpec defines a named port for a Coherence component +k8s:openapi-gen=true.
NetworkSpec configures various networking and DNS settings for Pods in a deployment.
PersistenceSpec is the spec for Coherence persistence.
PersistentStorageSpec defines the persistence settings for the Coherence +k8s:openapi-gen=true.
PersistentVolumeClaim is a request for and claim to a persistent volume +k8s:openapi-gen=true.
PersistentVolumeClaimObjectMeta is metadata for the PersistentVolumeClaim.
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
PortSpecWithSSL defines a port with SSL settings for a Coherence component +k8s:openapi-gen=true.
Probe is the handler that will be used to determine how to communicate with a Coherence deployment for operations like StatusHA checking and service suspension.
ProbeHandler is the definition of a probe handler.
ReadinessProbeSpec defines the settings for the Coherence Pod readiness probe +k8s:openapi-gen=true.
Resource is a structure holding a resource to be managed +k8s:deepcopy-gen=false.
Resources is a cloolection of resources to be managed.
ScalingSpec is the configuration to control safe scaling.
SecretVolumeSpec represents a Secret that will be added to the deployment's Pods as an additional Volume and as a VolumeMount in the containers.
ServiceMonitorSpec the ServiceMonitor spec for a port service.
ServiceSpec defines the settings for a Service +k8s:openapi-gen=true.
SSLSpec defines the SSL settings for a Coherence component over REST endpoint.
StartQuorum defines the order that deployments will be started in a Coherence cluster made up of multiple deployments.
StartQuorumStatus tracks the state of a deployment's start quorums.

# Interfaces

CoherenceResource is a common interface implemented by different coherence resources.

# Type aliases

No description provided by the author
ConditionReason is intended to be a one-word, CamelCase representation of the category of cause of the current status.
Conditions is a set of Condition instances.
ConditionType is the type of the condition and is typically a CamelCased word or short phrase.
No description provided by the author
RollingUpdateStrategyType is a string enumeration type that enumerates all possible rolling update strategies.
ScalingPolicy describes a policy for scaling a cluster deployment.