msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

Readme fixes.

Browse Source
pull/31/head
jackgr 9 years ago
parent f1d239f613
commit 4a9baf0b27
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File

20
README.md
Unescape View File

@ -20,11 +20,12 @@ that second example correctly. It uses DM to deploy itself.
See [examples/bootstrap/README.md](examples/bootstrap/README.md) for more information.) See [examples/bootstrap/README.md](examples/bootstrap/README.md) for more information.)
DM runs server side, in your Kubernetes cluster, so it can tell you what types DM runs server side, in your Kubernetes cluster, so it can tell you what types
you've instantiated there, and even what instances you've created of a given type. you've instantiated there, what instances you've created of a given type, and even
So, you can ask questions like: how the instances are organized. So, you can ask questions like:
* Show me all the Redis slaves running in this cluster. * What Redis instances are running in this cluster?
* Show me all the resources used by Redis. * What Redis master and slave services are part of this Redis instance?
* What pods are part of this Redis slave?
Because DM stores its state in the cluster, not on your workstation, you can ask Because DM stores its state in the cluster, not on your workstation, you can ask
those questions from any client at any time. those questions from any client at any time.
@ -42,7 +43,7 @@ Follow these 3 steps to install DM:
1. Make sure your Kubernetes cluster is up and running, and that you can run 1. Make sure your Kubernetes cluster is up and running, and that you can run
`kubectl` commands against it. `kubectl` commands against it.
1. Clone this repository into the src folder of your GOPATH, if you haven't already. 1. Clone this repository into the src folder of your GOPATH, if you haven't already.
1. Use `kubectl` to intall DM into your cluster: 1. Use `kubectl` to install DM into your cluster:
``` ```
kubectl create -f install.yaml kubectl create -f install.yaml
@ -86,7 +87,7 @@ dm --properties workers=3 deploy redis/v1
``` ```
When you deploy a type, `dm` generates a template from the type and input When you deploy a type, `dm` generates a template from the type and input
paramaters, and then deploys it. parameters, and then deploys it.
You can also deploy an existing template, or read one from `stdin`. This command You can also deploy an existing template, or read one from `stdin`. This command
deploys the canonical Guestbook example from the examples directory: deploys the canonical Guestbook example from the examples directory:
@ -148,13 +149,12 @@ make push
## Design of Deployment Manager ## Design of Deployment Manager
There is a more detailed [design document](docs/design/design.md) There is a more detailed [design document](docs/design/design.md) available.
available.
## Status of the project ## Status of the project
The project is still under active development, so you might run into issues. If 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, contributing a you do, please don't be shy about letting us know, or better yet, contribute a
fix or feature. We use the same [development process](CONTRIBUTING.md) as the main fix or feature. We use the same [development process](CONTRIBUTING.md) as the main
Kubernetes repository. Kubernetes repository.

Write Preview
Loading…
Cancel
Save