Skip to content
Snippets Groups Projects
Commit 6a281b9a authored by Jessica Yuen's avatar Jessica Yuen
Browse files

Bring environment documentation up-to-date with spec

parent 6661d131
No related branches found
No related tags found
No related merge requests found
...@@ -75,16 +75,20 @@ uniquely identifies the cluster. ...@@ -75,16 +75,20 @@ uniquely identifies the cluster.
environments/ environments/
default/ [Default generated environment] default/ [Default generated environment]
k.libsonnet .metadata/
k8s.libsonnet
swagger.json
spec.json
us-west/
staging/ [Example of user-generated env]
k.libsonnet k.libsonnet
k8s.libsonnet k8s.libsonnet
swagger.json 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 { RunE: func(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Command 'env' requires a subcommand\n\n%s", cmd.UsageString()) 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 ...@@ -146,28 +150,31 @@ For example, in the example below, there are two environments: 'default' and
environments/ environments/
default/ [Default generated environment] default/ [Default generated environment]
k.libsonnet .metadata/
k8s.libsonnet
swagger.json
spec.json
us-west/
staging/ [Example of user-generated env]
k.libsonnet k.libsonnet
k8s.libsonnet k8s.libsonnet
swagger.json 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 Example: ` # Initialize a new staging environment at 'us-west'. Using the
# namespace 'my-namespace'. The directory structure rooted at 'us-west' in the # namespace 'my-namespace'. The directory structure rooted at 'us-west' in the
# documentation above will be generated. # 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'. # 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 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 # Initialize a new development environment locally.
# default 'default' directory structure generated by 'ksonnet-init'. ks env add local localhost:8000`,
ks env add default localhost:8000`,
} }
var envRmCmd = &cobra.Command{ var envRmCmd = &cobra.Command{
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment