Merge pull request honojs#522 from chaosi-zju/doc

Documentation Releasing for v1.8

Author: karmada-bot

docs/reference/components/karmada-agent.md

@@ -35,6 +35,7 @@ karmada-agent [flags]
       --cluster-region string                          The region of the joining cluster. The Karmada scheduler can use this information to spread workloads across regions for higher availability.
       --cluster-status-update-frequency duration       Specifies how often karmada-agent posts cluster status to karmada-apiserver. Note: be cautious when changing the constant, it must work with ClusterMonitorGracePeriod in karmada-controller-manager. (default 10s)
       --cluster-success-threshold duration             The duration of successes for the cluster to be considered healthy after recovery. (default 30s)
+      --cluster-zones strings                          The zones of the joining cluster. The Karmada scheduler can use this information to spread workloads across zones for higher availability.
       --concurrent-cluster-syncs int                   The number of Clusters 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: certRotation, clusterStatus, execution, serviceExport, workStatus. (default [*])

docs/reference/components/karmada-aggregated-apiserver.md

@@ -106,6 +106,7 @@ karmada-aggregated-apiserver [flags]
                                                                 RemainingItemCount=true|false (BETA - default=true)
                                                                 StorageVersionAPI=true|false (ALPHA - default=false)
                                                                 StorageVersionHash=true|false (BETA - default=true)
+                                                                UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=false)
                                                                 ValidatingAdmissionPolicy=true|false (ALPHA - default=false)
                                                                 WatchList=true|false (ALPHA - default=false)
   -h, --help                                                    help for karmada-aggregated-apiserver

docs/reference/components/karmada-controller-manager.md

@@ -42,8 +42,8 @@ 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, endpointSlice, execution, federatedHorizontalPodAutoscaler, federatedResourceQuotaStatus, federatedResourceQuotaSync, gracefulEviction, namespace, serviceExport, serviceImport, unifiedAuth, workStatus.
-                                                                       Disabled-by-default controllers:  (default [*])
+                                                                       All controllers: applicationFailover, binding, bindingStatus, cluster, clusterStatus, cronFederatedHorizontalPodAutoscaler, endpointSlice, execution, federatedHorizontalPodAutoscaler, federatedResourceQuotaStatus, federatedResourceQuotaSync, gracefulEviction, hpaReplicasSyncer, multiclusterservice, namespace, serviceExport, serviceImport, unifiedAuth, workStatus.
+                                                                       Disabled-by-default controllers: hpaReplicasSyncer (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.
                                                                        Disable if it does not fit your cases for better performance. (default true)

docs/reference/components/karmada-scheduler.md

@@ -38,8 +38,11 @@ karmada-scheduler [flags]
       --kube-api-qps float32                        QPS to use while talking with karmada-apiserver. Doesn't cover events and node heartbeat apis which rate limiting is controlled by a different set of flags. (default 40)
       --kubeconfig string                           Path to karmada control plane kubeconfig file.
       --leader-elect                                Enable leader election, which must be true when running multi instances. (default true)
+      --leader-elect-lease-duration duration        The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. (default 15s)
+      --leader-elect-renew-deadline duration        The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. (default 10s)
       --leader-elect-resource-name string           The name of resource object that is used for locking during leader election. (default "karmada-scheduler")
       --leader-elect-resource-namespace string      The namespace of resource object that is used for locking during leader election. (default "karmada-system")
+      --leader-elect-retry-period duration          The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s)
       --log_backtrace_at traceLocation              when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                              If non-empty, write log files in this directory (no effect when -logtostderr=true)
       --log_file string                             If non-empty, use this log file (no effect when -logtostderr=true)
@@ -50,6 +53,10 @@ karmada-scheduler [flags]
       --plugins strings                             A list of plugins to enable. '*' enables all build-in and customized plugins, 'foo' enables the plugin named 'foo', '*,-foo' disables the plugin named 'foo'.
                                                     All build-in plugins: APIEnablement,ClusterAffinity,ClusterEviction,ClusterLocality,SpreadConstraint,TaintToleration. (default [*])
       --profiling-bind-address string               The TCP address for serving profiling(e.g. 127.0.0.1:6060, :6060). This is only applicable if profiling is enabled. (default ":6060")
