package
1.10.0
Repository: https://github.com/karmada-io/api.git
Documentation: pkg.go.dev

# Functions

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

# Constants

ClusterPropagationPolicyAnnotation is added to objects to specify associated ClusterPropagationPolicy name.
ClusterPropagationPolicyLabel is added to objects to specify associated ClusterPropagationPolicy.
ClusterPropagationPolicyPermanentIDLabel is the identifier of a ClusterPropagationPolicy object.
ConflictAbort means that do not resolve the conflict and stop propagating.
ConflictOverwrite means that resolve the conflict by overwriting the resource with the propagating resource template.
DynamicWeightByAvailableReplicas represents the cluster weight list should be generated according to available resource (available replicas).
Graciously represents that Karmada will wait for the application to come back to healthy on the new cluster or after a timeout is reached before evicting the application.
GroupName specifies the group name used to register the objects.
Immediately represents that Karmada will immediately evict the legacy application.
LazyActivation means the policy changes will not take effect for now but defer to the resource template changes, in other words, the resource template will not be propagated as per the current propagation rules until there is an update on it.
NamespaceSkipAutoPropagationLabel is added to namespace objects to indicate if the namespace should be skipped from propagating by the namespace controller.
Never represents that Karmada will not evict the application and users manually confirms how to clean up redundant copies.
These are valid overrider operators.
These are valid overrider operators.
These are valid overrider operators.
PreemptAlways means that preemption is allowed.
PreemptNever means that a PropagationPolicy(ClusterPropagationPolicy) never preempts resources.
PropagationPolicyNameAnnotation is added to objects to specify associated PropagationPolicy name.
PropagationPolicyNameLabel is added to objects to specify associated PropagationPolicy's name.
PropagationPolicyNamespaceAnnotation is added to objects to specify associated PropagationPolicy namespace.
PropagationPolicyNamespaceLabel is added to objects to specify associated PropagationPolicy namespace.
PropagationPolicyPermanentIDLabel is the identifier of a PropagationPolicy object.
Registry is the registry component of an image with format '[registry/]repository[:tag]'.
ReplicaDivisionPreferenceAggregated divides replicas into clusters as few as possible, while respecting clusters' resource availabilities during the division.
ReplicaDivisionPreferenceWeighted divides replicas by weight according to WeightPreference.
ReplicaSchedulingTypeDivided means when propagating a resource, each candidate member cluster will get only a part of original replicas.
ReplicaSchedulingTypeDuplicated means when propagating a resource, each candidate member cluster will directly apply the original replicas.
Repository is the repository component of an image with format '[registry/]repository[:tag]'.
ResourceKindClusterOverridePolicy is kind name of ClusterOverridePolicy.
ResourceKindClusterPropagationPolicy is kind name of ClusterPropagationPolicy.
ResourceKindFederatedResourceQuota is kind name of FederatedResourceQuota.
ResourceKindOverridePolicy is kind name of OverridePolicy.
ResourceKindPropagationPolicy is kind name of PropagationPolicy.
ResourceNamespaceScopedClusterOverridePolicy indicates if ClusterOverridePolicy is NamespaceScoped.
ResourceNamespaceScopedClusterPropagationPolicy indicates if ClusterPropagationPolicy is NamespaceScoped.
ResourceNamespaceScopedFederatedResourceQuota indicates if FederatedResourceQuota is NamespaceScoped.
ResourceNamespaceScopedOverridePolicy indicates if OverridePolicy is NamespaceScoped.
ResourceNamespaceScopedPropagationPolicy indicates if PropagationPolicy is NamespaceScoped.
ResourcePluralClusterOverridePolicy is kind plural of ClusterOverridePolicy.
ResourcePluralClusterPropagationPolicy is plural name of ClusterPropagationPolicy.
ResourcePluralFederatedResourceQuota is plural name of FederatedResourceQuota.
ResourcePluralOverridePolicy is plural name of OverridePolicy.
ResourcePluralPropagationPolicy is kind plural name of PropagationPolicy.
ResourceSingularClusterOverridePolicy is singular name of ClusterOverridePolicy.
ResourceSingularClusterPropagationPolicy is singular name of ClusterPropagationPolicy.
ResourceSingularFederatedResourceQuota is singular name of FederatedResourceQuota.
ResourceSingularOverridePolicy is singular name of OverridePolicy.
ResourceSingularPropagationPolicy is singular name of PropagationPolicy.
Available fields for spreading are: cluster, region, zone, and provider.
Available fields for spreading are: cluster, region, zone, and provider.
Available fields for spreading are: cluster, region, zone, and provider.
Available fields for spreading are: cluster, region, zone, and provider.
Tag is the tag component of an image with format '[registry/]repository[:tag]'.

