README fix for tomcat

incubator/tomcat/README.md

@@ -5,7 +5,7 @@
 * [Quickstart](#quickstart)
 * [Using Prototypes](#using-prototypes)
   * [io.ksonnet.pkg.stateless-tomcat](#io.ksonnet.pkg.stateless-tomcat)
-  * [io.ksonnet.pkg.non-persistent-tomcat](#io.ksonnet.pkg.non-persistent-tomcat)
+  * [io.ksonnet.pkg.persistent-tomcat](#io.ksonnet.pkg.persistent-tomcat)
 
 ## Quickstart
 
@@ -21,10 +21,10 @@ Finally, in the ksonnet application directory, run the following:
 # Expand prototype as a Jsonnet file, place in a file in the
 # `components/` directory. (YAML and JSON are also available.)
 $ ks prototype use io.ksonnet.pkg.persistent-tomcat tomcat \
-  --tomcatPassword boots \
   --name tomcat \
   --namespace default \
-  --tomcatUser frank
+  --tomcatUser frank \
+  --tomcatPassword boots
 
 # Apply to server.
 $ ks apply -f tomcat.jsonnet
@@ -40,8 +40,7 @@ These prototypes, as well as how to use them, are enumerated below.
 
 ### io.ksonnet.pkg.stateless-tomcat
 
-Deploys a stateful Tomcat server, backed by a persistent volume. Server isdeployed using a Kubernetes deployment, and exposed to the network using a
-service. The password is stored as a secret.
+Deploys a stateless Tomcat server. Server is deployed using a Kubernetesdeployment, and exposed to the network using a service. The password is stored as a secret.
 
 #### Example
 
@@ -67,19 +66,20 @@ Below is the Jsonnet file generated by this command.
 The available options to pass prototype are:
 
 * `--namespace=<namespace>`: Namespace in which to put the application [string]
-* `--name=<name>`: Name to give to each of the components [string]
+* `--name=<name>`: Name to give to each of the components. [string]
 * `--tomcatUser=<tomcatUser>`: Username for tomcat manager page, if not specified tomcat will not assign users [string]
 * `--tomcatPassword=<tomcatPassword>`: Tomcat manager page password, to be encrypted and included in Secret API object [string]
-### io.ksonnet.pkg.non-persistent-tomcat
+### io.ksonnet.pkg.persistent-tomcat
 
-Deploys a stateless Tomcat server. Server is deployed using a Kubernetesdeployment, and exposed to the network using a service. The password is stored as a secret.
+When generated and applied this package will create a secret,a deployment, mount a persistent volume claim, & expose the deployment via a
+service.
 
 #### Example
 
 ```shell
 # Expand prototype as a Jsonnet file, place in a file in the
 # `components/` directory. (YAML and JSON are also available.)
-$ ks prototype use io.ksonnet.pkg.non-persistent-tomcat tomcat \
+$ ks prototype use io.ksonnet.pkg.persistent-tomcat tomcat \
   --namespace YOUR_NAMESPACE_HERE \
   --name YOUR_NAME_HERE \
   --tomcatUser YOUR_TOMCATUSER_HERE \
@@ -98,7 +98,7 @@ Below is the Jsonnet file generated by this command.
 The available options to pass prototype are:
 
 * `--namespace=<namespace>`: Namespace in which to put the application [string]
-* `--name=<name>`: Name to give to each of the components. [string]
+* `--name=<name>`: Name to give to each of the components [string]
 * `--tomcatUser=<tomcatUser>`: Username for tomcat manager page, if not specified tomcat will not assign users [string]
 * `--tomcatPassword=<tomcatPassword>`: Tomcat manager page password, to be encrypted and included in Secret API object [string]
 

incubator/tomcat/prototypes/tomcat-persistent.jsonnet

@@ -1,12 +1,12 @@
 // @apiVersion 0.1
 // @name io.ksonnet.pkg.persistent-tomcat
-// @description Deploys a stateful Tomcat server, backed by a persistent volume. Server is
-//   deployed using a Kubernetes deployment, and exposed to the network using a
-//   service. The password is stored as a secret.
+// @description When generated and applied this package will create a secret,
+//   a deployment, mount a persistent volume claim, & expose the deployment via a
+//   service.
 // @param namespace string Namespace in which to put the application
 // @param name string Name to give to each of the components
 // @param tomcatUser string Username for tomcat manager page, if not specified tomcat will not assign users
-// @param tomcatPassword string Tomcat manager page password, to be encrypted and included in Secret API object
+// @param tomcatPassword string Tomcat manager page password, to be encrypted and included in Secret Object
 
 local k = import 'ksonnet.beta.2/k.libsonnet';
 local tc = import 'incubator/tomcat/tomcat.libsonnet';

incubator/tomcat/prototypes/tomcat-stateless.jsonnet

@@ -1,11 +1,11 @@
 // @apiVersion 0.0.1
-// @name io.ksonnet.pkg.non-persistent-tomcat
+// @name io.ksonnet.pkg.stateless-tomcat
 // @description Deploys a stateless Tomcat server. Server is deployed using a Kubernetes
 //   deployment, and exposed to the network using a service. The password is stored as a secret.
 // @param namespace string Namespace in which to put the application
 // @param name string Name to give to each of the components.
 // @param tomcatUser string Username for tomcat manager page, if not specified tomcat will not assign users
-// @param tomcatPassword string Tomcat manager page password, to be encrypted and included in Secret API object
+// @param tomcatPassword string Tomcat manager page password, to be encrypted and included in Secret Object
 
 local k = import 'ksonnet.beta.2/k.libsonnet';
 local tc = import 'incubator/tomcat/tomcat.libsonnet';