package
0.0.0-20240815173558-303cc3735024
Repository: https://github.com/libopenstorage/operator.git
Documentation: pkg.go.dev

# Functions

Resource takes an unqualified resource and returns a Group qualified GroupResource.

# Constants

AlwaysAutoUpdate always updates components if a new version is available.
ClusterConditionStatusCompleted means the cluster operation has completed.
ClusterConditionStatusDegraded means the component is degraded.
ClusterConditionStatusDisabled means the component is disabled.
ClusterConditionStatusError means the component has error.
ClusterConditionStatusFailed means the cluster operation failed.
ClusterConditionStatusInProgress means the cluster operation is in progress.
ClusterConditionStatusNotInQuorum means the component is out of quorum.
ClusterConditionStatusOffline means the component is offline.
ClusterConditionStatusOnline means the component is up and running.
ClusterConditionStatusPending means the cluster operation is pending.
ClusterConditionStatusReady means the component is ready.
ClusterConditionStatusTimeout means the cluster operation timed out.
ClusterConditionStatusUnknown means the component is not known.
ClusterConditionTypeDelete indicates the phase for a component delete operation on the cluster.
ClusterConditionTypeInstall indicates the phase for a component install operation on the cluster.
ClusterConditionTypeMigration indicates the phase for a component migration operation on the cluster.
ClusterConditionTypePreflight indicates the phase for component preflight check on the cluster.
ClusterConditionTypeRuntimeState indicates the runtime state of a component on the cluster.
ClusterConditionTypeUpdate indicates the phase for a component update operation on the cluster.
ClusterStateDegraded means the cluster is unhealthy.
ClusterStateInit means the cluster is initializing.
ClusterStateRunning means the cluster is healthy and running.
ClusterStateUninstall means the cluster is uninstalling.
ClusterStateUnknown means the cluster state is unknown.
GuestRoleDisabled disables all access for the guest role.
GuestRoleEnabled sets the guest role to the default volume lifecycle permissions.
GuestRoleManaged lets the admin manage the guest role.
NeverAutoUpdate does not automatically update components.
NodeDecommissionedStatus means the node condition is in decommissioned state.
NodeDegradedStatus means the node condition is in degraded state.
NodeFailedStatus means the node condition status is failed.
NodeInitCondition is used for initialization state of the node.
NodeInitStatus means the node condition is in initializing state.
NodeKVDBCondition is used for the KVDB condition on the node if it is part of an internal KVDB cluster.
NodeMaintenanceStatus means the node condition is in maintenance state.
NodeNotInQuorumStatus means the node is not in quorum.
NodeOfflineStatus means the node condition is in offline state.
NodeOnlineStatus means the node condition is online and healthy.
NodeStateCondition is used for overall state of the node.
NodeSucceededStatus means the node condition status is succeeded.
NodeUnknownStatus means the node condition is not known.
NodeUpdateStatus means the node condition is in updating state.
OnceAutoUpdate updates the version of a component only once.
OnDeleteStorageClusterStrategyType replace the old pods only when they are killed.
RollingUpdateStorageClusterStrategyType replace the old pods by new ones using rolling update i.e replace them on each node one after the other.
StorageClusterResourceName is name for "storagecluster" resource.
StorageClusterResourcePlural is plural for "storagecluster" resource.
StorageClusterShortName is the shortname for "storagecluster" resource.
StorageNodeResourceName is name for "storagenode" resource.
StorageNodeResourcePlural is plural for "storagenode" resource.
StorageNodeShortName is the shortname for "storagenode" resource.
UninstallAndWipeStorageClusterStrategyType will uninstall the storage service from all the nodes in the cluster.
UninstallStorageClusterStrategyType will only uninstall the storage service from all the nodes in the cluster.

# Variables

AddToScheme adds all the registered types to the scheme.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeGroupVersion is group version used to register these objects.

# Structs

