Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update reference doc for cli and components #747

Merged
merged 1 commit into from
Nov 30, 2024
Merged

update reference doc for cli and components #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/components/karmada-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ karmada-agent [flags]
PropagateDeps=true|false (BETA - default=true)
PropagationPolicyPreemption=true|false (ALPHA - default=false)
ResourceQuotaEstimate=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.
--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.
--karmada-kubeconfig string Path to karmada control plane kubeconfig file.
Expand Down
13 changes: 10 additions & 3 deletions docs/reference/components/karmada-aggregated-apiserver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ karmada-aggregated-apiserver [flags]
--contention-profiling Enable block profiling, if profiling is enabled
--debug-socket-path string Use an unprotected (no authn/authz) unix-domain socket for profiling with the given path
--delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1)
--disable-http2-serving If true, HTTP2 serving will be disabled [default=false]
--enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. (default true)
--enable-pprof Enable profiling via web interface host:port/debug/pprof/.
--enable-priority-and-fairness If true, replace the max-in-flight handler with an enhanced one that queues and dispatches with priority and fairness (default true)
Expand All @@ -84,11 +85,15 @@ karmada-aggregated-apiserver [flags]
APIResponseCompression=true|false (BETA - default=true)
APIServerIdentity=true|false (BETA - default=true)
APIServerTracing=true|false (BETA - default=true)
APIServingWithRoutine=true|false (BETA - default=true)
APIServingWithRoutine=true|false (ALPHA - default=false)
AllAlpha=true|false (ALPHA - default=false)
AllBeta=true|false (BETA - default=false)
AnonymousAuthConfigurableEndpoints=true|false (ALPHA - default=false)
AuthorizeWithSelectors=true|false (ALPHA - default=false)
ComponentSLIs=true|false (BETA - default=true)
ConsistentListFromCache=true|false (ALPHA - default=false)
ConcurrentWatchObjectDecode=true|false (BETA - default=false)
ConsistentListFromCache=true|false (BETA - default=true)
CoordinatedLeaderElection=true|false (ALPHA - default=false)
CustomizedClusterResourceModeling=true|false (BETA - default=true)
Failover=true|false (BETA - default=true)
GracefulEviction=true|false (BETA - default=true)
Expand All @@ -97,8 +102,9 @@ karmada-aggregated-apiserver [flags]
OpenAPIEnums=true|false (BETA - default=true)
PropagateDeps=true|false (BETA - default=true)
PropagationPolicyPreemption=true|false (ALPHA - default=false)
ResilientWatchCacheInitialization=true|false (BETA - default=true)
ResourceQuotaEstimate=true|false (ALPHA - default=false)
RetryGenerateName=true|false (ALPHA - default=false)
RetryGenerateName=true|false (BETA - default=true)
SeparateCacheWatchRPC=true|false (BETA - default=true)
StorageVersionAPI=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
Expand All @@ -107,6 +113,7 @@ karmada-aggregated-apiserver [flags]
StructuredAuthenticationConfiguration=true|false (BETA - default=true)
StructuredAuthorizationConfiguration=true|false (BETA - default=true)
UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)
WatchCacheInitializationPostStartHook=true|false (BETA - default=false)
WatchFromStorageWithoutResourceVersion=true|false (BETA - default=false)
WatchList=true|false (ALPHA - default=false)
-h, --help help for karmada-aggregated-apiserver
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/components/karmada-controller-manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ karmada-controller-manager [flags]
--concurrent-cluster-propagation-policy-syncs int The number of ClusterPropagationPolicy that are allowed to sync concurrently. (default 1)
--concurrent-cluster-syncs int The number of Clusters that are allowed to sync concurrently. (default 5)
--concurrent-clusterresourcebinding-syncs int The number of ClusterResourceBindings that are allowed to sync concurrently. (default 5)
--concurrent-dependent-resource-syncs int The number of dependent resource that are allowed to sync concurrently. (default 2)
--concurrent-namespace-syncs int The number of Namespaces that are allowed to sync concurrently. (default 1)
--concurrent-propagation-policy-syncs int The number of PropagationPolicy that are allowed to sync concurrently. (default 1)
--concurrent-resource-template-syncs int The number of resource templates that are allowed to sync concurrently. (default 5)
Expand All @@ -60,7 +61,7 @@ karmada-controller-manager [flags]
PropagationPolicyPreemption=true|false (ALPHA - default=false)
ResourceQuotaEstimate=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.
--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
--horizontal-pod-autoscaler-cpu-initialization-period duration The period after pod start when CPU samples might be skipped. (default 5m0s)
--horizontal-pod-autoscaler-downscale-delay duration The period since last downscale, before another downscale can be performed in horizontal pod autoscaler. (default 5m0s)
Expand Down
70 changes: 37 additions & 33 deletions docs/reference/components/karmada-descheduler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,39 +17,43 @@ karmada-descheduler [flags]
### Options

