package
0.0.0-20250205134457-ada76d566b7b
Repository: https://github.com/splunk/splunk-operator.git
Documentation: pkg.go.dev
# Constants
AfwPhase2 represents Phase-2 app framework.
AfwPhase3 represents Phase-3 app framework.
APIVersion is a string representation of this API.
AppPkgDownloadComplete indicates complete.
AppPkgDownloadError indicates error after retries.
AppPkgDownloadInProgress indicates in progress.
AppPkgDownloadPending indicates pending.
AppPkgInstallComplete indicates complete.
AppPkgInstallError indicates error after retries.
AppPkgInstallInProgress indicates in progress.
AppPkgInstallPending indicates pending.
AppPkgMissingFromOperator indicates the downloaded app package is missing.
AppPkgMissingOnPodError indicates app pkg is not available on Pod for install.
AppPkgPodCopyComplete indicates complete.
AppPkgPodCopyError indicates error after retries.
AppPkgPodCopyInProgress indicates in progress.
AppPkgPodCopyPending indicates pending.
BundlePushComplete bundle push completed.
BundlePushInProgress indicates bundle push in progress.
BundlePushPending waiting for all the apps to be copied to the Pod.
BundlePushUninitialized indicates bundle push never happend.
ClusterManagerPausedAnnotation is the annotation that pauses the reconciliation (triggers an immediate requeue).
App is update is complete on the Pod.
Failed to update the App on the Pod.
App update on the Pod is in progressToDo: Mostly transient state for Phase-2, more of Phase-3 status.
Indicates there is a change on remote store, but yet to start propagating that to the Pod.
IndexerClusterPausedAnnotation is the annotation that pauses the reconciliation (triggers an immediate requeue).
LatestAfwVersion represents latest App framework version.
LicenseManagerPausedAnnotation is the annotation that pauses the reconciliation (triggers an immediate requeue).
MonitoringConsolePausedAnnotation is the annotation that pauses the reconciliation (triggers an immediate requeue).
PhaseDownload identifies download phase.
PhaseError means an error occured with custom resource management.
PhaseInstall identifies install phase for local scoped apps.
PhasePending means a custom resource has just been created and is not yet ready.
PhasePodCopy identifies pod copy phase.
PhaseReady means a custom resource is ready and up to date.
PhaseScalingDown means a custom resource is in the process of scaling down.
PhaseScalingUp means a custom resource is in the process of scaling up.
PhaseTerminating means a custom resource is in the process of being removed.
PhaseUpdating means a custom resource is in the process of updating to a new desired state (spec).
Values to represent the properties for the scope premiumApps.
Values to represent the App Repo status.
Values to represent the App Repo status.
Values to represent the App Repo status.
Values to represent the App Source scope.
Values to represent the App Source scope.
Values to represent the App Source scope.
Values to represent the App Source scope.
SearchHeadClusterPausedAnnotation is the annotation that pauses the reconciliation (triggers an immediate requeue).
Values to represent the defaults of enterprise security app.
Values to represent the defaults of enterprise security app.
Values to represent the defaults of enterprise security app.
StandalonePausedAnnotation is the annotation that pauses the reconciliation (triggers an immediate requeue).
StatefulSetNotScaling indicates sts is not scaling.
StatefulSetScalingDown indicates sts is scaling down.
StatefulSetScalingUp indicates sts is scaling up.
TotalWorker concurrent workers to reconcile.
# Variables
AddToScheme adds the types in this group-version to the given scheme.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
# Structs
AppDeploymentContext for storing the Apps deployment information.
AppDeploymentInfo represents a single App deployment information.
AppFrameworkSpec defines the application package remote store repository.
AppSourceDefaultSpec defines config common for defaults and App Sources.
AppSourceSpec defines list of App package (*.spl, *.tgz) locations on remote volumes.
AppSrcDeployInfo represents deployment info for list of Apps.
BundlePushInfo Indicates if bundle push required.
BundlePushTracker used to track the bundle push status.
CacheManagerSpec defines cachemanager specific configuration.
ClusterManager is the Schema for the cluster manager API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=clustermanagers,scope=Namespaced,shortName=cmanager-idxc +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Phase of the cluster manager" +kubebuilder:printcolumn:name="Manager",type="string",JSONPath=".status.clusterManagerPhase",description="Status of cluster manager" +kubebuilder:printcolumn:name="Desired",type="integer",JSONPath=".status.replicas",description="Desired number of indexer peers" +kubebuilder:printcolumn:name="Ready",type="integer",JSONPath=".status.readyReplicas",description="Current number of ready indexer peers" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Age of cluster manager" +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.message",description="Auxillary message describing CR status" +kubebuilder:storageversion.
ClusterManagerList contains a list of ClusterManager.
ClusterManagerSpec defines the desired state of ClusterManager.
ClusterManagerStatus defines the observed state of ClusterManager.
CommonSplunkSpec defines the desired state of parameters that are common across all Splunk Enterprise CRD types.
EsDefaults captures defaults for the Enterprise Security App.
IndexAndCacheManagerCommonSpec defines configurations that can be configured at index level or at server level.
IndexAndGlobalCommonSpec defines configurations that can be configured at index level or at global level.
IndexConfDefaultsSpec defines Splunk indexes.conf global/defaults.
IndexerCluster is the Schema for a Splunk Enterprise indexer cluster +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector +kubebuilder:resource:path=indexerclusters,scope=Namespaced,shortName=idc;idxc +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Status of indexer cluster" +kubebuilder:printcolumn:name="Master",type="string",JSONPath=".status.clusterMasterPhase",description="Status of cluster master" +kubebuilder:printcolumn:name="Manager",type="string",JSONPath=".status.clusterManagerPhase",description="Status of cluster manager" +kubebuilder:printcolumn:name="Desired",type="integer",JSONPath=".status.replicas",description="Desired number of indexer peers" +kubebuilder:printcolumn:name="Ready",type="integer",JSONPath=".status.readyReplicas",description="Current number of ready indexer peers" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Age of indexer cluster" +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.message",description="Auxillary message describing CR status" +kubebuilder:storageversion.
IndexerClusterList contains a list of IndexerCluster.
IndexerClusterMemberStatus is used to track the status of each indexer cluster peer.
IndexerClusterSpec defines the desired state of a Splunk Enterprise indexer cluster.
IndexerClusterStatus defines the observed state of a Splunk Enterprise indexer cluster.
IndexSpec defines Splunk index name and storage path.
LicenseManager is the Schema for a Splunk Enterprise license manager.
LicenseManagerList contains a list of LicenseManager.
LicenseManagerSpec defines the desired state of a Splunk Enterprise license manager.
LicenseManagerStatus defines the observed state of a Splunk Enterprise license manager.
MonitoringConsole is the Schema for the monitoringconsole API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=monitoringconsoles,scope=Namespaced,shortName=mc +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Status of monitoring console" +kubebuilder:printcolumn:name="Desired",type="integer",JSONPath=".status.replicas",description="Desired number of monitoring console members" +kubebuilder:printcolumn:name="Ready",type="integer",JSONPath=".status.readyReplicas",description="Current number of ready monitoring console members" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Age of monitoring console" +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.message",description="Auxillary message describing CR status" +kubebuilder:storageversion.
MonitoringConsoleList contains a list of MonitoringConsole.
MonitoringConsoleSpec defines the desired state of MonitoringConsole.
MonitoringConsoleStatus defines the observed state of MonitoringConsole.
PhaseInfo defines the status to track the App framework installation phase.
PremiumAppsProps represents properties for premium apps such as ES.
Probe defines set of configurable values for Startup, Readiness, and Liveness probes.
SearchHeadCluster is the Schema for a Splunk Enterprise search head cluster +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector +kubebuilder:resource:path=searchheadclusters,scope=Namespaced,shortName=shc +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Status of search head cluster" +kubebuilder:printcolumn:name="Deployer",type="string",JSONPath=".status.deployerPhase",description="Status of the deployer" +kubebuilder:printcolumn:name="Desired",type="integer",JSONPath=".status.replicas",description="Desired number of search head cluster members" +kubebuilder:printcolumn:name="Ready",type="integer",JSONPath=".status.readyReplicas",description="Current number of ready search head cluster members" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Age of search head cluster" +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.message",description="Auxillary message describing CR status" +kubebuilder:storageversion.
SearchHeadClusterList contains a list of SearchHeadCluster.
SearchHeadClusterMemberStatus is used to track the status of each search head cluster member.
SearchHeadClusterSpec defines the desired state of a Splunk Enterprise search head cluster.
SearchHeadClusterStatus defines the observed state of a Splunk Enterprise search head cluster.
SmartStoreSpec defines Splunk indexes and remote storage volume configuration.
Spec defines a subset of the desired state of parameters that are common across all CRD types.
Standalone is the Schema for a Splunk Enterprise standalone instances.
StandaloneList contains a list of Standalone.
StandaloneSpec defines the desired state of a Splunk Enterprise standalone instances.
StandaloneStatus defines the observed state of a Splunk Enterprise standalone instances.
StorageClassSpec defines storage class configuration.
VolumeAndTypeSpec used to add any custom varaibles for volume implementation.
VolumeSpec defines remote volume config.
# Type aliases
AppDeploymentStatus represents the status of an App on the Pod.
AppPhaseStatusType defines the Phase status.
AppPhaseType defines the App Phase.
AppRepoState represent the App state on remote store.
BundlePushStageType represents the bundle push status.
Phase is used to represent the current phase of a custom resource +kubebuilder:validation:Enum=Pending;Ready;Updating;ScalingUp;ScalingDown;Terminating;Error.
StatefulSetScalingType determines if the statefulset is scaling up/down.