Skip to content

Commit

Permalink
Merge pull request #568 from XiShanYongYe-Chang/update-karmadactl-com…
Browse files Browse the repository at this point in the history 
…mand

Update karmadactl command document
  • Loading branch information
@karmada-bot
karmada-bot authored Feb 29, 2024
2 parents 07bc3ec + ecc8df2 commit 2dfff3a
Show file tree
Hide file tree
Showing 20 changed files with 94 additions and 50 deletions.
6 changes: 4 additions & 2 deletions docs/reference/components/karmada-agent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: karmada-agent
### Synopsis

The karmada-agent is the agent of member clusters. It can register a specific cluster to the Karmada control
plane and sync manifests from the Karmada control plane to the member cluster. In addition, it also syncs the status of member
plane and sync manifests from the Karmada control plane to the member cluster. In addition, it also syncs the status of member
cluster and manifests to the Karmada control plane.

```
Expand Down Expand Up @@ -38,7 +38,7 @@ karmada-agent [flags]
--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 [*])
--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, endpointsliceCollect, execution, serviceExport, workStatus. (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)
Expand All @@ -49,8 +49,10 @@ karmada-agent [flags]
CustomizedClusterResourceModeling=true|false (BETA - default=true)
Failover=true|false (BETA - default=true)
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)
-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
10 changes: 7 additions & 3 deletions docs/reference/components/karmada-aggregated-apiserver.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ karmada-aggregated-apiserver [flags]
--authorization-kubeconfig string kubeconfig file pointing at the 'core' kubernetes server with enough rights to create subjectaccessreviews.authorization.k8s.io.
--authorization-webhook-cache-authorized-ttl duration The duration to cache 'authorized' responses from the webhook authorizer. (default 10s)
--authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. (default 10s)
--bind-address ip The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces will be used. (default 0.0.0.0)
--bind-address ip The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces and IP address families will be used. (default 0.0.0.0)
--cert-dir string The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. (default "apiserver.local.config/certificates")
--client-ca-file string If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--contention-profiling Enable block profiling, if profiling is enabled
Expand Down Expand Up @@ -89,25 +89,29 @@ karmada-aggregated-apiserver [flags]
APIResponseCompression=true|false (BETA - default=true)
APIServerIdentity=true|false (BETA - default=true)
APIServerTracing=true|false (BETA - default=true)
AdmissionWebhookMatchConditions=true|false (ALPHA - default=false)
AdmissionWebhookMatchConditions=true|false (BETA - default=true)
AggregatedDiscoveryEndpoint=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AllBeta=true|false (BETA - default=false)
ComponentSLIs=true|false (BETA - default=true)
ConsistentListFromCache=true|false (ALPHA - default=false)
CustomResourceValidationExpressions=true|false (BETA - default=true)
CustomizedClusterResourceModeling=true|false (BETA - default=true)
Failover=true|false (BETA - default=true)
GracefulEviction=true|false (BETA - default=true)
InPlacePodVerticalScaling=true|false (ALPHA - default=false)
KMSv2=true|false (BETA - default=true)
KMSv2KDF=true|false (BETA - default=false)
MultiClusterService=true|false (ALPHA - default=false)
OpenAPIEnums=true|false (BETA - default=true)
PropagateDeps=true|false (BETA - default=true)
PropagationPolicyPreemption=true|false (ALPHA - default=false)
RemainingItemCount=true|false (BETA - default=true)
ResourceQuotaEstimate=true|false (ALPHA - default=false)
StorageVersionAPI=true|false (ALPHA - default=false)
StorageVersionHash=true|false (BETA - default=true)
UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=false)
ValidatingAdmissionPolicy=true|false (ALPHA - default=false)
ValidatingAdmissionPolicy=true|false (BETA - default=false)
WatchList=true|false (ALPHA - default=false)
-h, --help help for karmada-aggregated-apiserver
--http2-max-streams-per-connection int The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default. (default 1000)
Expand Down
6 changes: 4 additions & 2 deletions docs/reference/components/karmada-controller-manager.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: karmada-controller-manager
### Synopsis

The karmada-controller-manager runs various controllers.
The controllers watch Karmada objects and then talk to the underlying clusters' API servers
The controllers watch Karmada objects and then talk to the underlying clusters' API servers
to create regular Kubernetes resources.

```
Expand Down Expand Up @@ -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, endpointSlice, execution, federatedHorizontalPodAutoscaler, federatedResourceQuotaStatus, federatedResourceQuotaSync, gracefulEviction, hpaReplicasSyncer, multiclusterservice, namespace, serviceExport, serviceImport, unifiedAuth, workStatus.
All controllers: applicationFailover, binding, bindingStatus, cluster, clusterStatus, cronFederatedHorizontalPodAutoscaler, endpointSlice, endpointsliceCollect, endpointsliceDispatch, execution, federatedHorizontalPodAutoscaler, federatedResourceQuotaStatus, federatedResourceQuotaSync, gracefulEviction, hpaReplicasSyncer, multiclusterservice, namespace, remedy, 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.
Expand All @@ -56,8 +56,10 @@ karmada-controller-manager [flags]
CustomizedClusterResourceModeling=true|false (BETA - default=true)
Failover=true|false (BETA - default=true)
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)
--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)
-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)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/karmada-metrics-adapter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ karmada-metrics-adapter [flags]
--authorization-kubeconfig string kubeconfig file pointing at the 'core' kubernetes server with enough rights to create subjectaccessreviews.authorization.k8s.io.
--authorization-webhook-cache-authorized-ttl duration The duration to cache 'authorized' responses from the webhook authorizer. (default 10s)
--authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. (default 10s)
--bind-address ip The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces will be used. (default 0.0.0.0)
--bind-address ip The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank or an unspecified address (0.0.0.0 or ::), all interfaces and IP address families will be used. (default 0.0.0.0)
--cert-dir string The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. (default "apiserver.local.config/certificates")
--client-ca-file string If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--contention-profiling Enable block profiling, if profiling is enabled
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/components/karmada-scheduler-estimator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ karmada-scheduler-estimator [flags]
--bind-address string The IP address on which to listen for the --secure-port port. (default "0.0.0.0")
--cluster-name string Name of member cluster that the estimator serves for.
--enable-pprof Enable profiling via web interface host:port/debug/pprof/.
--feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
AllBeta=true|false (BETA - default=false)
CustomizedClusterResourceModeling=true|false (BETA - default=true)
Failover=true|false (BETA - default=true)
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)
-h, --help help for karmada-scheduler-estimator
--kube-api-burst int Burst to use while talking with apiserver. Doesn't cover events and node heartbeat apis which rate limiting is controlled by a different set of flags. (default 30)
--kube-api-qps float32 QPS to use while talking with apiserver. Doesn't cover events and node heartbeat apis which rate limiting is controlled by a different set of flags. (default 20)
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/components/karmada-scheduler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ karmada-scheduler [flags]
CustomizedClusterResourceModeling=true|false (BETA - default=true)
Failover=true|false (BETA - default=true)
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)
-h, --help help for karmada-scheduler
--kube-api-burst int Burst 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 60)
--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)
Expand Down
Loading

0 comments on commit 2dfff3a

Please sign in to comment.