Merge pull request #750 from chaosi-zju/api

add reference doc for failover
karmada-io · Nov 30, 2024 · ef48a61 · ef48a61
2 parents 5039c51 + 8ccbd92
commit ef48a61
Show file tree

Hide file tree

Showing 12 changed files with 116 additions and 68 deletions.
diff --git a/docs/reference/components/karmada-agent.md b/docs/reference/components/karmada-agent.md
@@ -46,12 +46,13 @@ karmada-agent [flags]
                                                        AllAlpha=true|false (ALPHA - default=false)
                                                        AllBeta=true|false (BETA - default=false)
                                                        CustomizedClusterResourceModeling=true|false (BETA - default=true)
-                                                       Failover=true|false (BETA - default=true)
+                                                       Failover=true|false (BETA - default=false)
                                                        GracefulEviction=true|false (BETA - default=true)
                                                        MultiClusterService=true|false (ALPHA - default=false)
                                                        PropagateDeps=true|false (BETA - default=true)
                                                        PropagationPolicyPreemption=true|false (ALPHA - default=false)
                                                        ResourceQuotaEstimate=true|false (ALPHA - default=false)
+                                                       StatefulFailoverInjection=true|false (ALPHA - default=false)
       --health-probe-bind-address string               The TCP address that the controller should bind to for serving health probes(e.g. 127.0.0.1:10357, :10357). It can be set to "0" to disable serving the health probe. Defaults to 0.0.0.0:10357. (default ":10357")
   -h, --help                                           help for karmada-agent
       --karmada-context string                         Name of the cluster context in karmada control plane kubeconfig file.

diff --git a/docs/reference/components/karmada-aggregated-apiserver.md b/docs/reference/components/karmada-aggregated-apiserver.md
@@ -95,7 +95,7 @@ karmada-aggregated-apiserver [flags]
                                                                 ConsistentListFromCache=true|false (BETA - default=true)
                                                                 CoordinatedLeaderElection=true|false (ALPHA - default=false)
                                                                 CustomizedClusterResourceModeling=true|false (BETA - default=true)
-                                                                Failover=true|false (BETA - default=true)
+                                                                Failover=true|false (BETA - default=false)
                                                                 GracefulEviction=true|false (BETA - default=true)
                                                                 InPlacePodVerticalScaling=true|false (ALPHA - default=false)
                                                                 MultiClusterService=true|false (ALPHA - default=false)
@@ -106,6 +106,7 @@ karmada-aggregated-apiserver [flags]
                                                                 ResourceQuotaEstimate=true|false (ALPHA - default=false)
                                                                 RetryGenerateName=true|false (BETA - default=true)
                                                                 SeparateCacheWatchRPC=true|false (BETA - default=true)
+                                                                StatefulFailoverInjection=true|false (ALPHA - default=false)
                                                                 StorageVersionAPI=true|false (ALPHA - default=false)
                                                                 StorageVersionHash=true|false (BETA - default=true)
                                                                 StrictCostEnforcementForVAP=true|false (BETA - default=false)

diff --git a/docs/reference/components/karmada-controller-manager.md b/docs/reference/components/karmada-controller-manager.md
@@ -42,7 +42,7 @@ karmada-controller-manager [flags]
       --concurrent-resourcebinding-syncs int                           The number of ResourceBindings that are allowed to sync concurrently. (default 5)
       --concurrent-work-syncs int                                      The number of Works that are allowed to sync concurrently. (default 5)
       --controllers strings                                            A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'. 
-                                                                       All controllers: applicationFailover, binding, bindingStatus, cluster, clusterStatus, cronFederatedHorizontalPodAutoscaler, deploymentReplicasSyncer, endpointSlice, endpointsliceCollect, endpointsliceDispatch, execution, federatedHorizontalPodAutoscaler, federatedResourceQuotaStatus, federatedResourceQuotaSync, gracefulEviction, hpaScaleTargetMarker, multiclusterservice, namespace, remedy, serviceExport, serviceImport, unifiedAuth, workStatus, workloadRebalancer.
+                                                                       All controllers: agentcsrapproving, applicationFailover, binding, bindingStatus, cluster, clusterStatus, cronFederatedHorizontalPodAutoscaler, deploymentReplicasSyncer, endpointSlice, endpointsliceCollect, endpointsliceDispatch, execution, federatedHorizontalPodAutoscaler, federatedResourceQuotaStatus, federatedResourceQuotaSync, gracefulEviction, hpaScaleTargetMarker, multiclusterservice, namespace, remedy, serviceExport, serviceImport, unifiedAuth, workStatus, workloadRebalancer.
                                                                        Disabled-by-default controllers: deploymentReplicasSyncer, hpaScaleTargetMarker (default [*])
       --enable-cluster-resource-modeling                               Enable means controller would build resource modeling for each cluster by syncing Nodes and Pods resources.
                                                                        The resource modeling might be used by the scheduler to make scheduling decisions in scenario of dynamic replica assignment based on cluster free resources.
