diff --git a/incubator/apache/parts.yaml b/incubator/apache/parts.yaml index f561f34..a15b98f 100644 --- a/incubator/apache/parts.yaml +++ b/incubator/apache/parts.yaml @@ -2,7 +2,7 @@ "name": "apache", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "Apache Ksonnet mixin library contains a simple prototype with pre-configured components to help you deploy a Apache HTTP Server app to a Kubernetes cluster with ease.", + "description": "Apache is a popular, open-source HTTP server", "author": "ksonnet team ", "contributors": [ { diff --git a/incubator/apache/prototypes/apache-simple.jsonnet b/incubator/apache/prototypes/apache-simple.jsonnet index b3fce3b..f9e7bf7 100644 --- a/incubator/apache/prototypes/apache-simple.jsonnet +++ b/incubator/apache/prototypes/apache-simple.jsonnet @@ -1,10 +1,12 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.apache-simple -// @description Apache HTTP Server. Apache is deployed using a deployment, and exposed to the -// network using a service. +// @description runs Apache HTTP Server as a Deployment, and exposes it to +// the network using a Service. // @shortDescription A simple, stateless Apache HTTP server. -// @param namespace string Namespace to divvy up your cluster; default is 'default' -// @param name string Name to identify all Kubernetes objects in this prototype +// @param namespace string Namespace (metadata) that the Apache resources are +// created under; default is 'default' +// @param name string Name (metadata) to identify all resources defined by this +// prototype local k = import 'k.libsonnet'; local apache = import 'incubator/apache/apache.libsonnet'; diff --git a/incubator/mariadb/parts.yaml b/incubator/mariadb/parts.yaml index d17c772..f66c181 100644 --- a/incubator/mariadb/parts.yaml +++ b/incubator/mariadb/parts.yaml @@ -2,7 +2,7 @@ "name": "mariadb", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "MariaDB is an open source relational database it provides a SQL interface for accessing data. The latest versions of MariaDB also include GIS and JSON features. This package deploys a maria container, a service and secret to your cluster", + "description": "MariaDB is an open-source relational database that supports SQL. The latest versions of MariaDB also include GIS and JSON features.", "author": "ksonnet team ", "contributors": [ { diff --git a/incubator/mariadb/prototypes/maria-stateless.jsonnet b/incubator/mariadb/prototypes/maria-stateless.jsonnet index 4ce9ea3..7a2ee27 100644 --- a/incubator/mariadb/prototypes/maria-stateless.jsonnet +++ b/incubator/mariadb/prototypes/maria-stateless.jsonnet @@ -1,11 +1,15 @@ // @apiVersion 0.1 // @name io.ksonnet.pkg.stateless-maria -// @description Deploy stateless instance of MariaDB. This is NOT backed by a persistent volume. -// The MariaDB container is deployed using a deployment and exposed to the -// network as a service. The password is stored as a secret. +// @description deploys a stateless instance of MariaDB. *NOTE: This is NOT +// The MariaDB container is deployed using a deployment and exposed to the +// backed by a PersistentVolumeClaim.* The MariaDB container runs as a +// network as a service. The password is stored as a secret. +// Deployment, and is exposed to the network as a Service. The password is // @shortDescription A simple, stateless MariaDB deployment. -// @param namespace string Namespace in which to put the application -// @param name string Metadata name for each of the deployment components +// @param namespace string Namespace (metadata) that the MariaDB resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype // @param mariaRootPassword string Password for root user local k = import 'k.libsonnet'; diff --git a/incubator/memcached/parts.yaml b/incubator/memcached/parts.yaml index 8421070..6b5d84d 100644 --- a/incubator/memcached/parts.yaml +++ b/incubator/memcached/parts.yaml @@ -2,7 +2,7 @@ "name": "memcached", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "Memcached is an in-memory key-value store for small chunks of arbitrary data (strings, objects) from results of database calls, API calls, or page rendering.", + "description": "Memcached is an in-memory K-V store for small chunks of arbitrary data (strings, objects). It is used to temporarily store results of queries such as database calls, API calls, or page rendering.", "author": "ksonnet team ", "contributors": [ { @@ -33,7 +33,7 @@ "name": "memcached", "namespace": "default" }, - "comment": "Run a simple memcached instance" + "comment": "Run a simple Memcached instance" }, "license": "Apache 2.0" } diff --git a/incubator/memcached/prototypes/memcached-simple.jsonnet b/incubator/memcached/prototypes/memcached-simple.jsonnet index cacf7e2..d85d0a5 100644 --- a/incubator/memcached/prototypes/memcached-simple.jsonnet +++ b/incubator/memcached/prototypes/memcached-simple.jsonnet @@ -1,11 +1,14 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.memcached-simple -// @description Deploys Memcached on a your Kubernetes cluster through a stateful set with 3 -// replicas, pod distribution budget (pdb), and service. Memcached -// can be accessed via port 11211 within the cluster. +// @description deploys Memcached on your cluster. It runs as a StatefulSet, +// using 3 replicas and a pod distribution budget (PDB). Memcached +// is exposed as a Service, and can be accessed via port 11211 within the +// cluster // @shortDescription Simple Memcached instance with 3 replicas. -// @param namespace string Namespace in which to put the application -// @param name string Name to give to each of the components +// @param namespace string Namespace (metadata) that the Memcached resources +// are created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype // TODO: Add MaxItemMemory=64 as a param like the k8s/charts? diff --git a/incubator/mongodb/parts.yaml b/incubator/mongodb/parts.yaml index 7326636..be04348 100644 --- a/incubator/mongodb/parts.yaml +++ b/incubator/mongodb/parts.yaml @@ -2,7 +2,7 @@ "name": "mongodb", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "MongoDB is a cross-platform document-oriented database. Classified as a NoSQL database, MongoDB eschews the traditional table-based relational database structure in favor of JSON-like documents with dynamic schemas, making the integration of data in certain types of applications easier and faster.", + "description": "MongoDB is a popular NoSQL database. Rather than the traditional relational DB structure, MongoDB favors JSON-like documents with dynamic schemas.", "author": "ksonnet team ", "contributors": [ { diff --git a/incubator/mongodb/prototypes/mongodb-simple.jsonnet b/incubator/mongodb/prototypes/mongodb-simple.jsonnet index 5014148..42ce1ca 100644 --- a/incubator/mongodb/prototypes/mongodb-simple.jsonnet +++ b/incubator/mongodb/prototypes/mongodb-simple.jsonnet @@ -1,13 +1,15 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.mongodb-simple -// @description Deploys a simple instance of mongodb, backed by a persistent volume claim. The -// mongodb container is deployed using a Kubernetes deployment, and exposed -// to the network using a service. Passwords are stored in a secret. +// @description deploys a simple instance of MongoDB. It runs as a Deployment +// backed by a PersistentVolumeClaim, and is exposed to the network using a +// Service. Passwords are stored in a Secret. // @shortDescription A simple MongoDB deployment, backed by persistent storage. -// @param namespace string Namespace to specify destination in cluster; default is 'default' -// @param name string Name of app to attach as identifier to all components -// @param rootPassword string RootPassword for db admin password -// @param password string Password for db user password +// @param namespace string Namespace (metadata) that the MongoDB resources +// are created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype +// @param rootPassword string Password for the root user +// @param password string Password for new user local k = import 'k.libsonnet'; local mongo = import 'incubator/mongodb/mongodb.libsonnet'; diff --git a/incubator/mysql/parts.yaml b/incubator/mysql/parts.yaml index 7c232a9..37a661e 100644 --- a/incubator/mysql/parts.yaml +++ b/incubator/mysql/parts.yaml @@ -2,7 +2,7 @@ "name": "mysql", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "MySQL is one of the most popular database servers in the world. Notable users include Wikipedia, Facebook and Google.", + "description": "MySQL is a relational database management system (RDBMS) that supports SQL. It is described as the 'most popular open source database', "author": "ksonnet team ", "contributors": [ { diff --git a/incubator/mysql/prototypes/simple-mysql.jsonnet b/incubator/mysql/prototypes/simple-mysql.jsonnet index d1fc1d1..94859b2 100644 --- a/incubator/mysql/prototypes/simple-mysql.jsonnet +++ b/incubator/mysql/prototypes/simple-mysql.jsonnet @@ -1,13 +1,15 @@ // @apiVersion 0.1 // @name io.ksonnet.pkg.simple-mysql -// @description Deploys MySQL backed by a persistent volume. The MySQL container is deployed -// using a deployment and exposed to the network with a service. The -// passwords are stored in a secret. +// @description deploys a MySQL instance. It runs as a Deployment backed by a +// PersistentVolumeClaim, and is exposed to the network with a Service. The +// passwords are stored in a Secret. // @shortDescription A simple MySQL deployment, backed by persistent storage. -// @param namespace string Namespace in which to put the application -// @param name string Name to give to each of the components -// @param mysqlRootPassword string Password for root user -// @param mysqlPassword string Password for new user +// @param namespace string Namespace (metadata) that the MySQL resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype +// @param mySqlaRootPassword string Password for the root user +// @param mysqlPassword string Password for new use local k = import 'k.libsonnet'; local mysql = import '../mysql.libsonnet'; diff --git a/incubator/nginx/prototypes/nginx-server-block.jsonnet b/incubator/nginx/prototypes/nginx-server-block.jsonnet index a777ed3..c1eff2b 100644 --- a/incubator/nginx/prototypes/nginx-server-block.jsonnet +++ b/incubator/nginx/prototypes/nginx-server-block.jsonnet @@ -1,13 +1,13 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.nginx-server-block -// @description Deploys a simple, stateless nginx server with server blocks (roughly equivalent -// to nginx virtual hosts). The nginx container is deployed using a -// Kubernetes deployment, and is exposed to a network with a service. +// @description deploys a simple, stateless nginx server *with server blocks* +// (roughly equivalent to nginx virtual hosts). The nginx server runs as a +// Deployment, and is exposed to the network with a Service. // @shortDescription A simple, stateless nginx server with server blocks. -// @param namespace string Namespace in which to put the application -// @param name string Name to give to all components. - -// TODO: How should the ServerBlockConf be exposed to the user? Not quite sure what the default does except for setting web server to port 80. +// @param namespace string Namespace (metadata) that the nginx resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype local k = import 'k.libsonnet'; local nginx = import 'incubator/nginx/nginx.libsonnet'; diff --git a/incubator/nginx/prototypes/nginx-simple.jsonnet b/incubator/nginx/prototypes/nginx-simple.jsonnet index 23ce29f..f02a7cb 100644 --- a/incubator/nginx/prototypes/nginx-simple.jsonnet +++ b/incubator/nginx/prototypes/nginx-simple.jsonnet @@ -1,12 +1,12 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.nginx-simple -// @description Deploys a simple, stateless nginx server. The nginx container is -// deployed using a Kubernetes deployment, and is exposed to a network with a -// service. +// @description deploys a simple, stateless nginx server. The nginx server runs +// as a Deployment, and is exposed to the network with a Service. // @shortDescription A simple, stateless nginx server. -// @optionalParam namespace string default Namespace in which to put the application -// @param name string Name to give to each of the components - +// @param namespace string Namespace (metadata) that the nginx resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype local k = import 'k.libsonnet'; local nginx = import 'incubator/nginx/nginx.libsonnet'; diff --git a/incubator/node/parts.yaml b/incubator/node/parts.yaml index 7c9df77..3a25480 100644 --- a/incubator/node/parts.yaml +++ b/incubator/node/parts.yaml @@ -2,7 +2,7 @@ "name": "nodejs", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "Node is an event-driven I/O server-side JavaScript environment based on V8", + "description": "NodeJS is a JavaScript runtime built on Chrome's V8 JavaScript engine, and is designed to be lightweight and efficient. To that end, it uses an event-driven, non-blcoking I/O model. NodeJS also has a large ecosystem of open-source packages, which can be managed with the npm tool.", "author": "ksonnet team ", "contributors": [ { diff --git a/incubator/node/prototypes/nodejs-nonpersistent.jsonnet b/incubator/node/prototypes/nodejs-nonpersistent.jsonnet index 5303a2e..3d35602 100644 --- a/incubator/node/prototypes/nodejs-nonpersistent.jsonnet +++ b/incubator/node/prototypes/nodejs-nonpersistent.jsonnet @@ -1,10 +1,13 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.nodejs-nonpersistent -// @description Deploy a node.js server with no persistent volumes. The node container is -// deployed using a deployment, and exposed to the network using a service. +// @description deploys a stateless node.js app. Its source code is available +// at https://github.com/jbianquetti-nami/simple-node-app. The app runs as +// a Deployment, and is exposed to the network using a Service. // @shortDescription A simple, stateless NodeJS app server. -// @param namespace string Namespace to specify location of app; default is 'default' -// @param name string Name of app to identify all K8s objects in this prototype +// @param namespace string Namespace (metadata) that the app resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype local k = import 'k.libsonnet'; local nodeJS = import 'incubator/node/nodejs.libsonnet'; diff --git a/incubator/node/prototypes/nodejs-simple.jsonnet b/incubator/node/prototypes/nodejs-simple.jsonnet index 5c3f064..8b551f9 100644 --- a/incubator/node/prototypes/nodejs-simple.jsonnet +++ b/incubator/node/prototypes/nodejs-simple.jsonnet @@ -1,10 +1,14 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.nodejs-simple -// @description Deploy a node.js server with persistent volumes. The node container is -// deployed using a deployment, and exposed to the network using a service. +// @description deploys a node.js app backed by a PersistentVolumeClaim. Its +// source code is available at +// https://github.com/jbianquetti-nami/simple-node-app. The app runs as a +// Deployment, and is exposed to the network using a Service. // @shortDescription A simple NodeJS app server with persistent storage. -// @param namespace string Namespace to specify location of app; default is 'default' -// @param name string Name of app to identify all K8s objects in this prototype +// @param namespace string Namespace (metadata) that the app resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype local k = import 'k.libsonnet'; diff --git a/incubator/postgres/parts.yaml b/incubator/postgres/parts.yaml index ca71e49..d3b57c6 100644 --- a/incubator/postgres/parts.yaml +++ b/incubator/postgres/parts.yaml @@ -2,7 +2,7 @@ "name": "postgres", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "PostgreSQL is a powerful, open source object-relational database system. It has more than 15 years of active development and a proven architecture that has earned it a strong reputation for reliability, data integrity, and correctness.", + "description": "PostgreSQL is an open source relational database system (RDBMS) that supports SQL. It is designed with an emphasis on extensibility and compliance to the SQL standard.", "author": "ksonnet team ", "contributors": [ { @@ -33,7 +33,8 @@ "name": "posgres", "namespace": "default", "password": "boots" - } + }, + "comment": "Run a simple instance of the postgres database" }, "license": "Apache 2.0" } diff --git a/incubator/postgres/prototypes/postgres-simple.jsonnet b/incubator/postgres/prototypes/postgres-simple.jsonnet index 1e223c8..59dc973 100644 --- a/incubator/postgres/prototypes/postgres-simple.jsonnet +++ b/incubator/postgres/prototypes/postgres-simple.jsonnet @@ -1,12 +1,14 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.postgres-simple -// @description Deploy postgres backed by a persistent volume. Postgres container is managed by -// a deployment object and exposed to the network with a service. The -// passwords are stored in a secret. +// @description deploys a postgres instance. It runs as a Deployment backed by +// a PersistentVolumeClaim, and exposed to the network with a Service. The +// passwords are stored in a Secret. // @shortDescription A simple Postgres deployment, backed by persistent storage. -// @param name string Name of app to attach as identifier to all components -// @param namespace string Namespace to specify destination in cluster; default is 'default' -// @param password string Password for the root/admin user. +// @param namespace string Namespace (metadata) that the postgres resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype +// @param password string Password for the root user local k = import 'k.libsonnet'; local psg = import 'incubator/postgres/postgres.libsonnet'; diff --git a/incubator/redis/parts.yaml b/incubator/redis/parts.yaml index 1cb0c7c..4ef52a3 100644 --- a/incubator/redis/parts.yaml +++ b/incubator/redis/parts.yaml @@ -3,11 +3,9 @@ name: redis apiVersion: 0.0.1 kind: ksonnet.io/parts description: > - Redis is an advanced key-value cache and store. Often referred to as - a data structure server since keys can contain structures as simple as strings, - hashes and as complex as bitmaps and hyperloglogs. This package will deploy redis - backed by a mounted persistent volume, a secret to hold your database password and - a service to expose your deployment. + Redis is an open-source, in-memory, K-V data structure store. It is often + used as a database, cache, and message broker. Redis can be run with a + master-replica setup to achieve high availability. author: ksonnet team contributors: - name: Tehut Getahun diff --git a/incubator/redis/prototypes/redis-all-features.jsonnet b/incubator/redis/prototypes/redis-all-features.jsonnet deleted file mode 100644 index 8eae75c..0000000 --- a/incubator/redis/prototypes/redis-all-features.jsonnet +++ /dev/null @@ -1,29 +0,0 @@ -// @apiVersion 0.1 -// @name io.ksonnet.pkg.redis-all-features -// @description Redis with all the features supported by redis.libsonnet -// (e.g. secret, metrics, ingress, PVC) -// @shortDescription A Redis deployment with metrics, ingress, and persistent storage. -// @param name string Name to give to each of the components -// @optionalParam redisPassword string null User password to supply to redis - -local k = import 'k.libsonnet'; -local redis = import 'incubator/redis/redis.libsonnet'; - -local name = import 'param://name'; -local redisPassword = import 'param://redisPassword'; - -local secretName = - if redisPassword != "null" then name else null; - -local optionalSecret = - if redisPassword != "null" - then redis.parts.secret(name, redisPassword) - else null; - -std.prune(k.core.v1.list.new([ - redis.parts.deployment.persistent(name, secretName), - redis.parts.networkPolicy.allowExternal(name, true, true), - redis.parts.pvc(name), - redis.parts.svc.metricEnabled(name), - optionalSecret, -])) diff --git a/incubator/redis/prototypes/redis-persistent.jsonnet b/incubator/redis/prototypes/redis-persistent.jsonnet index 6628215..9039b55 100644 --- a/incubator/redis/prototypes/redis-persistent.jsonnet +++ b/incubator/redis/prototypes/redis-persistent.jsonnet @@ -1,29 +1,25 @@ -// @apiVersion 0.1 +// @apiVersion 0.0.1 // @name io.ksonnet.pkg.redis-persistent -// @description Redis backed by a persistent volume claim. Redis is deployed using a Kubernetes -// deployment, exposed to the network with a service, with a password stored -// in a secret. -// @param name string Name to give to each of the components +// @description deploys a version of Redis that is backed by a +// PersistentVolumeClaim. It runs as a Deployment, and is exposed to the +// network with a Service. The password is stored in a Secret. // @shortDescription A simple Redis deployment, backed by persistent storage. -// @optionalParam redisPassword string null User password to supply to redis +// @param namespace string Namespace (metadata) that the Redis resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype +// @param redisPassword string User password to access Redis -local k = import 'k.libsonnet'; +local k = import 'ksonnet.beta.2/k.libsonnet'; local redis = import 'incubator/redis/redis.libsonnet'; +local namespace = import 'param://namespace'; local name = import 'param://name'; local redisPassword = import 'param://redisPassword'; -local secretName = - if redisPassword != "null" then name else null; - -local optionalSecret = - if redisPassword != "null" - then redis.parts.secret(name, redisPassword) - else null; - -std.prune(k.core.v1.list.new([ - redis.parts.deployment.persistent(name, secretName), - redis.parts.pvc(name), - redis.parts.svc.metricDisabled(name), - optionalSecret, -])) +k.core.v1.list.new([ + redis.parts.deployment.persistent(namespace, name, name), + redis.parts.pvc(namespace, name), + redis.parts.secret(namespace, name, redisPassword), + redis.parts.svc.metricDisabled(namespace, name), +]) diff --git a/incubator/redis/prototypes/redis-stateless.jsonnet b/incubator/redis/prototypes/redis-stateless.jsonnet index 163d1a2..3b53788 100644 --- a/incubator/redis/prototypes/redis-stateless.jsonnet +++ b/incubator/redis/prototypes/redis-stateless.jsonnet @@ -1,28 +1,23 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.redis-stateless -// @description Stateless redis, backed with NO persistent volume claim. Redis is deployed -// using a Kubernetes deployment, exposed to the network with a service, with -// a password stored in a secret. +// @description deploys a stateless version of Redis. *NOTE: This is NOT backed +// by a PersistentVolumeClaim.* It is exposed to the network with a Service. +// The password is stored in a Secret. // @shortDescription A simple, stateless Redis deployment, -// @param name string Name to give to each of the components. -// @optionalParam redisPassword string null User password to supply to redis +// @param namespace string Namespace (metadata) that the Redis resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype +// @param redisPassword string User password to access Redis -local k = import 'k.libsonnet'; +local k = import 'ksonnet.beta.2/k.libsonnet'; local redis = import 'incubator/redis/redis.libsonnet'; - +local namespace = import 'param://namespace'; local name = import 'param://name'; -local redisPassword = import 'param://redisPassword'; - -local secretName = - if redisPassword != "null" then name else null; - -local optionalSecret = - if redisPassword != "null" - then redis.parts.secret(name, redisPassword) - else null; +local redisPassword = import 'param://tomcatPassword'; -std.prune(k.core.v1.list.new([ - redis.parts.deployment.nonPersistent(name, secretName), - redis.parts.svc.metricDisabled(name), - optionalSecret, -])) +k.core.v1.list.new([ + redis.parts.deployment.nonPersistent(namespace, name, name), + redis.parts.secret(namespace, name, redisPassword), + redis.parts.svc.metricDisabled(namespace, name), +]) diff --git a/incubator/tomcat/parts.yaml b/incubator/tomcat/parts.yaml index 35d9403..932f8eb 100644 --- a/incubator/tomcat/parts.yaml +++ b/incubator/tomcat/parts.yaml @@ -2,7 +2,7 @@ "name": "tomcat", "apiVersion": "0.0.1", "kind": "ksonnet.io/parts", - "description": "Apache Tomcat, or Tomcat, is an open-source web server and servlet container. This package deploys a stateless tomcat container, service, and secret to your cluster", + "description": "Tomcat is an open-source web server that is primarily used to run Java web applications (i.e. via servlets and JSP).", "author": "ksonnet team ", "contributors": [ { diff --git a/incubator/tomcat/prototypes/tomcat-persistent.jsonnet b/incubator/tomcat/prototypes/tomcat-persistent.jsonnet index 852d228..b01f9a3 100644 --- a/incubator/tomcat/prototypes/tomcat-persistent.jsonnet +++ b/incubator/tomcat/prototypes/tomcat-persistent.jsonnet @@ -1,13 +1,16 @@ -// @apiVersion 0.1 +// @apiVersion 0.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 deploys a stateful Tomcat server. It is backed by a +// PersistentVolumeClaim, runs as a Deployment, and is exposed to the +// network with a Service. The password is stored in a Secret. // @shortDescription A simple Tomcat app server, backed with persistent storage. -// @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 namespace string Namespace (metadata) that the Tomcat resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype +// @param tomcatUser string Username for the Tomcat manager page. If not +// specified, Tomcat will not assign users. +// @param tomcatPassword string Password for the Tomcat manager page. local k = import 'k.libsonnet'; local tc = import 'incubator/tomcat/tomcat.libsonnet'; diff --git a/incubator/tomcat/prototypes/tomcat-stateless.jsonnet b/incubator/tomcat/prototypes/tomcat-stateless.jsonnet index 0871d78..1d63e77 100644 --- a/incubator/tomcat/prototypes/tomcat-stateless.jsonnet +++ b/incubator/tomcat/prototypes/tomcat-stateless.jsonnet @@ -1,12 +1,16 @@ // @apiVersion 0.0.1 // @name io.ksonnet.pkg.non-persistent-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. +// @description eploys a stateless Tomcat server. *NOTE: It is NOT backed by a +// PersistentVolumeClaim*. It runs as a Deployment, and is exposed to the +// network with a Service. The password is stored in a Secret. // @shortDescription A simple, stateless Tomcat app server. -// @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 namespace string Namespace (metadata) that the Tomcat resources are +// created under +// @param name string Name (metadata) to identify all resources defined by this +// prototype +// @param tomcatUser string Username for the Tomcat manager page. If not +// specified, Tomcat will not assign users. +// @param tomcatPassword string Password for the Tomcat manager page. local k = import 'k.libsonnet'; local tc = import 'incubator/tomcat/tomcat.libsonnet';