Merge pull request #12 from runseb/readme

Update README
This commit is contained in:
runseb
2016-04-21 09:36:15 +02:00
+20 -29
View File
@@ -1,42 +1,33 @@
# application-dm-templates
Curated applications for Kubernetes using Deployment Manager templates
# Helm Charts
## Welcome
* Under ACTIVE development
Welcome to the Kubernetes Template Registry.
Source of curated application definitions (a.k.a Charts) for Kubernetes Helm. For more information about installing and using Helm, see its
[README.md](https://github.com/kubernetes/helm/tree/master/README.md). To get a quick introduction to the developer's experience using Helm and Charts see this [developer workflow](https://github.com/kubernetes/helm/blob/master/docs/workflow/developer-workflows.md).
This registry holds Deployment Manager
[templates](https://github.com/kubernetes/deployment-manager/tree/master/docs/design/design.md#templates)
that you can use to create, describe, update and delete Kubernetes applications.
## Source Repository
For more information about installing and using Deployment Manager, see its
[README.md](https://github.com/kubernetes/deployment-manager/tree/master/README.md).
This Github repository contains the source of Helm Charts that will soon become available on `gs://kubernetes-charts`.
## Organization
Charts are already available for testing at `gs://kubernetes-charts-testing`. You can browse those Charts directly on the Google Cloud Storage [console](https://console.cloud.google.com/storage/browser/kubernetes-charts-testing).
The Kubernetes Template Registry is a standard Deployment Manager template registry.
See
[Template registries](https://github.com/kubernetes/deployment-manager/tree/master/docs/templates/registry.md)
to learn how template registries are organized.
Charts are packaged and uploaded to a repository according to a [workflow](https://github.com/kubernetes/helm/blob/master/docs/pushing_charts.md)
## Usage
## Chart Format
The templates in this registry can be accessed directly from the Deployment Manager
command line interface, as described in
[Accessing a template registry](https://github.com/kubernetes/deployment-manager/blob/master/docs/templates/registry.md#accessing-a-template-registry).
The format of Charts is defined in this [document](https://github.com/kubernetes/helm/blob/master/docs/design/chart_format.md) in the Helm [repository](https://github.com/kubernetes/helm.git)
They can also be used in configurations and other templates, as described in
[Template references](https://github.com/kubernetes/deployment-manager/blob/master/docs/design/design.md#template-references).
Before contributing a Chart, become familiar with this format. Note that the project is still under active development and the format may still evolve a bit.
## Contributing
Your contributions are welcome.
We use the same [workflow](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/development.md#git-setup),
[License](LICENSE) and [Contributor License Agreement](CONTRIBUTING.md) as the main Kubernetes repository.
The format is slightly different from the Deis's [Charts](https://github.com/helm/charts.git) where it originated.
## Status of the Project
This project is still under active development, so you might run into issues. If
you do, please don't be shy about letting us know, or better yet, contribute a
fix or feature.
This project is still under active development, so you might run into [issues](https://github.com/kubernetes/charts/issues). If you do, please don't be shy about letting us know, or better yet, contribute a fix or feature.
## Contributing
Your contributions are most welcome.
We use the same [workflow](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/development.md#git-setup),
[License](LICENSE) and [Contributor License Agreement](CONTRIBUTING.md) as the main Kubernetes repository.