Skip to content
This repository was archived by the owner on Jun 29, 2022. It is now read-only.

cli/cmd: improve --kubeconfig-file flag help message formatting #818

Merged
invidian merged 1 commit into from
Aug 21, 2020
Merged

cli/cmd: improve --kubeconfig-file flag help message formatting #818

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cli/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ func init() {
RootCmd.PersistentFlags().String(
kubeconfigFlag,
"", // Special empty default, use getKubeconfig()
`Path to a kubeconfig file. If empty, the following precedence order is `+
`used: 1. cluster asset dir when a lokocfg file is present in the `+
`current directory 2. KUBECONFIG environment variable 3. `+
`"~/.kube/config"`)
"Path to a kubeconfig file. If empty, the following precedence order is used:\n"+
" 1. Cluster asset dir when a lokocfg file is present in the current directory.\n"+
" 2. KUBECONFIG environment variable.\n"+
" 3. ~/.kube/config file.")

if err := viper.BindPFlag(kubeconfigFlag, RootCmd.PersistentFlags().Lookup(kubeconfigFlag)); err != nil {
panic("failed registering kubeconfig flag")
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ Manage Lokomotive clusters

```
-h, --help help for lokoctl
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ Manage a cluster
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_cluster_apply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ lokoctl cluster apply [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_cluster_destroy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ lokoctl cluster destroy [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ Manage components
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_component_apply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ lokoctl component apply [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_component_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ lokoctl component delete [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_component_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ lokoctl component list [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_component_render-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ lokoctl component render-manifest [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_health.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ lokoctl health [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down
5 changes: 4 additions & 1 deletion docs/cli/lokoctl_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ lokoctl version [flags]
### Options inherited from parent commands

```
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used: 1. cluster asset dir when a lokocfg file is present in the current directory 2. KUBECONFIG environment variable 3. "~/.kube/config"
--kubeconfig-file string Path to a kubeconfig file. If empty, the following precedence order is used:
1. Cluster asset dir when a lokocfg file is present in the current directory.
2. KUBECONFIG environment variable.
3. ~/.kube/config file.
--lokocfg string Path to lokocfg directory or file (default "./")
--lokocfg-vars string Path to lokocfg.vars file (default "./lokocfg.vars")
```
Expand Down