CanAccessArcusRegisterEndpoint checks if telemetry registration endpoint is reachable return true immediately if it can reach to Arcus return false after failing 5 times in a row.

DeregisterAllComponents removes all registered components from the list.

Get returns a PortworxComponent if present else returns (nil, false).

GetAll returns all the Portworx components that are registered.

GetDesiredTelemetryImage returns desired telemetry container image.

NewError creates a new custom component Error instance.

Register registers a PortworxComponent and stores in the global map of components.

RegisterAlertManagerComponent registers the AlertManager component.

RegisterAuthComponent registers the auth component.

RegisterAutopilotComponent registers the Autopilot component.

RegisterCSIComponent registers the CSI component.

RegisterDisruptionBudgetComponent registers the Portworx DisruptionBudget component.

RegisterMonitoringComponent registers the Monitoring component.

RegisterLighthouseComponent registers the Lighthouse component.

RegisterMonitoringComponent registers the Monitoring component.

RegisterPortworxAPIComponent registers the Portworx API component.

RegisterPortworxBasicComponent registers the Portworx Basic component.

RegisterPortworxCRDComponent registers the Portworx CRD component.

RegisterPortworxPluginComponent registers the PortworxPlugin component.

RegisterPortworxProxyComponent registers the Portworx proxy component.

RegisterPortworxStorageClassComponent registers the Portworx StorageClass component.

RegisterPrometheusComponent registers the Prometheus component.

RegisterPSPComponent registers a component for installing podsecuritypolicies.

RegisterPVCControllerComponent registers the PVC Controller component.

RegisterPxRepoComponent registers the PxRepo component.

RegisterSCCComponent registers a component for installing scc.

RegisterTelemetryComponent registers the telemetry component.

RegisterTLSComponent registers the TLS component.

RegisterPortworxPluginComponent registers the PortworxPlugin component.

Set the path of k8s cluster root certificate for the purpose of testing.

AlertManagerComponentName name of the AlertManager component.

AlertManagerConfigSecretName name of the secret containing alert manager config.

AlertManagerInstanceName name of the alert manager instance.

AlertManagerServiceName name of the alert manager service.

AnnotationSkipResource stork annotation to skip a resource from a backup.

AuthComponentName is the name for registering this component.

AuthSystemGuestRoleName is the role name to maintain for the guest role.

AuthTokenBufferLength is the time ahead of the token expiration that we will start refreshing the token.

AutopilotClusterRoleBindingName name of the autopilot cluster role binding.

AutopilotClusterRoleName name of the autopilot cluster role.

AutopilotComponentName name of the Autopilot component.

AutopilotConfigMapName name of the autopilot config map.

AutopilotContainerName name of the autopilot container.

AutopilotDefaultProviderEndpoint endpoint of default provider.

AutopilotDefaultReviewersKey is a key for default reviewers array in gitops config map.

AutopilotDeploymentName name of the autopilot deployment.

Autopilot Secret name for prometheus-user-workload-token.

AutopilotServiceAccountName name of the autopilot service account.

ClusterRoleBindingNameTelemetry is name of telemetry cluster role binding.

ClusterRoleNameTelemetry is name of telemetry cluster role.

CollectorClusterRoleBindingName name of the metrics collector cluster role binding.

CollectorClusterRoleName name of the metrics collector cluster role.

CollectorConfigFileName is file name of the collector pod config.

CollectorConfigMapName is name of config map for metrics collector.

CollectorDeploymentName is name of metrics collector deployment.

CollectorProxyConfigFileName is file name of envoy config.

CollectorProxyConfigMapName is name of the config map for envoy proxy.

CollectorRoleBindingName is name of the role binding for metrics collector.

CollectorRoleName is name of the Role for metrics collector.

CollectorServiceAccountName is name of the metrics collector service account.

ConfigMapNameTelemetryCollectorProxyV2 is name of config map for metrics collector proxy.

ConfigMapNameTelemetryCollectorV2 is name of config map for metrics collector.

