From 6a281b9afb2d24c098c91774055a2ddc870afd4a Mon Sep 17 00:00:00 2001
From: Jessica Yuen <im.jessicayuen@gmail.com>
Date: Wed, 18 Oct 2017 17:38:08 -0700
Subject: [PATCH] Bring environment documentation up-to-date with spec
---
cmd/env.go | 45 ++++++++++++++++++++++++++-------------------
1 file changed, 26 insertions(+), 19 deletions(-)
diff --git a/cmd/env.go b/cmd/env.go
index 8c9b06bf..bd7344d2 100644
--- a/cmd/env.go
+++ b/cmd/env.go
@@ -75,16 +75,20 @@ uniquely identifies the cluster.
environments/
default/ [Default generated environment]
- k.libsonnet
- k8s.libsonnet
- swagger.json
- spec.json
- us-west/
- staging/ [Example of user-generated env]
+ .metadata/
k.libsonnet
k8s.libsonnet
swagger.json
- spec.json [This will contain the uri of the environment]`,
+ spec.json
+ default.jsonnet
+ us-west/
+ staging/ [Example of user-generated env]
+ .metadata/
+ k.libsonnet
+ k8s.libsonnet
+ swagger.json
+ spec.json [This will contain the uri of the environment and other environment metadata]
+ staging.jsonnet`,
RunE: func(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Command 'env' requires a subcommand\n\n%s", cmd.UsageString())
},
@@ -146,28 +150,31 @@ For example, in the example below, there are two environments: 'default' and
environments/
default/ [Default generated environment]
- k.libsonnet
- k8s.libsonnet
- swagger.json
- spec.json
- us-west/
- staging/ [Example of user-generated env]
+ .metadata/
k.libsonnet
k8s.libsonnet
swagger.json
- spec.json [This will contain the uri of the environment]`,
+ spec.json
+ default.jsonnet
+ us-west/
+ staging/ [Example of user-generated env]
+ .metadata/
+ k.libsonnet
+ k8s.libsonnet
+ swagger.json
+ spec.json [This will contain the uri of the environment and other environment metadata],
+ staging.jsonnet`,
Example: ` # Initialize a new staging environment at 'us-west'. Using the
# namespace 'my-namespace'. The directory structure rooted at 'us-west' in the
# documentation above will be generated.
- ks env add us-west/staging https://ksonnet-1.us-west.elb.amazonaws.com
+ ks env add us-west/staging https://ksonnet-1.us-west.elb.amazonaws.com --namespace=my-namespace
- # Initialize a new staging environment at us-west, using the OpenAPI specification
+ # Initialize a new staging environment at 'us-west', using the OpenAPI specification
# generated in the Kubernetes v1.7.1 build to generate 'ksonnet-lib'.
ks env add us-west/staging https://ksonnet-1.us-west.elb.amazonaws.com --api-spec=version:v1.7.1
- # Initialize a new development environment locally. This will overwrite the
- # default 'default' directory structure generated by 'ksonnet-init'.
- ks env add default localhost:8000`,
+ # Initialize a new development environment locally.
+ ks env add local localhost:8000`,
}
var envRmCmd = &cobra.Command{
--
GitLab