-
Notifications
You must be signed in to change notification settings - Fork 135
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs for voyagermesh/cli@64ac3b4c (#1601)
Signed-off-by: 1gtm <1gtm@appscode.com>
- Loading branch information
Showing
6 changed files
with
219 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
title: Reference | Voyager CLI | ||
description: Voyager CLI Reference | ||
menu: | ||
docs_{{ .version }}: | ||
identifier: reference-cli | ||
name: Voyager CLI | ||
weight: 30 | ||
parent: reference | ||
menu_name: docs_{{ .version }} | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
title: Voyager | ||
menu: | ||
docs_{{ .version }}: | ||
identifier: voyager | ||
name: Voyager | ||
parent: reference-cli | ||
weight: 0 | ||
|
||
menu_name: docs_{{ .version }} | ||
section_menu_id: reference | ||
url: /docs/{{ .version }}/reference/cli/ | ||
aliases: | ||
- /docs/{{ .version }}/reference/cli/voyager/ | ||
--- | ||
## voyager | ||
|
||
Voyager cli by AppsCode | ||
|
||
### Options | ||
|
||
``` | ||
--enable-analytics Send analytical events to Google Analytics (default true) | ||
-h, --help help for voyager | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [voyager check](/docs/reference/cli/voyager_check.md) - Check Ingress | ||
* [voyager completion](/docs/reference/cli/voyager_completion.md) - Generate completion script | ||
* [voyager convert](/docs/reference/cli/voyager_convert.md) - Convert v1beta1 to v1 api version | ||
* [voyager version](/docs/reference/cli/voyager_version.md) - Prints binary version number. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Voyager Check | ||
menu: | ||
docs_{{ .version }}: | ||
identifier: voyager-check | ||
name: Voyager Check | ||
parent: reference-cli | ||
menu_name: docs_{{ .version }} | ||
section_menu_id: reference | ||
--- | ||
## voyager check | ||
|
||
Check Ingress | ||
|
||
``` | ||
voyager check [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-c, --cloud-provider string Name of cloud provider | ||
--from-file string YAML formatted file containing ingress | ||
-h, --help help for check | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--enable-analytics Send analytical events to Google Analytics (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [voyager](/docs/reference/cli/voyager.md) - Voyager cli by AppsCode | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
title: Voyager Completion | ||
menu: | ||
docs_{{ .version }}: | ||
identifier: voyager-completion | ||
name: Voyager Completion | ||
parent: reference-cli | ||
menu_name: docs_{{ .version }} | ||
section_menu_id: reference | ||
--- | ||
## voyager completion | ||
|
||
Generate completion script | ||
|
||
### Synopsis | ||
|
||
To load completions: | ||
|
||
Bash: | ||
|
||
$ source <(kubectl-voyager completion bash) | ||
|
||
# To load completions for each session, execute once: | ||
Linux: | ||
$ kubectl-voyager completion bash > /etc/bash_completion.d/kubectl-voyager | ||
MacOS: | ||
$ kubectl-voyager completion bash > /usr/local/etc/bash_completion.d/kubectl-voyager | ||
|
||
Zsh: | ||
|
||
# If shell completion is not already enabled in your environment you will need | ||
# to enable it. You can execute the following once: | ||
|
||
$ echo "autoload -U compinit; compinit" >> ~/.zshrc | ||
|
||
# To load completions for each session, execute once: | ||
$ kubectl-voyager completion zsh > "${fpath[1]}/_kubectl-voyager" | ||
|
||
# You will need to start a new shell for this setup to take effect. | ||
|
||
Fish: | ||
|
||
$ kubectl-voyager completion fish | source | ||
|
||
# To load completions for each session, execute once: | ||
$ kubectl-voyager completion fish > ~/.config/fish/completions/kubectl-voyager.fish | ||
|
||
|
||
``` | ||
voyager completion [bash|zsh|fish|powershell] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for completion | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--enable-analytics Send analytical events to Google Analytics (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [voyager](/docs/reference/cli/voyager.md) - Voyager cli by AppsCode | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: Voyager Convert | ||
menu: | ||
docs_{{ .version }}: | ||
identifier: voyager-convert | ||
name: Voyager Convert | ||
parent: reference-cli | ||
menu_name: docs_{{ .version }} | ||
section_menu_id: reference | ||
--- | ||
## voyager convert | ||
|
||
Convert v1beta1 to v1 api version | ||
|
||
``` | ||
voyager convert [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-f, --from-file string YAML formatted file containing ingress | ||
-h, --help help for convert | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--enable-analytics Send analytical events to Google Analytics (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [voyager](/docs/reference/cli/voyager.md) - Voyager cli by AppsCode | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Voyager Version | ||
menu: | ||
docs_{{ .version }}: | ||
identifier: voyager-version | ||
name: Voyager Version | ||
parent: reference-cli | ||
menu_name: docs_{{ .version }} | ||
section_menu_id: reference | ||
--- | ||
## voyager version | ||
|
||
Prints binary version number. | ||
|
||
``` | ||
voyager version [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--check string Check version constraint | ||
-h, --help help for version | ||
--short Print just the version number. | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--enable-analytics Send analytical events to Google Analytics (default true) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [voyager](/docs/reference/cli/voyager.md) - Voyager cli by AppsCode | ||
|