Draft is a tool made for users who are just getting started with Kubernetes, or users who want to simplify their experience with Kubernetes. This readme will give you a quick run down on Draft’s commands and what they do.
In our directory that holds our application, we can run the CLI command ‘draft create’. Draft create will walk you through a series of questions prompting you on your application specification. At the end of it, you will have a Dockerfile as well as Kubernetes manifests to deploy your application. Below is a picture of running the Draft create command on our Contoso Air repository.
If you are using Azure, you can also run the ‘draft setup-gh’ command to automate the GitHub OIDC setup process. This process is needed to make sure your Azure account and your GitHub repository can talk to each other. If you plan on using the GitHub Action to deploy your application, this step must be completed.
At this point, you have all the files needed to deploy your application onto a Kubernetes cluster!
If you don’t plan on using the GitHub Action, you can directly apply your deployment files by using the
kubectl apply -f command.
If you plan on deploying your application through your GitHub Action, commit all the files to your repository and watch your application get deployed!
draft info command prints information about supported languages and deployment types.
About The Project
Draft makes it easier for developers to get started building apps that run on Kubernetes by taking a non-containerized application and generating the Dockerfiles, Kubernetes manifests, Helm charts, Kustomize configuration, and other artifacts associated with a containerized application. Draft can also generate a GitHub Actions workflow file to quickly build and deploy applications onto any Kubernetes cluster.
draft createadds the minimum required Dockerfile and manifest files for your deployment to the project directory.
- Supported deployment types: Helm, Kustomize, Kubernetes manifest.
draft setup-ghautomates the GitHub OIDC setup process for your project.
draft generate-workflowgenerates a GitHub Actions workflow for automatic build and deploy to a Kubernetes cluster.
draft updateautomatically make your application to be internet accessible.
draft infoprint supported language and field information in json format.
draft [command] --help for more information about a command.
Draft requires Go version 1.18.x.
Check your go version.
Clone the repo
git clone https://github.com/Azure/draft.git
Change to the
draftdirectory and build the binary
cd draft/ make
Add the binary to your path (we use the same directory as go install)
mv draft $HOME/go/bin/
Install with HomeBrew
Run the following commands
$ brew tap azure/draft $ brew install draft
Installation using script
curl -fsSL https://raw.githubusercontent.com/Azure/draft/main/scripts/install.sh | bash
- Windows isn't currently supported (you can use WSL)
Draft is fully compatible with Azure Kubernetes Service. We strongly encourage contributions to make Draft available to other cloud providers
The Draft team will be monitoring both the issues and discussions board. Please feel free to create issues for any problems you run into and the Draft team will be quick to respond. The discussions board will be used for community engagement. We look forward to see you there!
Draft is under the MIT License. See LICENSE for more information.
Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.