diff --git a/README.md b/README.md index f19e12e758..804fdda8dc 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ [![Circle CI](https://circleci.com/gh/weaveworks/eksctl/tree/master.svg?style=shield)](https://circleci.com/gh/weaveworks/eksctl/tree/master) - `eksctl` is a simple CLI tool for creating clusters on EKS - Amazon's new managed Kubernetes service for EC2. It is written in Go, and based on Amazon's official CloudFormation templates. You can create a cluster in minutes with just one command – **`eksctl create cluster`**! @@ -13,7 +12,7 @@ You can create a cluster in minutes with just one command – **`eksctl create c To download the latest release, run: -```console +``` curl --silent --location "https://github.com/weaveworks/eksctl/releases/download/latest_release/eksctl_$(uname -s)_amd64.tar.gz" | tar xz -C /tmp sudo mv /tmp/eksctl /usr/local/bin ``` @@ -26,7 +25,7 @@ or [environment variables][awsenv]. For more information read [AWS documentation To create a basic cluster, run: -```console +``` eksctl create cluster ``` @@ -44,50 +43,50 @@ able to use `kubectl`. You will need to make sure to use the same AWS API creden To list the details about a cluster or all of the clusters, use: -```console +``` eksctl get cluster [--cluster-name ] [--region ] ``` To create the same kind of basic cluster, but with a different name, run: -```console +``` eksctl create cluster --cluster-name cluster-1 --nodes 4 ``` To write cluster credentials to a file other than default, run: -```console +``` eksctl create cluster --cluster-name cluster-2 --nodes 4 --kubeconfig ./kubeconfig.cluster-2.yaml ``` To prevent storing cluster credentials locally, run: -```console +``` eksctl create cluster --cluster-name cluster-3 --nodes 4 --write-kubeconfig=false ``` To use a 3-5 node Auto Scaling Group, run: -```console +``` eksctl create cluster --cluster-name cluster-4 --nodes-min 3 --nodes-max 5 ``` To use 30 `c4.xlarge` nodes, run: -```console +``` eksctl create cluster --cluster-name cluster-5 --nodes 30 --node-type c4.xlarge ``` To delete a cluster, run: -```console +``` eksctl delete cluster --cluster-name [--region ] ``` @@ -100,7 +99,7 @@ It should suffice to install a cluster for development with just a single comman To create a cluster with default configuration (2 `m4.large` nodes), run: -```console +``` eksctl create cluster ``` @@ -127,7 +126,9 @@ For example, `eksctl apply --cluster-config prod-cluster.yaml` will manage clust And `eksctld` will be a controller inside of one cluster that can manage multiple other clusters based on Kubernetes Cluster API definitions (CRDs). ## Contributions + Code contributions are very welcome, however until a 0.1.0 release testing and bug reports are the contributions that authors will appreciate the most. ## Get in touch + [Create an issue](https://github.com/weaveworks/eksctl/issues/new), or login to [Weave Community Slack (#eksctl)](https://weave-community.slack.com/messages/CAYBZBWGL/) ([signup](https://slack.weave.works/)).