package
0.40.0
Repository: https://github.com/projectsveltos/libsveltos.git
Documentation: pkg.go.dev

# Functions

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
GetReloaderReportAnnotations returns the annotation to add to ReloaderReport kind, namespace, name identify mounted resource (ConfigMap or Secret) which was modified causing a reload.
No description provided by the author
mountedResourcekind is the kind of the resource being mounted as volume (either ConfigMap or Secret) mountedResourceNamespace/mountedResourceName is the namespace/name of the resource being mounted as volume clusterName and clusterType identify the managed cluster.

# Constants

No description provided by the author
No description provided by the author
AccessRequestNameLabel is added to each Secret generated for an AccessRequest.
ClassifierFinalizer allows ClassifierReconciler to clean up resources associated with Classifier before removing it from the apiserver.
No description provided by the author
ClassifierNameLabel is added to each ClassifierReport generated for a Classifier instance.
ClassifierReportClusterNameLabel is added to each ClassifierReport.
ClassifierReportClusterTypeLabel is added to each ClassifierReport.
No description provided by the author
This is the namespace/name of the secret containing the kubeconfig to send ClassifierReport to management cluster when classifier agent is configured to send ClassifierReports.
No description provided by the author
ClusterHealthCheckFinalizer allows ClusterHealthCheckReconciler to clean up resources associated with ClusterHealthCheck before removing it from the apiserver.
No description provided by the author
ClusterProfileSecretType is the only accepted type of secret in resources.
ClusterSetFinalizer allows ClusterSetReconciler to clean up resources associated with ClusterSet before removing it from the apiserver.
No description provided by the author
ClusterSummaryNameLabel is added to all ResourceSummary instances.
ClusterSummaryNamespaceLabel is added to all ResourceSummary instances.
ClusterSummaryTypeLabel is added to all ResourceSummary instances.
ClusterTypeCapi indicates type is CAPI Cluster.
ClusterTypeSveltos indicates type is Sveltos Cluster.
Define the Action constants.
Define the Action constants.
Define the Action constants.
Define the Action constants.
Define the Action constants.
Define the Action constants.
ComponentAccessManager is the access-manager pod.
ComponentAddonManager is the addon-manager pod.
Classifier is the classifier pod.
ClassifierAgent is the classifier agent pod.
ComponentDriftDetectionManager is the drift-detection-manager pod.
ComponentEventManager is the event-manager pod.
ComponentHealthCheckManager is the healthcheck-manager pod.
ComponentShardController is the shard-controller pod.
ComponentSveltosClusterManager is the sveltoscluster-manager pod.
ComponentUIBackend is the ui backend pod.
ConditionSeverityError specifies that a condition with `Status=False` is an error.
ConditionSeverityInfo specifies that a condition with `Status=False` is informative.
ConditionSeverityNone should apply only to conditions with `Status=True`.
ConditionSeverityWarning specifies that a condition with `Status=False` is a warning.
Define the ReferencedResourceKind constants.
ConnectionDown indicates connection from management cluster to managed cluster is down.
ConnectionHealthy indicates connection from management cluster to managed cluster is healthy.
No description provided by the author
DeployedBySveltosAnnotation is an annotation Sveltos adds to EventSource/HealthCheck/Classifier/ResourceSummary instances deployed by sveltos in managed clusters.
Discord constant To have Sveltos sends a Discord notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set both discord token and discord server ID.
Discord constant To have Sveltos sends a Discord notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set both discord token and discord server ID.
EventReportClusterNameLabel is added to each EventReport.
EventReportClusterTypeLabel is added to each EventReport.
EventReportFinalizer allows EventReportReconciler to clean up resources associated with EventReport before removing it from the apiserver.
No description provided by the author
EventSourceFinalizer allows EventSourceReconciler to clean up resources associated with EventSource before removing it from the apiserver.
No description provided by the author
EventSourceNameLabel is added to each EventReport generated for a EventSource instance.
No description provided by the author
No description provided by the author
No description provided by the author
HealthCheckFinalizer allows HealthReconciler to clean up resources associated with HealthCheck before removing it from the apiserver.
No description provided by the author
HealthCheckNameLabel is added to each HealthCheckReport generated for a HealthCheck instance.
HealthCheckReportClusterNameLabel is added to each HealthCheckReport.
HealthCheckReportClusterTypeLabel is added to each HealthCheckReport.
HealthCheckReportFinalizer allows HealthReconciler to clean up resources associated with HealthCheckReport before removing it from the apiserver.
No description provided by the author
HealthStatusDegraded indicates resource is degraded.
HealthStatusHealthy indicates healthy status.
HealthStatusProgressing indicates resource is not healthy yet but it is progressing.
HealthStatusSuspended indicates resource is suspended.
LivenessTypeAddons refers to add-ons deployment state.
LivenessTypeHealthCheck refers to HealthCheck state.
LogLevelDebug indicates log severity debug (V(5)) is set.
LogLevelInfo indicates log severity info (V(0)) is set.
LogLevelNotSet indicates log severity is not set.
LogLevelVerbose indicates log severity debug (V(10)) is set.
NotificationStatusDelivered indicates notification has been delivered.
NotificationStatusFailedToDeliver indicates notification was not delivered due to an error.
NotificationTypeDiscord refers to generating a Discord message.
NotificationTypeKubernetesEvent refers to generating a Kubernetes event.
NotificationTypeSlack refers to generating a Slack message.
NotificationTypeSMTP refers to generating an email message.
NotificationTypeTeams refers to generating a Teams message.
NotificationTypeWebex refers to generating a Webex message.
OperationDifferent will verify difference.
OperationEqual will verify equality.
PolicyTemplateAnnotation is the annotation that must be set on a policy when the policy is a template and needs variable sustitution.
ReloaderFinalizer finalizer.
No description provided by the author
ReloaderReportClusterNameLabel is added to each ReloaderReport.
ReloaderReportClusterTypeLabel is added to each ReloaderReport.
ReloaderReportFinalizer allows ReloaderReportReconciler to clean up resources associated with ReloaderReport before removing it from the apiserver.
No description provided by the author
ReloaderReportResourceKindAnnotation is added to each ReloaderReport.
ReloaderReportResourceNameAnnotation is added to each ReloaderReport.
ReloaderReportResourceNamespaceAnnotation is added to each ReloaderReport.
ReportDelivering indicates the report has been sent to the management cluster but not ack-ed yet.
ReportProcessed indicates the report has been already delivered and acked in the management cluster.
ReportWaitingForDelivery indicates the report has yet to be sent to the management cluster.
ResourceSummaryFinalizer is finalizer added to ResourceSummary.
No description provided by the author
No description provided by the author
No description provided by the author
RoleRequestLabel is added to each object generated for a RoleRequest in both management and managed clusters.
Define the ReferencedResourceKind constants.
ServiceAccountNameLabel can be set on various Sveltos resources (ClusterProfile/EventSource/...) to indicate which admin (represented by a ServiceAccount) is creating it (service account name).
ServiceAccountNamespaceLabel can be set on various Sveltos resources (ClusterProfile/EventSource/...) to indicate which admin (represented by a ServiceAccount) is creating it (service account namespace).
SetFinalizer allows SetReconciler to clean up resources associated with Set before removing it from the apiserver.
No description provided by the author
Slack constant To have Sveltos sends a slack notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set both slack token and slack channel id.
Slack constant To have Sveltos sends a slack notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set both slack token and slack channel id.
SMTP constant To have Sveltos sends an SMTP notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the SMTP identity, password, host, port, and from email.
SMTP constant To have Sveltos sends an SMTP notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the SMTP identity, password, host, port, and from email.
SMTP constant To have Sveltos sends an SMTP notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the SMTP identity, password, host, port, and from email.
SMTP constant To have Sveltos sends an SMTP notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the SMTP identity, password, host, port, and from email.
SMTP constant To have Sveltos sends an SMTP notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the SMTP identity, password, host, port, and from email.
SMTP constant To have Sveltos sends an SMTP notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the SMTP identity, password, host, port, and from email.
SMTP constant To have Sveltos sends an SMTP notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the SMTP identity, password, host, port, and from email.
SveltosAgent is the request type to generate kubeconfig for sveltos agent.
No description provided by the author
SveltosStatusFailed indicates that configuring sveltos feature in the workload cluster failed.
SveltosStatusProvisioned indicates that sveltos has been provisioned in the workload cluster.
SveltosStatusProvisioning indicates that sveltos feature is being provisioned in the workload cluster.
SveltosStatusRemoved indicates that sveltos feature is removed.
SveltosStatusRemoving indicates that sveltos feature is being removed.
Teams constant To have Sveltos sends a Microsoft Teams notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set the Webhook URL.
Webex constant To have Sveltos sends a webex notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set both webex token and webex room ID.
Webex constant To have Sveltos sends a webex notification, create a Secret of type "addons.projectsveltos.io/cluster-profile" In the data section set both webex token and webex room ID.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
ErrSecretTypeNotSupported signals that a Secret is not supported.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.