```
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files (no effect when -logtostderr=true)
--descheduling-interval duration Time interval between two consecutive descheduler executions. Setting this value instructs the descheduler to run in a continuous loop at the interval specified. (default 2m0s)
--enable-pprof Enable profiling via web interface host:port/debug/pprof/.
--health-probe-bind-address string The TCP address that the server should bind to for serving health probes(e.g. 127.0.0.1:10358, :10358). It can be set to "0" to disable serving the health probe. Defaults to 0.0.0.0:10358.
-h, --help help for karmada-descheduler
--insecure-skip-estimator-verify Controls whether verifies the scheduler estimator's certificate chain and host name.
--kube-api-burst int Burst to use while talking with karmada-apiserver. (default 60)
--kube-api-qps float32 QPS to use while talking with karmada-apiserver. (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-resource-namespace string The namespace of resource object that is used for locking during leader election. (default "karmada-system")
--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)
--log_file_max_size uint Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
--logtostderr log to standard error instead of files (default true)
--master string The address of the Kubernetes API server. Overrides any value in KubeConfig. Only required if out-of-cluster.
--metrics-bind-address string The TCP address that the server should bind to for serving prometheus metrics(e.g. 127.0.0.1:10358, :10358). It can be set to "0" to disable the metrics serving. Defaults to 0.0.0.0:10358.
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
--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")
--scheduler-estimator-ca-file string SSL Certificate Authority file used to secure scheduler estimator communication.
--scheduler-estimator-cert-file string SSL certification file used to secure scheduler estimator communication.
--scheduler-estimator-key-file string SSL key file used to secure scheduler estimator communication.
--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)
--skip_headers If true, avoid header prefixes in the log messages
--skip_log_headers If true, avoid headers when opening log files (no effect when -logtostderr=true)
--stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)
--unschedulable-threshold duration The period of pod unschedulable condition. This value is considered as a classification standard of unschedulable replicas. (default 5m0s)
-v, --v Level number for the log level verbosity
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files (no effect when -logtostderr=true)
--descheduling-interval duration Time interval between two consecutive descheduler executions. Setting this value instructs the descheduler to run in a continuous loop at the interval specified. (default 2m0s)
--enable-pprof Enable profiling via web interface host:port/debug/pprof/.
--health-probe-bind-address string The TCP address that the server should bind to for serving health probes(e.g. 127.0.0.1:10358, :10358). It can be set to "0" to disable serving the health probe. Defaults to 0.0.0.0:10358. (default ":10358")
-h, --help help for karmada-descheduler
--insecure-skip-estimator-verify Controls whether verifies the scheduler estimator's certificate chain and host name.
--kube-api-burst int Burst to use while talking with karmada-apiserver. (default 60)
--kube-api-qps float32 QPS to use while talking with karmada-apiserver. (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-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)
--log_file_max_size uint Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
--logtostderr log to standard error instead of files (default true)
--master string The address of the Kubernetes API server. Overrides any value in KubeConfig. Only required if out-of-cluster.
--metrics-bind-address string The TCP address that the server should bind to for serving prometheus metrics(e.g. 127.0.0.1:8080, :8080). It can be set to "0" to disable the metrics serving. Defaults to 0.0.0.0:8080. (default ":8080")
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
--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")
--scheduler-estimator-ca-file string SSL Certificate Authority file used to secure scheduler estimator communication.
--scheduler-estimator-cert-file string SSL certification file used to secure scheduler estimator communication.
--scheduler-estimator-key-file string SSL key file used to secure scheduler estimator communication.
--scheduler-estimator-port int The secure port on which to connect the accurate scheduler estimator. (default 10352)
--scheduler-estimator-service-namespace string The namespace to be used for discovering scheduler estimator services. (default "karmada-system")
--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)
--skip_headers If true, avoid header prefixes in the log messages
--skip_log_headers If true, avoid headers when opening log files (no effect when -logtostderr=true)
--stderrthreshold severity logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)
--unschedulable-threshold duration The period of pod unschedulable condition. This value is considered as a classification standard of unschedulable replicas. (default 5m0s)
-v, --v Level number for the log level verbosity
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```

###### Auto generated by [spf13/cobra script in Karmada](https://github.com/karmada-io/karmada/tree/master/hack/tools/gencomponentdocs)
Loading