+      --rate-limiter-base-delay duration            The base delay for rate limiter. (default 5ms)
+      --rate-limiter-bucket-size int                The bucket size for rate limier. (default 100)
+      --rate-limiter-max-delay duration             The max delay for rate limiter. (default 16m40s)
+      --rate-limiter-qps int                        The QPS for rate limier. (default 10)
       --scheduler-estimator-port int                The secure port on which to connect the accurate scheduler estimator. (default 10352)
       --scheduler-estimator-service-prefix string   The prefix of scheduler estimator service name (default "karmada-scheduler-estimator")
       --scheduler-estimator-timeout duration        Specifies the timeout period of calling the scheduler estimator service. (default 3s)

docs/reference/components/karmada-search.md

@@ -102,6 +102,7 @@ karmada-search [flags]
                                                                 RemainingItemCount=true|false (BETA - default=true)
                                                                 StorageVersionAPI=true|false (ALPHA - default=false)
                                                                 StorageVersionHash=true|false (BETA - default=true)
+                                                                UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=false)
                                                                 ValidatingAdmissionPolicy=true|false (ALPHA - default=false)
                                                                 WatchList=true|false (ALPHA - default=false)
   -h, --help                                                    help for karmada-search

docs/reference/karmadactl/karmadactl-commands/karmadactl_addons_disable.md

@@ -33,7 +33,7 @@ karmadactl addons disable
   # Specify the Karmada control plane kubeconfig
   karmadactl addons disable karmada-search --karmada-kubeconfig /etc/karmada/karmada-apiserver.config
   
-  # Sepcify the namespace where Karmada components are installed
+  # Specify the namespace where Karmada components are installed
   karmadactl addons disable karmada-search --namespace karmada-system
 ```
 

docs/reference/karmadactl/karmadactl-commands/karmadactl_addons_enable.md

@@ -36,7 +36,7 @@ karmadactl addons enable
   # Specify the karmada-search image
   karmadactl addons enable karmada-search --karmada-search-image docker.io/karmada/karmada-search:latest
   
-  # Sepcify the namespace where Karmada components are installed
+  # Specify the namespace where Karmada components are installed
   karmadactl addons enable karmada-search --namespace karmada-system
 ```
 

docs/reference/karmadactl/karmadactl-commands/karmadactl_addons_list.md

@@ -27,7 +27,7 @@ karmadactl addons list
   # Specify the karmada control plane kubeconfig
   karmadactl addons list --karmada-kubeconfig /etc/karmada/karmada-apiserver.config
   
-  # Sepcify the namespace where Karmada components are installed
+  # Specify the namespace where Karmada components are installed
   karmadactl addons list --namespace karmada-system
 ```
 

docs/reference/karmadactl/karmadactl-commands/karmadactl_exec.md

@@ -22,7 +22,7 @@ karmadactl exec (POD | TYPE/NAME) [-c CONTAINER] (-C CLUSTER) -- COMMAND [args..
   karmadactl exec mypod -c ruby-container -C=member1 -- date
   
   # Get output from running the 'date' command in ruby-container from pod mypod in cluster(member1)
-  karmadactlexec mypod -c ruby-container -C=member1 -- date
+  karmadactl exec mypod -c ruby-container -C=member1 -- date
   
   # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod in cluster(member1)
   # and sends stdout/stderr from 'bash' back to the client

docs/reference/karmadactl/karmadactl-commands/karmadactl_init.md

@@ -70,6 +70,11 @@ karmadactl init
       --etcd-pvc-size string                             etcd data path,valid in pvc mode. (default "5Gi")
       --etcd-replicas int32                              etcd replica set, cluster 3,5...singular (default 1)
       --etcd-storage-mode string                         etcd data storage mode(emptyDir,hostPath,PVC). value is PVC, specify --storage-classes-name (default "hostPath")
+      --external-etcd-ca-cert-path string                The path of CA certificate of the external etcd cluster in pem format.
+      --external-etcd-client-cert-path string            The path of client side certificate to the external etcd cluster in pem format.
+      --external-etcd-client-key-path string             The path of client side private key to the external etcd cluster in pem format.
+      --external-etcd-key-prefix string                  The key prefix to be configured to kube-apiserver through --etcd-prefix.
+      --external-etcd-servers string                     The server urls of external etcd cluster, to be used by kube-apiserver through --etcd-servers.
   -h, --help                                             help for init
       --host-cluster-domain string                       The cluster domain of karmada host cluster. (e.g. --host-cluster-domain=host.karmada) (default "cluster.local")
       --image-pull-secrets strings                       Image pull secrets are used to pull images from the private registry, could be secret list separated by comma (e.g '--image-pull-secrets PullSecret1,PullSecret2', the secrets should be pre-settled in the namespace declared by '--namespace')