# Structs

AccessRequest is the Schema for the accessrequest API.
AccessRequestList contains a list of AccessRequest.
AccessRequestSpec defines the desired state of AccessRequest.
AccessRequestStatus defines the status of AccessRequest.
No description provided by the author
Classifier is the Schema for the classifiers API.
No description provided by the author
ClassifierList contains a list of Classifier.
ClassifierReport is the Schema for the classifierreports API.
ClassifierReportList contains a list of ClassifierReport.
No description provided by the author
ClassifierReportStatus defines the observed state of ClassifierReport.
ClassifierSpec defines the desired state of Classifier.
ClassifierStatus defines the observed state of Classifier.
No description provided by the author
ClusterHealthCheck is the Schema for the clusterhealthchecks API.
ClusterHealthCheckList contains a list of ClusterHealthChecks.
ClusterHealthCheckSpec defines the desired state of ClusterHealthCheck.
No description provided by the author
No description provided by the author
ClusterSet is the Schema for the clustersets API.
ClusterSetList contains a list of ClusterSet.
ComponentConfiguration is the debugging configuration to be applied to a Sveltos component.
Condition defines an observation of a Cluster API resource operational state.
DebuggingConfiguration is the Schema for the debuggingconfigurations API.
DebuggingConfigurationList contains a list of DebuggingConfiguration.
DebuggingConfigurationSpec defines the desired state of DebuggingConfiguration.
No description provided by the author
EventReport is the Schema for the EventReport API.
EventReportList contains a list of EventReport.
No description provided by the author
EventReportStatus defines the observed state of EventReport.
EventSource is the Schema for the EventSource API.
EventSourceList contains a list of EventSource.
EventSourceSpec defines the desired state of EventSource.
HealthCheck is the Schema for the HealthCheck API.
HealthCheckList contains a list of Event.
HealthCheckReport is the Schema for the HealthCheckReport API.
HealthCheckReportList contains a list of HealthCheckReport.
No description provided by the author
HealthCheckReportStatus defines the observed state of HealthCheckReport.
HealthCheckSpec defines the desired state of HealthCheck.
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
Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should be applied to.
No description provided by the author
PolicyRef specifies a resource containing one or more policy to deploy in matching Clusters.
Reloader is the Schema for the Reloader API.
ReloaderInfo represents a resource that need to be reloaded if any mounted ConfigMap/Secret changes.
ReloaderList contains a list of Reloader.
ReloaderReport is the Schema for the ReloaderReport API.
ReloaderReportList contains a list of ReloaderReport.
No description provided by the author
ReloaderReportStatus defines the observed state of ReloaderReport.
ReloaderSpec defines the desired state of Reloader.
No description provided by the author
No description provided by the author
ResourceSelector defines what resources are a match.
No description provided by the author
ResourceSummary is the Schema for the ResourceSummary API.
ResourceSummaryList contains a list of ResourceSummary.
ResourceSummarySpec defines the desired state of ResourceSummary.
ResourceSummaryStatus defines the status of ResourceSummary.
RoleRequest is the Schema for the rolerequest API.
RoleRequestList contains a list of RoleRequest.
RoleRequestSpec defines the desired state of RoleRequest.
RoleRequestStatus defines the status of RoleRequest.
No description provided by the author
Set is the Schema for the sets API.
SetList contains a list of Set.
No description provided by the author
Status defines the observed state of ClusterSet/Set.
SveltosCluster is the Schema for the SveltosCluster API.
SveltosClusterList contains a list of SveltosCluster.
SveltosClusterSpec defines the desired state of SveltosCluster.
SveltosClusterStatus defines the status of SveltosCluster.
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
ConditionSeverity expresses the severity of a Condition Type failing.
ConditionType is a valid value for Condition.Type.
ConnectionStatus specifies whether connecting to managed cluster is healthy or not +kubebuilder:validation:Enum:=Healthy;Down.
+kubebuilder:validation:Enum:=Healthy;Progressing;Degraded;Suspended.
No description provided by the author
Event specifies different type of liveness checks +kubebuilder:validation:Enum:=Addons;HealthCheck.
+kubebuilder:validation:Enum:=LogLevelNotSet;LogLevelInfo;LogLevelDebug;LogLevelVerbose.
NotificationStatus specifies status of notifications +kubebuilder:validation:Enum:=Delivered;FailedToDeliver.
NotificationType specifies different type of notifications +kubebuilder:validation:Enum:=KubernetesEvent;Slack;Webex;Discord;Teams.
Operation specifies +kubebuilder:validation:Enum:=Equal;Different.
ReferencedResourceKind is a string representation of allowed kind of resources that can be referenced in a ClusterProfile.
ReportPhase describes the state of a classifierReport/healthReport/eventReport/reloaderReport.
RequestType specifies the type of AccessRequest +kubebuilder:validation:Enum:=SveltosAgent;Different.
+kubebuilder:validation:Enum:=Provisioning;Provisioned;Failed;Removing;Removed.