From e6a3f042bb1bf6b3077de8959e4ba55cae5dc9e8 Mon Sep 17 00:00:00 2001
From: Jessica Yao <jessica@heptio.com>
Date: Thu, 30 Nov 2017 05:24:31 -0800
Subject: [PATCH] update root description
Signed-off-by: Jessica Yao <jessica@heptio.com>
---
cmd/root.go | 10 ++++++++--
docs/cli-reference/ks.md | 9 +++++++--
docs/cli-reference/ks_apply.md | 4 ++--
docs/cli-reference/ks_delete.md | 4 ++--
docs/cli-reference/ks_diff.md | 2 +-
docs/cli-reference/ks_env.md | 4 ++--
docs/cli-reference/ks_env_add.md | 2 +-
docs/cli-reference/ks_env_list.md | 2 +-
docs/cli-reference/ks_env_rm.md | 2 +-
docs/cli-reference/ks_env_set.md | 2 +-
docs/cli-reference/ks_generate.md | 2 +-
docs/cli-reference/ks_init.md | 4 ++--
docs/cli-reference/ks_param.md | 2 +-
docs/cli-reference/ks_pkg.md | 2 +-
docs/cli-reference/ks_prototype.md | 2 +-
docs/cli-reference/ks_registry.md | 2 +-
docs/cli-reference/ks_show.md | 2 +-
docs/cli-reference/ks_validate.md | 4 ++--
docs/cli-reference/ks_version.md | 2 +-
19 files changed, 37 insertions(+), 26 deletions(-)
diff --git a/cmd/root.go b/cmd/root.go
index adeed59a..6d6cbb98 100644
--- a/cmd/root.go
+++ b/cmd/root.go
@@ -91,14 +91,20 @@ func bindJsonnetFlags(cmd *cobra.Command) {
func bindClientGoFlags(cmd *cobra.Command) {
kflags := clientcmd.RecommendedConfigOverrideFlags("")
ep := &loadingRules.ExplicitPath
- cmd.PersistentFlags().StringVar(ep, "kubeconfig", "", "Path to a kube config. Only required if out-of-cluster")
+ cmd.PersistentFlags().StringVar(ep, "kubeconfig", "", "Path to a kubeconfig file. Alternative to env var $KUBECONFIG.")
clientcmd.BindOverrideFlags(&overrides, cmd.PersistentFlags(), kflags)
}
// RootCmd is the root of cobra subcommand tree
var RootCmd = &cobra.Command{
Use: "ks",
- Short: "Synchronise Kubernetes resources with config files",
+ Short: `Configure your application to deploy to a Kubernetes cluster`,
+ Long: `
+You can use the ` + "`ks`" + ` commands to write, share, and deploy your Kubernetes
+application configuration to remote clusters.
+
+----
+`,
SilenceErrors: true,
SilenceUsage: true,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
diff --git a/docs/cli-reference/ks.md b/docs/cli-reference/ks.md
index 44d108cf..6a0c4e56 100644
--- a/docs/cli-reference/ks.md
+++ b/docs/cli-reference/ks.md
@@ -1,11 +1,16 @@
## ks
-Synchronise Kubernetes resources with config files
+Configure your application to deploy to a Kubernetes cluster
### Synopsis
-Synchronise Kubernetes resources with config files
+
+You can use the `ks` commands to write, share, and deploy your Kubernetes
+application configuration to remote clusters.
+
+----
+
### Options
diff --git a/docs/cli-reference/ks_apply.md b/docs/cli-reference/ks_apply.md
index f168444c..5de917c5 100644
--- a/docs/cli-reference/ks_apply.md
+++ b/docs/cli-reference/ks_apply.md
@@ -79,7 +79,7 @@ ks apply dev -c guestbook-ui -c nginx-depl --create false
--gc-tag string A tag that's (1) added to all updated objects (2) used to garbage collect existing objects that are no longer in the manifest
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
-J, --jpath stringSlice Additional jsonnet library search path
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
@@ -101,5 +101,5 @@ ks apply dev -c guestbook-ui -c nginx-depl --create false
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
diff --git a/docs/cli-reference/ks_delete.md b/docs/cli-reference/ks_delete.md
index 117c9b26..e7f8d71e 100644
--- a/docs/cli-reference/ks_delete.md
+++ b/docs/cli-reference/ks_delete.md
@@ -56,7 +56,7 @@ ks delete --kubeconfig=./kubeconfig -c nginx
--grace-period int Number of seconds given to resources to terminate gracefully. A negative value is ignored (default -1)
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
-J, --jpath stringSlice Additional jsonnet library search path
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
@@ -77,5 +77,5 @@ ks delete --kubeconfig=./kubeconfig -c nginx
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
diff --git a/docs/cli-reference/ks_diff.md b/docs/cli-reference/ks_diff.md
index c64fc003..e8ae9858 100644
--- a/docs/cli-reference/ks_diff.md
+++ b/docs/cli-reference/ks_diff.md
@@ -70,5 +70,5 @@ ks diff --kubeconfig=./kubeconfig -f ./pod.yaml
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
diff --git a/docs/cli-reference/ks_env.md b/docs/cli-reference/ks_env.md
index 69b152cf..176763dc 100644
--- a/docs/cli-reference/ks_env.md
+++ b/docs/cli-reference/ks_env.md
@@ -56,7 +56,7 @@ ks env
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
@@ -73,7 +73,7 @@ ks env
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
* [ks env add](ks_env_add.md) - Add a new environment to a ksonnet application
* [ks env list](ks_env_list.md) - List all environments in a ksonnet application
* [ks env rm](ks_env_rm.md) - Delete an environment from a ksonnet application
diff --git a/docs/cli-reference/ks_env_add.md b/docs/cli-reference/ks_env_add.md
index bc2351e4..ca29fda9 100644
--- a/docs/cli-reference/ks_env_add.md
+++ b/docs/cli-reference/ks_env_add.md
@@ -76,7 +76,7 @@ ks env add prod --server=https://ksonnet-1.us-west.elb.amazonaws.com
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
diff --git a/docs/cli-reference/ks_env_list.md b/docs/cli-reference/ks_env_list.md
index 52ac3eae..bd4db1cb 100644
--- a/docs/cli-reference/ks_env_list.md
+++ b/docs/cli-reference/ks_env_list.md
@@ -32,7 +32,7 @@ ks env list
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
diff --git a/docs/cli-reference/ks_env_rm.md b/docs/cli-reference/ks_env_rm.md
index 1b28fc38..734811be 100644
--- a/docs/cli-reference/ks_env_rm.md
+++ b/docs/cli-reference/ks_env_rm.md
@@ -43,7 +43,7 @@ ks env rm us-west/staging
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
diff --git a/docs/cli-reference/ks_env_set.md b/docs/cli-reference/ks_env_set.md
index 6d36cc04..9999cc1a 100644
--- a/docs/cli-reference/ks_env_set.md
+++ b/docs/cli-reference/ks_env_set.md
@@ -58,7 +58,7 @@ ks env set us-west/staging --context=staging-west
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
diff --git a/docs/cli-reference/ks_generate.md b/docs/cli-reference/ks_generate.md
index a3ad4142..a34988e5 100644
--- a/docs/cli-reference/ks_generate.md
+++ b/docs/cli-reference/ks_generate.md
@@ -50,5 +50,5 @@ ks generate <prototype-name> <component-name> [type] [parameter-flags]
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
diff --git a/docs/cli-reference/ks_init.md b/docs/cli-reference/ks_init.md
index 3f1a2597..285af118 100644
--- a/docs/cli-reference/ks_init.md
+++ b/docs/cli-reference/ks_init.md
@@ -83,7 +83,7 @@ ks init app-name --dir=custom-location
--context string The name of the kubeconfig context to use
--dir string Ksonnet application directory
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
@@ -100,5 +100,5 @@ ks init app-name --dir=custom-location
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
diff --git a/docs/cli-reference/ks_param.md b/docs/cli-reference/ks_param.md
index 242a1108..ed0ff6e3 100644
--- a/docs/cli-reference/ks_param.md
+++ b/docs/cli-reference/ks_param.md
@@ -31,7 +31,7 @@ ks param
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
* [ks param diff](ks_param_diff.md) - Display differences between the component parameters of two environments
* [ks param list](ks_param_list.md) - List all parameters for a component(s)
* [ks param set](ks_param_set.md) - Set component or environment parameters such as replica count or name
diff --git a/docs/cli-reference/ks_pkg.md b/docs/cli-reference/ks_pkg.md
index c2831f48..856baa05 100644
--- a/docs/cli-reference/ks_pkg.md
+++ b/docs/cli-reference/ks_pkg.md
@@ -18,7 +18,7 @@ ks pkg
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
* [ks pkg describe](ks_pkg_describe.md) - Describe a ksonnet package
* [ks pkg install](ks_pkg_install.md) - Install a package as a dependency in the current ksonnet application
* [ks pkg list](ks_pkg_list.md) - Lists information about all dependencies known to the current ksonnet app
diff --git a/docs/cli-reference/ks_prototype.md b/docs/cli-reference/ks_prototype.md
index c7f5d941..ff42110e 100644
--- a/docs/cli-reference/ks_prototype.md
+++ b/docs/cli-reference/ks_prototype.md
@@ -33,7 +33,7 @@ ks prototype
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
* [ks prototype describe](ks_prototype_describe.md) - See more info about a prototype's output and usage
* [ks prototype list](ks_prototype_list.md) - List all locally available ksonnet prototypes
* [ks prototype preview](ks_prototype_preview.md) - Preview a prototype's output without creating a component (stdout)
diff --git a/docs/cli-reference/ks_registry.md b/docs/cli-reference/ks_registry.md
index 58a1a241..e62448aa 100644
--- a/docs/cli-reference/ks_registry.md
+++ b/docs/cli-reference/ks_registry.md
@@ -30,7 +30,7 @@ ks registry
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
* [ks registry describe](ks_registry_describe.md) - Describe a ksonnet registry
* [ks registry list](ks_registry_list.md) - List all registries known to the current ksonnet app.
diff --git a/docs/cli-reference/ks_show.md b/docs/cli-reference/ks_show.md
index 2dface30..0c3c01fc 100644
--- a/docs/cli-reference/ks_show.md
+++ b/docs/cli-reference/ks_show.md
@@ -67,5 +67,5 @@ ks show dev -c redis -c nginx-server
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
diff --git a/docs/cli-reference/ks_validate.md b/docs/cli-reference/ks_validate.md
index bdc9cf63..2d67e05f 100644
--- a/docs/cli-reference/ks_validate.md
+++ b/docs/cli-reference/ks_validate.md
@@ -49,7 +49,7 @@ ksonnet validate -f ./pod.jsonnet
--ext-str-file stringSlice Read external variable from a file
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
-J, --jpath stringSlice Additional jsonnet library search path
- --kubeconfig string Path to a kube config. Only required if out-of-cluster
+ --kubeconfig string Path to a kubeconfig file. Alternative to env var $KUBECONFIG.
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
@@ -70,5 +70,5 @@ ksonnet validate -f ./pod.jsonnet
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
diff --git a/docs/cli-reference/ks_version.md b/docs/cli-reference/ks_version.md
index c7dbb600..aeff6ab4 100644
--- a/docs/cli-reference/ks_version.md
+++ b/docs/cli-reference/ks_version.md
@@ -18,5 +18,5 @@ ks version
```
### SEE ALSO
-* [ks](ks.md) - Synchronise Kubernetes resources with config files
+* [ks](ks.md) - Configure your application to deploy to a Kubernetes cluster
--
GitLab