2017-04-21 18:19:58 +03:00
|
|
|
# Draft: Streamlined Kubernetes Development
|
2016-11-18 01:18:34 +03:00
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
[![Build Status](https://ci.deis.io/buildStatus/icon?job=Deis/draft/master)](https://ci.deis.io/job/Deis/job/draft/job/master/)
|
2017-02-28 03:46:30 +03:00
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
_NOTE: Draft is experimental and does not have a stable release yet._
|
2016-11-18 01:18:34 +03:00
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
Draft handles the heavy lifting involved in taking source code and deploying it to Kubernetes:
|
2016-11-18 01:18:34 +03:00
|
|
|
|
2017-02-16 01:16:39 +03:00
|
|
|
- Builds a container image from application source code
|
|
|
|
- Pushes the image to a registry
|
|
|
|
- Packages a [Helm][] chart from application source code
|
|
|
|
- Installs the chart to Kubernetes, deploying the application
|
2017-01-19 21:13:24 +03:00
|
|
|
|
2017-02-10 01:27:59 +03:00
|
|
|
## Usage
|
2016-11-18 01:18:34 +03:00
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
### Install Draft
|
2017-02-16 01:16:39 +03:00
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
Because Draft is currently experimental, there is no stable release out yet and users are expected
|
|
|
|
to be using the latest build of Draft for testing. Canary releases of the Draft client can be found
|
2017-03-14 20:17:37 +03:00
|
|
|
at the following links:
|
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
- [Linux amd64](https://deisprow.blob.core.windows.net/prow/draft-canary-linux-amd64.tar.gz)
|
|
|
|
- [macOS amd64](https://deisprow.blob.core.windows.net/prow/draft-canary-darwin-amd64.tar.gz)
|
|
|
|
- [Windows amd64](https://deisprow.blob.core.windows.net/prow/draft-canary-windows-amd64.tar.gz)
|
2017-03-14 20:17:37 +03:00
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
Unpack the Draft binary and add it to your PATH and you are good to go!
|
2017-03-14 20:17:37 +03:00
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
To install the server-side of Draft, use `draft init` with your credentials to let Draft communicate
|
2017-03-14 20:17:37 +03:00
|
|
|
with a Docker registry:
|
|
|
|
|
|
|
|
```
|
2017-04-21 18:19:58 +03:00
|
|
|
$ draft init --set registry.url=docker.io,registry.org=changeme,registry.authtoken=changeme
|
2017-03-14 20:17:37 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
The auth token field follows the format of Docker's X-Registry-Auth header. For credential-based
|
|
|
|
logins such as Docker Hub and Quay, use
|
|
|
|
|
|
|
|
```
|
|
|
|
$ echo '{"username":"jdoe","password":"secret","email":"jdoe@acme.com"}' | base64
|
|
|
|
```
|
|
|
|
|
|
|
|
For token-based logins such as Google Container Registry and Amazon ECR, use
|
|
|
|
|
|
|
|
```
|
|
|
|
$ echo '{"registrytoken":"9cbaf023786cd7"}' | base64
|
|
|
|
```
|
|
|
|
|
2017-04-21 18:19:58 +03:00
|
|
|
If you're looking to build from source or get started hacking on Draft, please see the
|
2017-03-14 20:17:37 +03:00
|
|
|
[hacking guide][hacking] for more information.
|
2017-02-10 01:27:59 +03:00
|
|
|
|
2017-02-16 01:16:39 +03:00
|
|
|
### Use It!
|
2016-11-18 01:18:34 +03:00
|
|
|
|
2017-02-22 20:25:05 +03:00
|
|
|
Climb aboard and explore the [Getting Started Guide][Getting Started] - you'll soon be sailing!
|
2017-02-14 01:51:29 +03:00
|
|
|
|
2017-02-27 22:32:00 +03:00
|
|
|
# License
|
|
|
|
|
2017-04-22 04:22:55 +03:00
|
|
|
This software is covered under the MIT license. You can read the license [here][license].
|
2017-02-27 22:32:00 +03:00
|
|
|
|
2017-04-22 04:22:55 +03:00
|
|
|
This software contains code from [Helm][], which is covered by the Apache v2.0 license.
|
2017-02-27 22:32:00 +03:00
|
|
|
|
|
|
|
|
2017-02-14 01:51:29 +03:00
|
|
|
[Getting Started]: docs/getting-started.md
|
2017-03-11 03:27:47 +03:00
|
|
|
[hacking]: docs/contributing/hacking.md
|
2017-02-08 21:46:10 +03:00
|
|
|
[Helm]: https://github.com/kubernetes/helm
|
2017-02-27 22:32:00 +03:00
|
|
|
[Kubernetes]: https://kubernetes.io/
|
|
|
|
[license]: LICENSE
|