Update CLI docs
This commit is contained in:
Mario Manno
parent
3eaf241c9d
commit
ba45d12c89
|
|
@ -13,12 +13,21 @@ fleet-agent [flags]
|
|||
### Options
|
||||
|
||||
```
|
||||
--agent-scope string An identifier used to scope the agent bundleID names, typically the same as namespace
|
||||
--checkin-interval string How often to post cluster status
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
-h, --help help for fleet-agent
|
||||
--kubeconfig string kubeconfig file
|
||||
--namespace string namespace to watch
|
||||
--agent-scope string An identifier used to scope the agent bundleID names, typically the same as namespace
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
-h, --help help for fleet-agent
|
||||
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
|
||||
--namespace string system namespace is the namespace, the agent runs in, e.g. cattle-fleet-system
|
||||
--zap-devel Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error) (default true)
|
||||
--zap-encoder encoder Zap log encoding (one of 'json' or 'console')
|
||||
--zap-log-level level Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
|
||||
--zap-stacktrace-level level Zap Level at and above which stacktraces are captured (one of 'info', 'error', 'panic').
|
||||
--zap-time-encoding time-encoding Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet-agent clusterstatus](./fleet-agent_clusterstatus) - Continuously report resource status to the upstream cluster
|
||||
* [fleet-agent register](./fleet-agent_register) - Register agent with an upstream cluster
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: ""
|
||||
sidebar_label: "fleet-agent clusterstatus"
|
||||
---
|
||||
## fleet-agent clusterstatus
|
||||
|
||||
Continuously report resource status to the upstream cluster
|
||||
|
||||
```
|
||||
fleet-agent clusterstatus [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--checkin-interval string How often to post cluster status
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
-h, --help help for clusterstatus
|
||||
--kubeconfig string kubeconfig file for agent's cluster
|
||||
--namespace string system namespace is the namespace, the agent runs in, e.g. cattle-fleet-system
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--agent-scope string An identifier used to scope the agent bundleID names, typically the same as namespace
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet-agent](./fleet-agent) -
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: ""
|
||||
sidebar_label: "fleet-agent register"
|
||||
---
|
||||
## fleet-agent register
|
||||
|
||||
Register agent with an upstream cluster
|
||||
|
||||
```
|
||||
fleet-agent register [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
-h, --help help for register
|
||||
--kubeconfig string kubeconfig file for agent's cluster
|
||||
--namespace string system namespace is the namespace, the agent runs in, e.g. cattle-fleet-system
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--agent-scope string An identifier used to scope the agent bundleID names, typically the same as namespace
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet-agent](./fleet-agent) -
|
||||
|
||||
|
|
@ -13,18 +13,13 @@ fleet [flags]
|
|||
### Options
|
||||
|
||||
```
|
||||
--context string kubeconfig context for authentication
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
-h, --help help for fleet
|
||||
-k, --kubeconfig string kubeconfig for authentication
|
||||
-n, --namespace string namespace (default "fleet-local")
|
||||
--system-namespace string System namespace of the controller (default "cattle-fleet-system")
|
||||
-h, --help help for fleet
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet apply](./fleet_apply) - Render a bundle into a Kubernetes resource and apply it in the Fleet Manager
|
||||
* [fleet cleanup](./fleet_cleanup) - Clean up outdated cluster registrations
|
||||
* [fleet test](./fleet_test) - Match a bundle to a target and render the output
|
||||
* [fleet deploy](./fleet_deploy) - Deploy a bundledeployment/content resource to a cluster, by creating a Helm release. This will not deploy the bundledeployment/content resources directly to the cluster.
|
||||
* [fleet target](./fleet_target) - Print available targets for a bundle
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ fleet apply [flags] BUNDLE_NAME PATH...
|
|||
--cacerts-file string Path of custom cacerts for helm repo
|
||||
--commit string Commit to assign to the bundle
|
||||
-c, --compress Force all resources to be compress
|
||||
--context string kubeconfig context for authentication
|
||||
--correct-drift Rollback any change made from outside of Fleet
|
||||
--correct-drift-force Use --force when correcting drift. Resources can be deleted and recreated
|
||||
--correct-drift-keep-fail-history Keep helm history for failed rollbacks
|
||||
|
|
@ -27,7 +28,9 @@ fleet apply [flags] BUNDLE_NAME PATH...
|
|||
--helm-repo-url-regex string Helm credentials will be used if the helm repo matches this regex. Credentials will always be used if this is empty or not provided
|
||||
-h, --help help for apply
|
||||
--keep-resources Keep resources created after the GitRepo or Bundle is deleted
|
||||
-k, --kubeconfig string kubeconfig for authentication
|
||||
-l, --label strings Labels to apply to created bundles
|
||||
-n, --namespace string namespace (default "fleet-local")
|
||||
-o, --output string Output contents to file or - for stdout
|
||||
--password-file string Path of file containing basic auth password for helm repo
|
||||
--paused Create bundles in a paused state
|
||||
|
|
@ -39,15 +42,6 @@ fleet apply [flags] BUNDLE_NAME PATH...
|
|||
--username string Basic auth username for helm repo
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--context string kubeconfig context for authentication
|
||||
-k, --kubeconfig string kubeconfig for authentication
|
||||
-n, --namespace string namespace (default "fleet-local")
|
||||
--system-namespace string System namespace of the controller (default "cattle-fleet-system")
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet](./fleet) -
|
||||
|
|
|
|||
|
|
@ -13,21 +13,15 @@ fleet cleanup [flags]
|
|||
### Options
|
||||
|
||||
```
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
--factor string Factor to increase delay between deletes (default: 1.1)
|
||||
-h, --help help for cleanup
|
||||
--max string Maximum delay between deletes (default: 5s)
|
||||
--min string Minimum delay between deletes (default: 10ms)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--context string kubeconfig context for authentication
|
||||
-k, --kubeconfig string kubeconfig for authentication
|
||||
-n, --namespace string namespace (default "fleet-local")
|
||||
--system-namespace string System namespace of the controller (default "cattle-fleet-system")
|
||||
--context string kubeconfig context for authentication
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
--factor string Factor to increase delay between deletes (default: 1.1)
|
||||
-h, --help help for cleanup
|
||||
-k, --kubeconfig string kubeconfig for authentication
|
||||
--max string Maximum delay between deletes (default: 5s)
|
||||
--min string Minimum delay between deletes (default: 10ms)
|
||||
-n, --namespace string namespace (default "fleet-local")
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
|
|
|||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: ""
|
||||
sidebar_label: "fleet deploy"
|
||||
---
|
||||
## fleet deploy
|
||||
|
||||
Deploy a bundledeployment/content resource to a cluster, by creating a Helm release. This will not deploy the bundledeployment/content resources directly to the cluster.
|
||||
|
||||
```
|
||||
fleet deploy [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-a, --agent-namespace string Set the agent namespace, normally cattle-fleet-system. If set, fleet agent will garbage collect the helm release, i.e. delete it if the bundledeployment is missing.
|
||||
-d, --dry-run Print the resources that would be deployed, but do not actually deploy them
|
||||
-h, --help help for deploy
|
||||
-i, --input-file string Location of the YAML file containing the content and the bundledeployment resource
|
||||
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
|
||||
-n, --namespace string Set the default namespace. Deploy helm chart into this namespace.
|
||||
--zap-devel Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error) (default true)
|
||||
--zap-encoder encoder Zap log encoding (one of 'json' or 'console')
|
||||
--zap-log-level level Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
|
||||
--zap-stacktrace-level level Zap Level at and above which stacktraces are captured (one of 'info', 'error', 'panic').
|
||||
--zap-time-encoding time-encoding Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet](./fleet) -
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: ""
|
||||
sidebar_label: "fleet target"
|
||||
---
|
||||
## fleet target
|
||||
|
||||
Print available targets for a bundle
|
||||
|
||||
```
|
||||
fleet target [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-b, --bundle-file string Location of the Bundle resource yaml
|
||||
-l, --dump-input-list Dump the live resources, which impact targeting, like clusters, as YAML
|
||||
-h, --help help for target
|
||||
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
|
||||
-n, --namespace string Override the namespace of the bundle. Targeting searches this namespace for clusters.
|
||||
--zap-devel Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error) (default true)
|
||||
--zap-encoder encoder Zap log encoding (one of 'json' or 'console')
|
||||
--zap-log-level level Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
|
||||
--zap-stacktrace-level level Zap Level at and above which stacktraces are captured (one of 'info', 'error', 'panic').
|
||||
--zap-time-encoding time-encoding Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet](./fleet) -
|
||||
|
||||
|
|
@ -4,7 +4,7 @@ sidebar_label: "fleet test"
|
|||
---
|
||||
## fleet test
|
||||
|
||||
Match a bundle to a target and render the output
|
||||
Match a bundle to a target and render the output (deprecated)
|
||||
|
||||
```
|
||||
fleet test [flags]
|
||||
|
|
@ -14,8 +14,6 @@ fleet test [flags]
|
|||
|
||||
```
|
||||
-b, --bundle-file string Location of the raw Bundle resource yaml
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
-f, --file string Location of the fleet.yaml
|
||||
-g, --group string Cluster group to match against
|
||||
-L, --group-label strings Cluster group labels to match against
|
||||
|
|
@ -26,15 +24,6 @@ fleet test [flags]
|
|||
-t, --target string Explicit target to match
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--context string kubeconfig context for authentication
|
||||
-k, --kubeconfig string kubeconfig for authentication
|
||||
-n, --namespace string namespace (default "fleet-local")
|
||||
--system-namespace string System namespace of the controller (default "cattle-fleet-system")
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet](./fleet) -
|
||||
|
|
|
|||
|
|
@ -13,12 +13,21 @@ fleet-manager [flags]
|
|||
### Options
|
||||
|
||||
```
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
--disable-bootstrap disable local cluster components
|
||||
--disable-gitops disable gitops components
|
||||
-h, --help help for fleet-manager
|
||||
--kubeconfig string Kubeconfig file
|
||||
--namespace string namespace to watch (default "cattle-fleet-system")
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
--disable-gitops disable gitops components
|
||||
-h, --help help for fleet-manager
|
||||
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
|
||||
--namespace string namespace to watch (default "cattle-fleet-system")
|
||||
--zap-devel Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error) (default true)
|
||||
--zap-encoder encoder Zap log encoding (one of 'json' or 'console')
|
||||
--zap-log-level level Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
|
||||
--zap-stacktrace-level level Zap Level at and above which stacktraces are captured (one of 'info', 'error', 'panic').
|
||||
--zap-time-encoding time-encoding Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet-manager agentmanagement](./fleet-manager_agentmanagement) -
|
||||
* [fleet-manager cleanup](./fleet-manager_cleanup) -
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: ""
|
||||
sidebar_label: "fleet-manager agentmanagement"
|
||||
---
|
||||
## fleet-manager agentmanagement
|
||||
|
||||
|
||||
|
||||
```
|
||||
fleet-manager agentmanagement [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--disable-bootstrap disable local cluster components
|
||||
-h, --help help for agentmanagement
|
||||
--kubeconfig string kubeconfig file
|
||||
--namespace string namespace to watch
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
--disable-gitops disable gitops components
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet-manager](./fleet-manager) -
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: ""
|
||||
sidebar_label: "fleet-manager cleanup"
|
||||
---
|
||||
## fleet-manager cleanup
|
||||
|
||||
|
||||
|
||||
```
|
||||
fleet-manager cleanup [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for cleanup
|
||||
--kubeconfig string kubeconfig file
|
||||
--namespace string namespace to watch
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--debug Turn on debug logging
|
||||
--debug-level int If debugging is enabled, set klog -v=X
|
||||
--disable-gitops disable gitops components
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [fleet-manager](./fleet-manager) -
|
||||
|
||||
22
sidebars.js
22
sidebars.js
|
|
@ -54,17 +54,19 @@ module.exports = {
|
|||
collapsed: false,
|
||||
items:[
|
||||
{
|
||||
'CLI':
|
||||
[
|
||||
{type: 'doc', id: 'cli/fleet-agent/fleet-agent'},
|
||||
{
|
||||
'fleet-gitjob-cli': [
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet'},
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet_apply'},
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet_test'},
|
||||
],
|
||||
},
|
||||
'CLI': [
|
||||
'cli/fleet-agent/fleet-agent',
|
||||
'cli/fleet-agent/fleet-agent_clusterstatus',
|
||||
'cli/fleet-agent/fleet-agent_register',
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet'},
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet_apply'},
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet_cleanup'},
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet_deploy'},
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet_target'},
|
||||
{type: 'doc', id: 'cli/fleet-cli/fleet_test'},
|
||||
{type: 'doc', id: 'cli/fleet-controller/fleet-manager'},
|
||||
{type: 'doc', id: 'cli/fleet-controller/fleet-manager_agentmanagement'},
|
||||
{type: 'doc', id: 'cli/fleet-controller/fleet-manager_cleanup'},
|
||||
],
|
||||
},
|
||||
{type:'doc', id:'cluster-bundles-state'},
|
||||
|
|
|
|||
Loading…
Reference in New Issue