Skip to content

Commit

Permalink
vendor quickstart templates into origin
Browse files Browse the repository at this point in the history
  • Loading branch information
bparees committed Feb 18, 2016
1 parent bb591a4 commit df353fc
Show file tree
Hide file tree
Showing 9 changed files with 1,918 additions and 2 deletions.
5 changes: 5 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,11 @@ correct version in your GOPATH and then run `godep save <pkgname>`. This should
version of `Godeps/Godeps.json`, and update `Godeps/_workspace/src`. Create a commit that includes
both of these changes with message `bump(<pkgname>): <pkgcommit>`.

## Updating external examples

`hack/update-external-example.sh` will pull down example files from external repositories and deposit them under the `examples` directory.
Run this script if you need to refresh an example file, or add a new one. See the script and `examples/quickstarts/README.md` for more details.

## Troubleshooting

If you run into difficulties running OpenShift, start by reading through the
Expand Down
5 changes: 3 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ available on top of Kubernetes and Docker.
* [Project Quotas and Resource Limits](./project-quota) demonstrates how quota and resource limits can be applied to resources in an OpenShift project.
* [Replicated Zookeper Template](./zookeeper) provides a template for an OpenShift service that exposes a simple set of primitives that distributed applications can build upon to implement higher level services for synchronization, configuration maintenance, and groups and naming.
* [Storage Examples](./storage-examples) provides a high level tutorial and templates for local and persistent storage on OpenShift using simple nginx applications.
* [Database Templates](./db-templates) provide templates for ephemeral and persistent storage on OpenShift using MongoDB, MySQL, and PostgreSQL.
* [Clustered Etcd Template](./etcd) provides a template for setting up a clustered instance of the [Etcd](https://github.com/coreos/etcd) key-value store as a service on OpenShift.
* [Configurable Git Server](./gitserver) sets up a serivce capable of automatic mirroring of Git repositories, intended for use within a container or Kubernetes pod.
* [Configurable Git Server](./gitserver) sets up a service capable of automatic mirroring of Git repositories, intended for use within a container or Kubernetes pod.
* [QuickStarts](./quickstarts) provides templates for very basic applications using various frameworks and databases.
* [Database Templates](./db-templates) provides templates for ephemeral and persistent storage on OpenShift using MongoDB, MySQL, and PostgreSQL.
14 changes: 14 additions & 0 deletions examples/quickstarts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
QuickStarts
===========

QuickStarts provide the basic skeleton of an application. Generally they reference a repository containing very simple source code that implements a trivial application using a particular framework. In addition they define any components needed for the application including a Build configuration, supporting services such as Databases, etc.

You can instantiate these templates as is, or fork the source repository they reference and supply your forked repository as the source-repository when instantiating them.

* [CakePHP](https://raw.githubusercontent.com/openshift/cakephp-ex/master/openshift/templates/cakephp-mysql.json) - Provides a basic CakePHP application with a MySQL database. For more information see the [source repository](https://github.com/openshift/cakephp-ex).
* [Dancer](https://raw.githubusercontent.com/openshift/dancer-ex/master/openshift/templates/dancer-mysql.json) - Provides a basic Dancer(Perl) application with a MySQL database. For more information see the [source repository](https://github.com/openshift/dancer-ex).
* [Django](https://raw.githubusercontent.com/openshift/django-ex/master/openshift/templates/django-postgresql.json) - Provides a basic Django(Python) application with a PostgreSQL database. For more information see the [source repository](https://github.com/openshift/django-ex).
* [NodeJS](https://raw.githubusercontent.com/openshift/nodejs-ex/master/openshift/templates/nodejs-mongodb.json) - Provides a basic NodeJS application with a MongoDB database. For more information see the [source repository](https://github.com/openshift/nodejs-ex).
* [Rails](https://raw.githubusercontent.com/openshift/rails-ex/master/openshift/templates/rails-postgresql.json) - Provides a basic Rails(Ruby) application with a PostgreSQL database. For more information see the [source repository](https://github.com/openshift/rails-ex).

Note: This file is processed by hack/update-external-examples.sh. New examples must follow the exact syntax of the existing entries. Files in this directory are automatically pulled down, do not add additional files directly to this directory.
Loading

0 comments on commit df353fc

Please sign in to comment.