ConfigMapNameTelemetryPhonehome is name of config map for phonehome.

ConfigMapNameTelemetryPhonehomeProxy is name of config map for phonehome proxy.

ConfigMapNameTelemetryRegister is name of config map for registration.

ConfigMapNameTelemetryRegisterProxy is name of config map for registration proxy.

ConfigMapNameTelemetryTLSCertificate is name of config map tls-certificate.

CSIApplicationName name of the CSI application (deployment/statefulset).

CSIClusterRoleBindingName name of the CSI cluster role binding.

CSIClusterRoleName name of the CSI cluster role.

CSIComponentName name of the CSI component.

CSIServiceAccountName name of the CSI service account.

CSIServiceName name of the CSI service.

CustomPVCControllerInsecurePort is the PVC controller port and health check port, due to the default port is already used, we use different port.

CustomPVCControllerSecurePort is the PVC controller secure port.

DaemonSetNameTelemetryPhonehome is name of phonehome daemonset.

DefaultComponentPriority default priority for Portworx components.

DefaultKVDBClusterSize is the default size of internal KVDB cluster.

DeploymentNameTelemetryCollectorV2 is name of telemetry metrics collector.

DeploymentNameTelemetryRegistration is name of telemetry registration deployment.

DisruptionBudgetComponentName name of the DisruptionBudget component.

EnvKeyLhConfigSyncImage env variable name used to override the default config-sync container image.

EnvKeyLhStorkConnectorImage env variable name used to override the default stork-connector container image.

ErrCritical code for a critical error.

GrafanaComponentName is the name for identifying the grafana component.

GrafanaContainerName is the name for the grafana container.

GrafanaDeploymentName is the name for the operator managed grafana.

KVDBPodDisruptionBudgetName name of the PodDisruptionBudget for portworx kvdb pods.

LhClusterRoleBindingName name of the Lighthouse cluster role binding.

LhClusterRoleName name of the Lighthouse cluster role.

LhConfigInitContainerName name of the config-init container.

LhConfigSyncContainerName name of the config-sync container.

LhContainerName name of the Lighthouse container.

LhDeploymentName name of the Lighthouse deployment.

LhServiceAccountName name of the Lighthouse service account.

LhServiceName name of the Lighthouse service.

LhStorkConnectorContainerName name of the stork-connector container.

LighthouseComponentName name of the Lighthouse component.

MonitoringComponentName name of the Monitoring component.

OCPPrometheusUserWorkloadSecretPrefix name of OCP user-workload Prometheus secret for OCP < 4.15.

OCPThanosRulerSecretPrefix name of OCP thanos-ruler secret for OCP 4.15+.

PortworxAPIComponentName name of the Portworx API component.

PortworxBasicComponentName name of the Portworx Basic component.

PortworxCRDComponentName name of the Portworx CRDs component.

PortworxProxyComponentName name of the Portworx Proxy component.

PortworxStorageClassComponentName name of the Portworx StorageClass component.

PrometheusClusterRoleBindingName name of the prometheus cluster role binding.

PrometheusClusterRoleName name of the prometheus cluster role.

PrometheusComponentName name of the Prometheus component.

PrometheusInstanceName name of the prometheus instance.

PrometheusOperatorClusterRoleBindingName name of the prometheus operator cluster role binding.

PrometheusOperatorClusterRoleName name of the prometheus operator cluster role.

PrometheusOperatorDeploymentName name of the prometheus operator deployment.

PrometheusOperatorServiceAccountName name of the prometheus operator service account.

PrometheusServiceAccountName name of the prometheus service account.

PrometheusServiceName name of the prometheus service.

PSPComponentName name a component for installing podsecuritypolicies.

PVCClusterRoleBindingName name of the PVC controller cluster role binding.

PVCClusterRoleName name of the PVC controller cluster role.

PVCControllerComponentName name of the PVC controller component.

PVCDeploymentName name of the PVC controller deployment.

