From 1731e08a04ece216e766bcf2d1a97bb5b5393bad Mon Sep 17 00:00:00 2001 From: tiansuo114 <1729765480@qq.com> Date: Wed, 23 Oct 2024 10:36:29 +0800 Subject: [PATCH] add karmadactl init --config & KarmadaInitConfig v1alpha1 documents Signed-off-by: tiansuo114 <1729765480@qq.com> --- docs/installation/install-with-cli.md | 74 ++++ docs/installation/installation.md | 26 ++ .../karmadactl_annotate.md | 4 +- .../karmadactl_api-resources.md | 5 +- .../karmadactl_api-versions.md | 5 +- .../karmadactl-commands/karmadactl_apply.md | 2 +- .../karmadactl-commands/karmadactl_attach.md | 4 +- .../karmadactl-commands/karmadactl_create.md | 6 +- .../karmadactl_create_clusterrole.md | 4 +- .../karmadactl_create_clusterrolebinding.md | 4 +- .../karmadactl_create_configmap.md | 4 +- .../karmadactl_create_cronjob.md | 4 +- .../karmadactl_create_deployment.md | 4 +- .../karmadactl_create_ingress.md | 4 +- .../karmadactl_create_job.md | 4 +- .../karmadactl_create_namespace.md | 4 +- .../karmadactl_create_poddisruptionbudget.md | 4 +- .../karmadactl_create_priorityclass.md | 4 +- .../karmadactl_create_quota.md | 4 +- .../karmadactl_create_role.md | 4 +- .../karmadactl_create_rolebinding.md | 4 +- .../karmadactl_create_secret.md | 4 +- ...armadactl_create_secret_docker-registry.md | 4 +- .../karmadactl_create_secret_generic.md | 4 +- .../karmadactl_create_secret_tls.md | 4 +- .../karmadactl_create_service.md | 4 +- .../karmadactl_create_service_clusterip.md | 4 +- .../karmadactl_create_service_externalname.md | 4 +- .../karmadactl_create_service_loadbalancer.md | 4 +- .../karmadactl_create_service_nodeport.md | 4 +- .../karmadactl_create_serviceaccount.md | 4 +- .../karmadactl_create_token.md | 4 +- .../karmadactl-commands/karmadactl_delete.md | 4 +- .../karmadactl_describe.md | 4 +- .../karmadactl-commands/karmadactl_edit.md | 6 +- .../karmadactl-commands/karmadactl_exec.md | 4 +- .../karmadactl-commands/karmadactl_explain.md | 7 +- .../karmadactl-commands/karmadactl_get.md | 4 +- .../karmadactl-commands/karmadactl_init.md | 10 +- .../karmadactl-commands/karmadactl_label.md | 4 +- .../karmadactl-commands/karmadactl_logs.md | 2 +- .../karmadactl-commands/karmadactl_patch.md | 4 +- .../karmadactl-commands/karmadactl_promote.md | 2 +- .../karmadactl_top_node.md | 17 +- .../karmadactl-commands/karmadactl_top_pod.md | 2 +- .../karmadactl/karmadactl-config.v1alpha1.md | 400 ++++++++++++++++++ sidebars.js | 2 + 47 files changed, 632 insertions(+), 62 deletions(-) create mode 100644 docs/installation/install-with-cli.md create mode 100644 docs/reference/karmadactl/karmadactl-config.v1alpha1.md diff --git a/docs/installation/install-with-cli.md b/docs/installation/install-with-cli.md new file mode 100644 index 00000000..0197857b --- /dev/null +++ b/docs/installation/install-with-cli.md @@ -0,0 +1,74 @@ +--- +title: Installation with CLI +--- + +## Prerequisites +## Installation with init flags + +## Installation with init configuration + +`karmadactl init` allows you to install Karmada by specifying a configuration file, which provides a structured way to define all settings in a YAML file. + +### Example Configuration File +Here is an example of the configuration file for Karmada deployment: +```yaml +apiVersion: config.karmada.io/v1alpha1 +kind: KarmadaInitConfig +spec: + karmadaCrds: "https://github.com/karmada-io/karmada/releases/download/v1.10.3/crds.tar.gz" + etcd: + local: + imageRepository: "registry.k8s.io/etcd" + imageTag: "3.5.13-0" + initImage: + imageRepository: "docker.io/library/alpine" + imageTag: "3.19.1" + components: + karmadaAPIServer: + imageRepository: "registry.k8s.io/kube-apiserver" + imageTag: "v1.30.0" + karmadaAggregatedAPIServer: + imageRepository: "docker.io/karmada/karmada-aggregated-apiserver" + imageTag: "v1.10.3" + kubeControllerManager: + imageRepository: "registry.k8s.io/kube-controller-manager" + imageTag: "v1.30.0" + karmadaControllerManager: + imageRepository: "docker.io/karmada/karmada-controller-manager" + imageTag: "v1.10.3" + karmadaScheduler: + imageRepository: "docker.io/karmada/karmada-scheduler" + imageTag: "v1.10.3" + karmadaWebhook: + imageRepository: "docker.io/karmada/karmada-webhook" + imageTag: "v1.10.3" +``` + +### Deploying Karmada with Configuration File + +1.Save the example configuration above to a file, e.g., karmada-init-config.yaml. + +2.Use the following command to deploy Karmada with the configuration file: + + ```bash + sudo karmadactl init --config /path/to/your/karmada-init-config.yaml + ``` + +:::note + +You need to use sudo for elevated permissions because `karmadactl` creates a +`karmada-apiserver.config` file at the `/etc/karmada/` directory. + +::: + +3.This configuration file allows you to define essential parameters, including: + +- certificates: Defines certificate paths and validity period. +- etcd: Configures Etcd settings, including local or external Etcd options. +- hostCluster: Specifies host cluster API endpoint and kubeconfig. +- images: Configures image settings for components. +- components: Sets up replicas for API Server and other core components. +- karmadaDataPath: Defines the data path for Karmada. +- ... + +If you need more information about the configuration file, please refer to the [karmadactl init API reference](/docs/reference/karmadactl/karmadactl-config.v1alpha1.md). diff --git a/docs/installation/installation.md b/docs/installation/installation.md index d9676bea..86acfc23 100644 --- a/docs/installation/installation.md +++ b/docs/installation/installation.md @@ -229,3 +229,29 @@ member3 v1.23.4 Pull True 7m27s ``` There are 3 clusters named `member1`, `member2` and `member3` have registered with `Push` or `Pull` mode. + +## Required Images for Karmada Deployment + +The following table lists the images required for deploying Karmada: + +| Component | Default Image | Default Tag | +|----------------------------------|--------------------------------------------------|-----------------------------| +| **karmada-apiserver** | `registry.k8s.io/kube-apiserver` | `v1.29.6` (current release) | +| **karmada-aggregated-apiserver** | `docker.io/karmada/karmada-aggregated-apiserver` | `v${karmadaGitVersion}` | +| **kube-controller-manager** | `registry.k8s.io/kube-controller-manager` | `v1.30.4` (current release) | +| **karmada-controller-manager** | `docker.io/karmada/karmada-controller-manager` | `v${karmadaGitVersion}` | +| **karmada-scheduler** | `docker.io/karmada/karmada-scheduler` | `v${karmadaGitVersion}` | +| **karmada-webhook** | `docker.io/karmada/karmada-webhook` | `v${karmadaGitVersion}` | +| **etcd (Local)** | `registry.k8s.io/etcd` | `3.5.13-0`(current release) | +| **etcd-init-image (Local)** | `docker.io/alpine` | `3.19.1` (current release) | +| **karmada-agent** | `docker.io/karmada/karmada-agent` | `v${karmadaGitVersion}` | + +### Notes + +Karmada reuses some Kubernetes images, such as `etcd`, `kube-controller-manager`, and `kube-apiserver`(also known as `karmada-apiserver`). These images are fetched from the Kubernetes official image registry (registry.k8s.io) by default. + +Karmada routinely upgrades these involved Kubernetes images and includes them in Karmada's test suite to ensure compatibility and stability. + +Karmada-maintained images are fetched from the Karmada official image registry (docker.io/karmada). These images include Karmada's components, such as karmada-controller-manager and karmada-scheduler. + +Various installation tools provided by Karmada support customizing image sources. You can configure to fetch images from private registries or trusted third-party registries. This provides flexibility to ensure smooth deployment of Karmada in different network environments. \ No newline at end of file diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_annotate.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_annotate.md index d481f43d..76f62612 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_annotate.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_annotate.md @@ -53,9 +53,12 @@ karmadactl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_ --field-selector string Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. -f, --filename strings Filename, directory, or URL to files identifying the resource to update the annotation -h, --help help for annotate + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process the kustomization directory. This flag can't be used together with -f or -R. --list If true, display the annotations for a given resource. --local If true, annotation will NOT contact api-server but run locally. + -n, --namespace string If present, the namespace scope for this CLI request. -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). --overwrite If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. @@ -70,7 +73,6 @@ karmadactl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_ ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-resources.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-resources.md index e39bd991..46d6cc13 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-resources.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-resources.md @@ -42,9 +42,11 @@ karmadactl api-resources [flags] --categories strings Limit to resources that belong to the specified categories. --cluster string Used to specify a target member cluster and only takes effect when the command's operation scope is members, for example: --operation-scope=members --cluster=member1 -h, --help help for api-resources + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --namespaced If false, non-namespaced resources will be returned, otherwise returning namespaced resources by default. (default true) --no-headers When using the default or custom-column output format, don't print headers (default print headers). - --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) + -s, --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) -o, --output string Output format. One of: (wide, name). --sort-by string If non-empty, sort list of resources using specified field. The field can be either 'name' or 'kind'. --verbs strings Limit to resources that support the specified verbs. @@ -55,7 +57,6 @@ karmadactl api-resources [flags] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-versions.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-versions.md index 98ac3bf1..34904e7e 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-versions.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_api-versions.md @@ -27,7 +27,9 @@ karmadactl api-versions ``` --cluster string Used to specify a target member cluster and only takes effect when the command's operation scope is members, for example: --operation-scope=members --cluster=member1 -h, --help help for api-versions - --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + -s, --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) ``` ### Options inherited from parent commands @@ -35,7 +37,6 @@ karmadactl api-versions ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_apply.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_apply.md index 6722706c..7441e5ad 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_apply.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_apply.md @@ -53,7 +53,7 @@ karmadactl apply (-f FILENAME | -k DIRECTORY) --karmada-context string The name of the kubeconfig context to use --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process a kustomization directory. This flag can't be used together with -f or -R. - -n, --namespace string If present, the namespace scope for this CLI request + -n, --namespace string If present, the namespace scope for this CLI request. --openapi-patch If true, use openapi to calculate diff when the openapi presents and the resource can be found in the openapi spec. Otherwise, fall back to use baked-in types. (default true) -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). --overwrite Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration (default true) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_attach.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_attach.md index 6ff4c4be..a345e77c 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_attach.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_attach.md @@ -38,8 +38,8 @@ karmadactl attach (POD | TYPE/NAME) -c CONTAINER -h, --help help for attach --karmada-context string The name of the kubeconfig context to use --kubeconfig string Path to the kubeconfig file to use for CLI requests. - -n, --namespace string If present, the namespace scope for this CLI request - --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) + -n, --namespace string If present, the namespace scope for this CLI request. + -s, --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) --pod-running-timeout duration The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running (default 1m0s) -q, --quiet Only print output from the remote session -i, --stdin Pass stdin to the container diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create.md index ed284a43..6b02031c 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create.md @@ -36,7 +36,10 @@ karmadactl create -f FILENAME --field-manager string Name of the manager used to track field ownership. (default "kubectl-create") -f, --filename strings Filename, directory, or URL to files to use to create the resource -h, --help help for create + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process the kustomization directory. This flag can't be used together with -f or -R. + -n, --namespace string If present, the namespace scope for this CLI request. -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). --raw string Raw URI to POST to the server. Uses the transport specified by the kubeconfig file. -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. @@ -48,7 +51,7 @@ karmadactl create -f FILENAME "true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not. "warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise. "false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields. (default "strict") - --windows-line-endings Only relevant if --edit=true. Defaults to the line ending native to your platform. + --windows-line-endings Only relevant if --edit=true. Defaults to the line ending native to your platform. (default true) ``` ### Options inherited from parent commands @@ -56,7 +59,6 @@ karmadactl create -f FILENAME ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrole.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrole.md index a7808a84..237aa654 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrole.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrole.md @@ -61,12 +61,14 @@ karmadactl create clusterrole NAME --verb=verb --resource=resource.group [--reso ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrolebinding.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrolebinding.md index d1dac2ac..8aebfff4 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrolebinding.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_clusterrolebinding.md @@ -45,12 +45,14 @@ karmadactl create clusterrolebinding NAME --clusterrole=NAME [--user=username] [ ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_configmap.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_configmap.md index cd2aed20..ad23277e 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_configmap.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_configmap.md @@ -63,12 +63,14 @@ karmadactl create configmap NAME [--from-file=[key=]source] [--from-literal=key1 ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_cronjob.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_cronjob.md index 48e6b1f8..8f54dbcc 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_cronjob.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_cronjob.md @@ -47,12 +47,14 @@ karmadactl create cronjob NAME --image=image --schedule='0/5 * * * ?' -- [COMMAN ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_deployment.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_deployment.md index 12673f29..1ef85436 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_deployment.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_deployment.md @@ -56,12 +56,14 @@ karmadactl create deployment NAME --image=image -- [COMMAND] [args...] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_ingress.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_ingress.md index 749df24e..3141fec5 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_ingress.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_ingress.md @@ -78,12 +78,14 @@ karmadactl create ingress NAME --rule=host/path=service:port[,tls[=secret]] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_job.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_job.md index 1d4e3123..b8bf57ee 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_job.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_job.md @@ -49,12 +49,14 @@ karmadactl create job NAME --image=image [--from=cronjob/name] -- [COMMAND] [arg ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_namespace.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_namespace.md index 8c85fa37..2315d476 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_namespace.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_namespace.md @@ -41,12 +41,14 @@ karmadactl create namespace NAME [--dry-run=server|client|none] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_poddisruptionbudget.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_poddisruptionbudget.md index 3d9ecfa0..562ed566 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_poddisruptionbudget.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_poddisruptionbudget.md @@ -49,12 +49,14 @@ karmadactl create poddisruptionbudget NAME --selector=SELECTOR --min-available=N ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_priorityclass.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_priorityclass.md index e7961425..b0c17391 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_priorityclass.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_priorityclass.md @@ -51,12 +51,14 @@ karmadactl create priorityclass NAME --value=VALUE --global-default=BOOL [--dry- ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_quota.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_quota.md index e8778093..973b0e25 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_quota.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_quota.md @@ -46,12 +46,14 @@ karmadactl create quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,S ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_role.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_role.md index 1091c652..46705975 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_role.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_role.md @@ -53,12 +53,14 @@ karmadactl create role NAME --verb=verb --resource=resource.group/subresource [- ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_rolebinding.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_rolebinding.md index be2c5d45..ed5aa4e6 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_rolebinding.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_rolebinding.md @@ -49,12 +49,14 @@ karmadactl create rolebinding NAME --clusterrole=NAME|--role=NAME [--user=userna ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret.md index a2c7a600..d9f47012 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret.md @@ -29,12 +29,14 @@ karmadactl create secret (docker-registry | generic | tls) ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_docker-registry.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_docker-registry.md index 89342043..3375aa7c 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_docker-registry.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_docker-registry.md @@ -61,12 +61,14 @@ karmadactl create secret docker-registry NAME --docker-username=user --docker-pa ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_generic.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_generic.md index 5f7ccbef..00eaba69 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_generic.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_generic.md @@ -64,12 +64,14 @@ karmadactl create secret generic NAME [--type=string] [--from-file=[key=]source] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_tls.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_tls.md index cdbc649a..35cde10f 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_tls.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_secret_tls.md @@ -46,12 +46,14 @@ karmadactl create secret tls NAME --cert=path/to/cert/file --key=path/to/key/fil ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service.md index b1e20309..dd7a18ef 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service.md @@ -23,12 +23,14 @@ karmadactl create service [flags] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_clusterip.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_clusterip.md index 8e5cb07a..a34c2a89 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_clusterip.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_clusterip.md @@ -46,12 +46,14 @@ karmadactl create service clusterip NAME [--tcp=:] [--dry-run= ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_externalname.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_externalname.md index 17b8ee5a..2b998d64 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_externalname.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_externalname.md @@ -45,12 +45,14 @@ karmadactl create service externalname NAME --external-name external.name [--dry ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_loadbalancer.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_loadbalancer.md index e817cfc2..66efa7b3 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_loadbalancer.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_loadbalancer.md @@ -42,12 +42,14 @@ karmadactl create service loadbalancer NAME [--tcp=port:targetPort] [--dry-run=s ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_nodeport.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_nodeport.md index 17a8239d..6dc4e452 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_nodeport.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_service_nodeport.md @@ -43,12 +43,14 @@ karmadactl create service nodeport NAME [--tcp=port:targetPort] [--dry-run=serve ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_serviceaccount.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_serviceaccount.md index 75dcf5f5..044c4652 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_serviceaccount.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_serviceaccount.md @@ -41,12 +41,14 @@ karmadactl create serviceaccount NAME [--dry-run=server|client|none] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_token.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_token.md index 3ba95311..eaec5a7b 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_token.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_create_token.md @@ -54,12 +54,14 @@ karmadactl create token SERVICE_ACCOUNT_NAME ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. --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) + -n, --namespace string If present, the namespace scope for this CLI request. --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) --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_delete.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_delete.md index a29cb9d4..90a090c9 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_delete.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_delete.md @@ -67,7 +67,10 @@ karmadactl delete ([-f FILENAME] | [-k DIRECTORY] | TYPE [(NAME | -l label | --a -h, --help help for delete --ignore-not-found Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. -i, --interactive If true, delete resource only when user confirms. + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process a kustomization directory. This flag can't be used together with -f or -R. + -n, --namespace string If present, the namespace scope for this CLI request. --now If true, resources are signaled for immediate shutdown (same as --grace-period=1). -o, --output string Output mode. Use "-o name" for shorter output (resource/name). --raw string Raw URI to DELETE to the server. Uses the transport specified by the kubeconfig file. @@ -82,7 +85,6 @@ karmadactl delete ([-f FILENAME] | [-k DIRECTORY] | TYPE [(NAME | -l label | --a ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_describe.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_describe.md index b4950fb5..484c30f6 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_describe.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_describe.md @@ -52,8 +52,8 @@ karmadactl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) (- --karmada-context string The name of the kubeconfig context to use --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process the kustomization directory. This flag can't be used together with -f or -R. - -n, --namespace string If present, the namespace scope for this CLI request - --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) + -n, --namespace string If present, the namespace scope for this CLI request. + -s, --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -l, --selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints. --show-events If true, display events related to the described object. (default true) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_edit.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_edit.md index 72f96d3d..7389fbe8 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_edit.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_edit.md @@ -50,7 +50,10 @@ karmadactl edit (RESOURCE/NAME | -f FILENAME) --field-manager string Name of the manager used to track field ownership. (default "kubectl-edit") -f, --filename strings Filename, directory, or URL to files to use to edit the resource -h, --help help for edit + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process the kustomization directory. This flag can't be used together with -f or -R. + -n, --namespace string If present, the namespace scope for this CLI request. -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). --output-patch Output the patch if the resource is edited. -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. @@ -62,7 +65,7 @@ karmadactl edit (RESOURCE/NAME | -f FILENAME) "true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not. "warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise. "false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields. (default "strict") - --windows-line-endings Defaults to the line ending native to your platform. + --windows-line-endings Defaults to the line ending native to your platform. (default true) ``` ### Options inherited from parent commands @@ -70,7 +73,6 @@ karmadactl edit (RESOURCE/NAME | -f FILENAME) ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_exec.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_exec.md index 7455cb1b..5d4016c7 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_exec.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_exec.md @@ -47,8 +47,8 @@ karmadactl exec (POD | TYPE/NAME) [-c CONTAINER] (-C CLUSTER) -- COMMAND [args.. -h, --help help for exec --karmada-context string The name of the kubeconfig context to use --kubeconfig string Path to the kubeconfig file to use for CLI requests. - -n, --namespace string If present, the namespace scope for this CLI request - --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) + -n, --namespace string If present, the namespace scope for this CLI request. + -s, --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) --pod-running-timeout duration The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running (default 1m0s) -q, --quiet Only print output from the remote session -i, --stdin Pass stdin to the container diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_explain.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_explain.md index ed77b5f5..9efe44bc 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_explain.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_explain.md @@ -43,8 +43,10 @@ karmadactl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-grou --api-version string Use given api-version (group/version) of the resource. --cluster string Used to specify a target member cluster and only takes effect when the command's operation scope is member clusters, for example: --operation-scope=all --cluster=member1 -h, --help help for explain - -n, --namespace string If present, the namespace scope for this CLI request - --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + -n, --namespace string If present, the namespace scope for this CLI request. + -s, --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada and members. Defaults to karmada. (default karmada) --output string Format in which to render the schema. Valid values are: (plaintext, plaintext-openapiv2). (default "plaintext") --recursive When true, print the name of all the fields recursively. Otherwise, print the available fields with their description. ``` @@ -54,7 +56,6 @@ karmadactl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-grou ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_get.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_get.md index b0dd1346..20c6b0d6 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_get.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_get.md @@ -59,9 +59,9 @@ karmadactl get [NAME | -l label | -n namespace] --kubeconfig string Path to the kubeconfig file to use for CLI requests. -L, --label-columns strings Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... -l, --labels string -l=label or -l label - -n, --namespace string If present, the namespace scope for this CLI request + -n, --namespace string If present, the namespace scope for this CLI request. --no-headers When using the default or custom-column output format, don't print headers (default print headers). - --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada, members, and all. Defaults to karmada. (default karmada) + -s, --operation-scope operationScope Used to control the operation scope of the command. The optional values are karmada, members, and all. Defaults to karmada. (default karmada) -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). See custom columns [https://kubernetes.io/docs/reference/kubectl/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/]. --output-watch-events Output watch event objects when --watch or --watch-only is used. Existing objects are output as initial ADDED events. --show-kind If present, list the resource type for the requested object(s). diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_init.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_init.md index 6436dd13..814147e9 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_init.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_init.md @@ -8,7 +8,7 @@ Install the Karmada control plane in a Kubernetes cluster Install the Karmada control plane in a Kubernetes cluster. - By default, the images and CRD tarball are downloaded remotely. For offline installation, you can set '--private-image-registry' and '--crds'. +By default, the images and CRD tarball are downloaded remotely. For offline installation, you can set '--private-image-registry' and '--crds'. ``` karmadactl init @@ -53,6 +53,9 @@ karmadactl init # Specify external IPs(load balancer or HA IP) which used to sign the certificate karmadactl init --cert-external-ip 10.235.1.2 --cert-external-dns www.karmada.io + + # Install Karmada using a configuration file + karmadactl init --config /path/to/your/config/file.yaml ``` ### Options @@ -63,12 +66,13 @@ karmadactl init --cert-external-dns string the external DNS of Karmada certificate (e.g localhost,localhost.com) --cert-external-ip string the external IP of Karmada certificate (e.g 192.168.1.2,172.16.1.2) --cert-validity-period duration the validity period of Karmada certificate (e.g 8760h0m0s, that is 365 days) (default 8760h0m0s) + --config string Karmada init file path --context string The name of the kubeconfig context to use --crds string Karmada crds resource.(local file e.g. --crds /root/crds.tar.gz) (default "https://github.com/karmada-io/karmada/releases/download/v0.0.0-master/crds.tar.gz") --etcd-data string etcd data path,valid in hostPath mode. (default "/var/lib/karmada-etcd") --etcd-image string etcd image --etcd-init-image string etcd init container image (default "docker.io/alpine:3.19.1") - --etcd-node-selector-labels string etcd pod select the labels of the node. valid in hostPath mode ( e.g. --etcd-node-selector-labels karmada.io/etcd=true) + --etcd-node-selector-labels string the labels used for etcd pod to select nodes, valid in hostPath mode, and with each label separated by a comma. ( e.g. --etcd-node-selector-labels karmada.io/etcd=true,kubernetes.io/os=linux) --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") @@ -98,7 +102,7 @@ karmadactl init --karmada-webhook-replicas int32 Karmada webhook replica set (default 1) --kube-image-mirror-country string Country code of the kube image registry to be used. For Chinese mainland users, set it to cn --kube-image-registry string Kube image registry. For Chinese mainland users, you may use local gcr.io mirrors such as registry.cn-hangzhou.aliyuncs.com/google_containers to override default kube image registry - --kube-image-tag string Choose a specific Kubernetes version for the control plane. (default "v1.29.6") + --kube-image-tag string Choose a specific Kubernetes version for the control plane. (default "v1.30.4") --kubeconfig string absolute path to the kubeconfig file -n, --namespace string Kubernetes namespace (default "karmada-system") -p, --port int32 Karmada apiserver service node port (default 32443) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_label.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_label.md index 527808da..45035aee 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_label.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_label.md @@ -51,9 +51,12 @@ karmadactl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=V --field-selector string Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. -f, --filename strings Filename, directory, or URL to files identifying the resource to update the labels -h, --help help for label + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process the kustomization directory. This flag can't be used together with -f or -R. --list If true, display the labels for a given resource. --local If true, label will NOT contact api-server but run locally. + -n, --namespace string If present, the namespace scope for this CLI request. -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). --overwrite If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. @@ -68,7 +71,6 @@ karmadactl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=V ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_logs.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_logs.md index 12ee04d5..d2050b76 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_logs.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_logs.md @@ -54,7 +54,7 @@ karmadactl logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER] (-C CLUSTER) --kubeconfig string Path to the kubeconfig file to use for CLI requests. --limit-bytes int Maximum bytes of logs to return. Defaults to no limit. --max-log-requests int Specify maximum number of concurrent logs to follow when using by a selector. Defaults to 5. (default 5) - -n, --namespace string If present, the namespace scope for this CLI request + -n, --namespace string If present, the namespace scope for this CLI request. --pod-running-timeout duration The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running (default 20s) --prefix Prefix each log line with the log source (pod name and container name) -p, --previous If true, print the logs for the previous instance of the container in a pod if it exists. diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_patch.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_patch.md index 0e68c07a..6525841c 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_patch.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_patch.md @@ -43,8 +43,11 @@ karmadactl patch (-f FILENAME | TYPE NAME) [-p PATCH|--patch-file FILE] --field-manager string Name of the manager used to track field ownership. (default "kubectl-patch") -f, --filename strings Filename, directory, or URL to files identifying the resource to update -h, --help help for patch + --karmada-context string The name of the kubeconfig context to use + --kubeconfig string Path to the kubeconfig file to use for CLI requests. -k, --kustomize string Process the kustomization directory. This flag can't be used together with -f or -R. --local If true, patch will operate on the content of the file, not the server-side resource. + -n, --namespace string If present, the namespace scope for this CLI request. -o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). -p, --patch string The patch to be applied to the resource JSON file. --patch-file string A file containing a patch to be applied to the resource. @@ -60,7 +63,6 @@ karmadactl patch (-f FILENAME | TYPE NAME) [-p PATCH|--patch-file FILE] ``` --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) - --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --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) diff --git a/docs/reference/karmadactl/karmadactl-commands/karmadactl_promote.md b/docs/reference/karmadactl/karmadactl-commands/karmadactl_promote.md index c53b487f..ffb780ad 100644 --- a/docs/reference/karmadactl/karmadactl-commands/karmadactl_promote.md +++ b/docs/reference/karmadactl/karmadactl-commands/karmadactl_promote.md @@ -51,7 +51,7 @@ karmadactl promote -n -C