# Variables

Depreciated: use Install instead.
GroupVersion specifies the group and the version used to register the objects.
No description provided by the author
localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.

# Structs

ApplicationFailoverBehavior indicates application failover behaviors.
ClusterAffinity represents the filter to select clusters.
ClusterAffinityTerm selects a set of cluster.
ClusterOverridePolicy represents the cluster-wide policy that overrides a group of resources to one or more clusters.
ClusterOverridePolicyList is a collection of ClusterOverridePolicy.
ClusterPreferences describes weight for each cluster or for each group of cluster.
ClusterPropagationPolicy represents the cluster-wide policy that propagates a group of resources to one or more clusters.
ClusterPropagationPolicyList contains a list of ClusterPropagationPolicy.
ClusterQuotaStatus represents the set of desired limits and observed usage for a specific cluster.
CommandArgsOverrider represents the rules dedicated to handling command/args overrides.
DecisionConditions represents the decision conditions of performing the failover process.
FailoverBehavior indicates failover behaviors in case of an application or cluster failure.
FederatedResourceQuota sets aggregate quota restrictions enforced per namespace across all clusters.
FederatedResourceQuotaList contains a list of FederatedResourceQuota.
FederatedResourceQuotaSpec defines the desired hard limits to enforce for Quota.
FederatedResourceQuotaStatus defines the enforced hard limits and observed use.
FieldSelector is a field filter.
ImageOverrider represents the rules dedicated to handling image overrides.
ImagePredicate describes images filter.
LabelAnnotationOverrider represents the rules dedicated to handling workload labels/annotations.
OverridePolicy represents the policy that overrides a group of resources to one or more clusters.
OverridePolicyList is a collection of OverridePolicy.
Overriders offers various alternatives to represent the override rules.
OverrideSpec defines the desired behavior of OverridePolicy.
Placement represents the rule for select clusters.
PlaintextOverrider is a simple overrider that overrides target fields according to path, operator and value.
PropagationPolicy represents the policy that propagates a group of resources to one or more clusters.
PropagationPolicyList contains a list of PropagationPolicy.
PropagationSpec represents the desired behavior of PropagationPolicy.
ReplicaSchedulingStrategy represents the assignment strategy of replicas.
ResourceSelector the resources will be selected.
RuleWithCluster defines the override rules on clusters.
SpreadConstraint represents the spread constraints on resources.
StaticClusterAssignment represents the set of desired hard limits for a specific cluster.
StaticClusterWeight defines the static cluster weight.

# Type aliases

ActivationPreference indicates how the referencing resource template will be propagated, in case of policy changes.
ConflictResolution describes how to resolve the conflict during the process of propagation especially the resource already in a member cluster.
DynamicWeightFactor represents the weight factor.
ImageComponent indicates the components for image.
OverriderOperator is the set of operators that can be used in an overrider.
PreemptionBehavior describes whether and how to preempt resources that are claimed by lower-priority PropagationPolicy(ClusterPropagationPolicy).
PurgeMode represents that how to deal with the legacy applications on the cluster from which the application is migrated.
ReplicaDivisionPreference describes options of how replicas can be scheduled.
ReplicaSchedulingType describes scheduling methods for the "replicas" in a resource.
SpreadFieldValue is the type to define valid values for SpreadConstraint.SpreadByField.