PVCServiceAccountName name of the PVC controller service account.

PxAPIDaemonSetName name of the Portworx API daemon set.

PxAPIServiceName name of the Portworx API service.

PxBackupServiceMonitor name of the px backup service monitor.

PxClusterRoleBindingName name of the Portworx cluster role binding.

PxClusterRoleName name of the Portworx cluster role.

PxDbCloudSnapshotCSIStorageClass name of the CSI storage class for cloud snapshots.

PxDbCloudSnapshotEncryptedCSIStorageClass name of the CSI storage class for cloud snapshots with encryption enabled.

PxDbCloudSnapshotEncryptedStorageClass name of the storage class for cloud snapshots with encryption enabled.

PxDbCloudSnapshotStorageClass name of the storage class for cloud snapshots.

PxDbCSIStorageClass name of the CSI storage class for DB workloads.

PxDbEncryptedCSIStorageClass name of the CSI storage class for encrypted DB workloads.

PxDbEncryptedStorageClass name of the storage class for encrypted DB workloads.

PxDbLocalSnapshotCSIStorageClass name of the CSI storage class for local snapshots.

PxDbLocalSnapshotEncryptedCSIStorageClass name of the CSI storage class for local snapshots with encryption enabled.

PxDbLocalSnapshotEncryptedStorageClass name of the storage class for local snapshots with encryption enabled.

PxDbLocalSnapshotStorageClass name of the storage class for local snapshots.

PxDbStorageClass name of the storage class for DB workloads.

PxNodeWiperServiceAccountName name of portworx node wiper service account.

PxPrometheusRule name of the prometheus rule object for Portworx.

PxProxyClusterRoleBindingName name of the Portworx proxy cluster role binding.

PxProxyDaemonSetName name of the Portworx proxy daemon set.

PxProxyServiceAccountName name of the Portworx proxy service account.

PxReplicatedCSIStorageClass name of the replicated CSI storage class.

PxReplicatedEncryptedCSIStorageClass name of the replicated CSI storage class with encryption enabled.

PxReplicatedEncryptedStorageClass name of the replicated storage class with encryption enabled.

PxReplicatedStorageClass name of the replicated storage class.

PxRepoComponentName is name of the component.

PxRepoDeploymentName is name of px repo deployment.

PxRepoServiceName is name of the px repo service.

PxRestrictedSCCName name of portworx-restricted securityContextConstraints.

PxRoleBindingName name of the Portworx role binding.

PxRoleName name of the Portworx role.

PxSaTokenRefreshTimeKey time to refresh the service account token.

PxSCCName name of portworx securityContextConstraints.

PxServiceMonitor name of the Portworx service monitor.

RoleBindingNameTelemetry is name of telemetry role binding.

RoleNameTelemetry is name of telemetry role.

SCCComponentName name a component for installing securityContextConstraints.

ServiceAccountNameTelemetry is name of telemetry service account.

StoragePodDisruptionBudgetName name of the PodDisruptionBudget for portworx storage pods.

SupportedRootFolderForTLSCerts is where all TLS cert files need to be placed (or in a subfolder).

TelemetryArcusLocationFilename is name of the file storing the location of arcus endpoint to use.

TelemetryCCMProxyConfigMapName is the name of the config map that stores the PX_HTTP(S)_PROXY env var.

TelemetryCCMProxyFileName name of the http proxy file.

TelemetryCCMProxyFilePath path of the http proxy file.

TelemetryCertName is name of the telemetry cert.

TelemetryComponentName name of the telemetry component.

TelemetryConfigMapName is the name of the config map that stores the telemetry configuration for CCM.

TelemetryPropertiesFilename is the name of the CCM properties file.

TLSComponentName is the name for registering this component.

GuestRoleDisabled is the disabled configuration for the guest role.

GuestRoleEnabled is the default configuration for the guest role.

Error error returned for component operations.

PortworxComponent interface that any Portworx component should be implement.

Code is the error code for errors in component lifecycle.