AlertManagerSpec contains configuration of AlertManager.
AuthSpec lets the user define authorization (RBAC) configurations for creating a PX Security enabled cluster.
AutopilotSpec contains details of an autopilot component.
CertLocation specifies where portworx should pick up the certificate.
CheckResult captures result of a pre or post flight check.
CloudStorageCapacitySpec details the minimum and maximum amount of storage that will be provisioned in the cluster for a particular set of minimum IOPS.
CloudStorageCommon details of storage in cloud environment.
CloudStorageNodeSpec details of storage in cloud environment for node groups.
CloudStorageSpec details of storage in cloud environment for entire cluster.
ClusterCondition contains condition information for the cluster.
CommonConfig are common configurations that are exposed at both cluster and node level.
ComponentImages is a collection of all the images managed by the operator -note: please keep in sync w/ `manifest.Release` structure -WARN: the ComponentImages are annotated w/ `json:` while `manifest.Release` uses `yaml:`.
CSISpec is used to define the CSI configurations.
CSITopologySpec is used to define the CSI topology configurations.
DataProviderSpec contains the details for data providers for components like autopilot.
Disruption contains configuration for disruption.
Geography is topology information for a node.
GitOpsSpec contains the details for GitOps provider like github or bitbucket.
GrafanaSpec contains configuration of Grafana stack.
KvdbSpec contains the details to access kvdb.
Metadata contains metadata of StorageCluster components.
MonitoringSpec contains monitoring configuration for the storage cluster.
NetworkSpec contains network information.
NetworkStatus network status of the storage node.
Attributes of the storage node.
NodeCondition contains condition information for a storage node.
NodeSelector let's the user select a node or group of nodes based on either the NodeName or the node LabelSelector.
NodeSpec is the spec used to define node level configuration.
NodeStatus contains the status of the storage node.
PlacementSpec has placement configuration for the storage cluster nodes.
PrometheusSpec contains configuration of Prometheus stack.
PxRepoSpec contains apt repository configuration.
RollingUpdateStorageCluster controls the desired behavior of storage cluster rolling update.
SecretRef specifies which k8s secret portworx should pick up the certificate.
SecuritySpec is used to define the security configuration for a cluster.
SelfSignedSpec defines a configuration for self signed authentication.
Storage represents cluster storage details.
StorageCluster represents a storage cluster.
StorageClusterDeleteStrategy is used to control the delete strategy for a StorageCluster.
StorageClusterList is a list of StorageCluster.
StorageClusterSpec is the spec used to define a storage cluster.
StorageClusterStatus is the status of a storage cluster.
StorageClusterUpdateStrategy is used to control the update strategy for a StorageCluster.
StorageNode represents a storage node.
StorageNodeCloudDriveConfig is a structure for storing a configuration for a single drive.
StorageNodeCloudDriveConfigs specifies storage for the node in cloud environments.
StorageNodeList is a list of storage nodes.
StorageNodeSpec is the spec used to define a storage node.
StorageSpec details of storage used by the driver.
StorageStatus captures the storage status of the node.
StorkSpec contains STORK related spec.
TelemetrySpec contains details of a telemetry component.
TLSSpec is the spec used to define TLS configuration for a cluster.
UserInterfaceSpec contains details of a user interface for the storage driver.
VolumeSpec describes a volume that needs to be mounted inside a container.

# Type aliases

AutoUpdateComponentStrategyType is enum for auto updating storage cluster components.
ClusterConditionStatus is the enum type for cluster condition statuses.
ClusterConditionType is the enum type for different cluster conditions, reflecting phases of different components.
ClusterState is the enum type for cluster state indicated using phase field.
GuestAccessType lets the user choose the level of permissions the system.user has.
NodeConditionStatus is the enum type for node condition statuses.
NodeConditionType is the enum type for different node conditions.
StorageClusterDeleteStrategyType is enum for storage cluster delete strategies.
StorageClusterUpdateStrategyType is enum for storage cluster update strategies.