@@ -54,12 +54,13 @@ karmada-controller-manager [flags]
                                                                        AllAlpha=true|false (ALPHA - default=false)
                                                                        AllBeta=true|false (BETA - default=false)
                                                                        CustomizedClusterResourceModeling=true|false (BETA - default=true)
-                                                                       Failover=true|false (BETA - default=true)
+                                                                       Failover=true|false (BETA - default=false)
                                                                        GracefulEviction=true|false (BETA - default=true)
                                                                        MultiClusterService=true|false (ALPHA - default=false)
                                                                        PropagateDeps=true|false (BETA - default=true)
                                                                        PropagationPolicyPreemption=true|false (ALPHA - default=false)
                                                                        ResourceQuotaEstimate=true|false (ALPHA - default=false)
+                                                                       StatefulFailoverInjection=true|false (ALPHA - default=false)
       --graceful-eviction-timeout duration                             Specifies the timeout period waiting for the graceful-eviction-controller performs the final removal since the workload(resource) has been moved to the graceful eviction tasks. (default 10m0s)
       --health-probe-bind-address string                               The TCP address that the controller should bind to for serving health probes(e.g. 127.0.0.1:10357, :10357). It can be set to "0" to disable serving the health probe. Defaults to 0.0.0.0:10357. (default ":10357")
   -h, --help                                                           help for karmada-controller-manager

diff --git a/docs/reference/components/karmada-scheduler-estimator.md b/docs/reference/components/karmada-scheduler-estimator.md
@@ -24,12 +24,13 @@ karmada-scheduler-estimator [flags]
                                            AllAlpha=true|false (ALPHA - default=false)
                                            AllBeta=true|false (BETA - default=false)
                                            CustomizedClusterResourceModeling=true|false (BETA - default=true)
-                                           Failover=true|false (BETA - default=true)
+                                           Failover=true|false (BETA - default=false)
                                            GracefulEviction=true|false (BETA - default=true)
                                            MultiClusterService=true|false (ALPHA - default=false)
                                            PropagateDeps=true|false (BETA - default=true)
                                            PropagationPolicyPreemption=true|false (ALPHA - default=false)
                                            ResourceQuotaEstimate=true|false (ALPHA - default=false)
+                                           StatefulFailoverInjection=true|false (ALPHA - default=false)
       --grpc-auth-cert-file string         SSL certification file used for grpc SSL/TLS connections.
       --grpc-auth-key-file string          SSL key file used for grpc SSL/TLS connections.
       --grpc-client-ca-file string         SSL Certificate Authority file used to verify grpc client certificates on incoming requests.

diff --git a/docs/reference/components/karmada-scheduler.md b/docs/reference/components/karmada-scheduler.md
@@ -28,12 +28,13 @@ karmada-scheduler [flags]
                                                        AllAlpha=true|false (ALPHA - default=false)
                                                        AllBeta=true|false (BETA - default=false)
                                                        CustomizedClusterResourceModeling=true|false (BETA - default=true)
-                                                       Failover=true|false (BETA - default=true)
+                                                       Failover=true|false (BETA - default=false)
                                                        GracefulEviction=true|false (BETA - default=true)
                                                        MultiClusterService=true|false (ALPHA - default=false)
                                                        PropagateDeps=true|false (BETA - default=true)
                                                        PropagationPolicyPreemption=true|false (ALPHA - default=false)
                                                        ResourceQuotaEstimate=true|false (ALPHA - default=false)
+                                                       StatefulFailoverInjection=true|false (ALPHA - default=false)
       --health-probe-bind-address string               The TCP address that the server should bind to for serving health probes(e.g. 127.0.0.1:10351, :10351). It can be set to "0" to disable serving the health probe. Defaults to 0.0.0.0:10351. (default ":10351")
   -h, --help                                           help for karmada-scheduler
       --insecure-skip-estimator-verify                 Controls whether verifies the scheduler estimator's certificate chain and host name.