From 4a9baf0b27ff0c876466cc8db4a0534e7ed43bd5 Mon Sep 17 00:00:00 2001 From: jackgr Date: Sun, 8 Nov 2015 21:25:56 -0800 Subject: [PATCH] Readme fixes. --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 42eebff96..d1615985d 100644 --- a/README.md +++ b/README.md @@ -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.) 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. -So, you can ask questions like: +you've instantiated there, what instances you've created of a given type, and even +how the instances are organized. So, you can ask questions like: -* Show me all the Redis slaves running in this cluster. -* Show me all the resources used by Redis. +* What Redis instances are running in this cluster? +* 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 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 `kubectl` commands against it. 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 @@ -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 -paramaters, and then deploys it. +parameters, and then deploys it. You can also deploy an existing template, or read one from `stdin`. This command deploys the canonical Guestbook example from the examples directory: @@ -148,13 +149,12 @@ make push ## Design of Deployment Manager -There is a more detailed [design document](docs/design/design.md) -available. +There is a more detailed [design document](docs/design/design.md) available. ## Status of the project -The 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 +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. We use the same [development process](CONTRIBUTING.md) as the main Kubernetes repository.