ref(README): make it easier to find install instru

*places install instructions higher up for quickstart
This commit is contained in:
Michelle Noorali 2018-05-08 09:14:58 -04:00
Родитель ab977faa84
Коммит a8039b3a97
1 изменённых файлов: 23 добавлений и 5 удалений

Просмотреть файл

@ -2,13 +2,16 @@
[![Build Status](https://circleci.com/gh/Azure/draft.svg?style=svg)](https://circleci.com/gh/Azure/draft)
# Draft: Streamlined Kubernetes Development
Draft makes it easy to build applications that run on Kubernetes. Draft targets the "inner loop" of a developer's workflow: as they hack on code, but before code is committed to version control.
Draft makes it easier for developers to build applications that run on Kubernetes by doing two main things:
1. The `draft create` command gives developers the artifacts they need to build and run their applications in Kubernetes
2. The `draft up` command builds the container image for an application and deploys it to Kubernetes
Draft targets the "inner loop" of a developer's workflow: as they hack on code, but before code is committed to version control.
## _NOTE: Draft is experimental and does not have a stable release yet._
As an example, starting with the 0.12 release Draft moves the containment and deployment engine to your local machine. This changes quite a bit about how Draft works compared to prior releases; for details, see [the changelog](CHANGELOG.md).
## Install the draft binary
To install via homebrew, run `brew tap azure/draft && brew install draft` or download the binary via the [github releases page](https://github.com/Azure/draft/releases)
For previous users, this change means that you now have more control over where your container images are stored, and in the local Minikube environment you can skip pushing the images entirely, which speeds up the developer iteration speed _dramatically_. (Short version without jargon: you can build and run your app really fast.) However, when you want to push your images to an image registry service like Docker hub (or ACR, GCR, Quay.io, and so on) you must inform draft which registry to use and your cluster must have access to the secrets for that registry.
_Note:_ Draft requires a running Kubernetes cluster and [Helm](https://github.com/kubernetes/helm/blob/master/docs/install.md ). If you don't already have a running Kubernetes cluster, check out the [minikube install guide](docs/install-minikube.md).
## Overview
@ -25,7 +28,7 @@ Once the developer is happy with changes made via Draft, they commit and push to
[Join the conversation in Slack!](https://kubernetes.slack.com/messages/draft-users) If you don't already have a Kubernetes slack account, sign up [here](http://slack.k8s.io/).
## Installation
## Installation Guides
Use the [Minikube install guide][Installation Guide -- Minikube] to install and use Draft locally with Minikube. The default installation skips pushing the image, deploying directly from the local repository, which makes developer work very fast.
@ -37,6 +40,21 @@ Remember, however, take note of the major changes in releases greater than 0.12
Climb aboard and explore the [Getting Started Guide][Getting Started] - you'll soon be sailing!
## _NOTE: Draft is experimental and does not have a stable release yet._
If you're having issues after upgrading draft, try deleting the draft home directory where all the draft configuration files live and then re-run the `draft init` command (shown below). You'll have to re-install any custom plugins and configuration after deleting `$(draft home)`
Example:
```console
$ draft home
/Users/admin/.draft
$ rm -rf $(draft home)
$ draft init
```
Starting with the 0.12 release, Draft moves the containment and deployment engine to your local machine. This changes quite a bit about how Draft works compared to prior releases; for details, see [the changelog](CHANGELOG.md).
For previous users, this change means that you now have more control over where your container images are stored, and in the local Minikube environment you can skip pushing the images entirely, which speeds up the developer iteration speed _dramatically_. (Short version without jargon: you can build and run your app really fast.) However, when you want to push your images to an image registry service like Docker hub (or ACR, GCR, Quay.io, and so on) you must inform draft which registry to use and your cluster must have access to the secrets for that registry.
We're always looks for contributions in the form of issues, pull requests, and docs changes. If you see anything that would make Draft a better experience for yourself or others, please feel free to contribute. See the contributing section below for more details!
## Contributing
If you're looking to build from source or get started hacking on Draft, please see the