GitBook: published docs

Author: chanwit

README.md

@@ -1,94 +1,106 @@
-# ekz
-A Kubernetes distribution built on EKS-D
+---
+description: An easy way to run EKS clusters on your desktop
+---
 
-`ekz` is an opinionated Kubernetes distribution built using binaries from [the AWS EKS Distro](https://distro.eks.amazonaws.com/) (EKS-D).
+# The EKZ Project
+
+`ekz` is an opinionated Kubernetes distribution built using binaries from [the AWS EKS Distro](https://distro.eks.amazonaws.com/) \(EKS-D\). It aims to be the easiest way to run EKS clusters on desktop.
 
 What is EKS-D?
 
-  > *EKS-D provides the same software that has enabled tens of thousands of Kubernetes clusters on Amazon EKS.*
+> _EKS-D provides the same software that has enabled tens of thousands of Kubernetes clusters on Amazon EKS._
+
+`ekz` aims at solving the EKS compatibility problem for developers as much as possible by implanting EKS-D binaries to KIND and the k0s project, so that we can easily spin EKS-compatible clusters up to test our Kubernetes applications.
 
 ## Architecture
 
-The EKZ architecture supports EKS-D in multiple implementations, called providers. Currently, we ship the k0s-based (EKZ provider), 
-and KIND-based (KIND provider) implementations. A provider can be specified when creating a cluster, or via the `EKZ_PROVIDER` variable.
+The architecture of EKZ has been designed to support EKS-D in multiple implementations, called providers. Currently, we ship the [k0s](https://github.com/k0sproject/k0s)-based \(EKZ provider\), and [KIND](https://github.com/kubernetes-sigs/kind/)-based \(KIND provider\) implementations. A provider can be specified when creating a cluster, or via the `EKZ_PROVIDER` variable.
 
 ## Getting Started
 
 `ekz` creates a cluster for you inside a Docker container on your laptop. You can start a cluster with or without using the CLI.
 
-### With CLI
+### CLI Installation
 
 You could install the CLI with one the following options.
 
-#### Homebrew (macOS & Linux)
-```sh
+#### Homebrew \(macOS & Linux\)
+
+```bash
 brew install ekz-io/tap/ekz
 ```
 
-#### CURL One-liner (macOS & Linux)
-```sh
+#### CURL One-liner \(macOS & Linux\)
+
+```bash
 curl -sSL https://bit.ly/install-ekz | bash
 ```
 
-#### Wget One-liner (macOS & Linux)
-```sh
+#### Wget One-liner \(macOS & Linux\)
+
+```bash
 wget -qO- https://bit.ly/install-ekz | bash
 ```
 
-#### Scoop (Windows)
-```
+#### Scoop \(Windows\)
+
+```text
 scoop bucket add ekz-io https://github.com/ekz-io/scoop-ekz.git
 scoop install ekz-io/ekz
 ```
 
-#### Chocolatey (Windows)
-```
+#### Chocolatey \(Windows\)
+
+```text
 choco install -y ekz
 ```
 
 Then you can start your first EKS-D cluster using the following command:
-```
+
+```text
 ekz create cluster
 ```
 
-You can also use the KIND provider, so that your EKS-D clusters will be KIND-compatible.
-To use the KIND provider, you can use either flag `--provider=kind` or `export EKZ_PROVIDER=kind`. 
+You can also use the KIND provider, so that your EKS-D clusters will be KIND-compatible. To use the KIND provider, you can use either flag `--provider=kind` or `export EKZ_PROVIDER=kind`.
 
 Here' the example of using the `--provider=kind` flag:
-```
+
+```text
 ekz create cluster --provider=kind
 ```
 
-In case you'd like to use KIND as the default provider, it's better to set the EKZ_PROVIDER environment variable:
-```
+In case you'd like to use KIND as the default provider, it's better to set the EKZ\_PROVIDER environment variable:
+
+```text
 export EKZ_PROVIDER=kind
 ekz create cluster
 ```
 
 Please wait for a couple of minutes and an EKS-D cluster will be ready on your laptop.
 
-```sh
+```bash
 $ kubectl get nodes
 NAME         STATUS   ROLES    AGE   VERSION
 controller   Ready    <none>   42s   v1.18.9-eks-1-18-1
 ```
 
 ### Without CLI
-To use EKZ without using the CLI, please refer to this [document](WITHOUT_CLI.md).
 
+To use EKZ without using the CLI, please refer to this [document](without_cli.md).
 
 ## Features
 
-The EKZ provider
+### The EKZ provider
+
+1. EKS-D binaries from v1.18.9-eks-1-18-1
+2. Packaged with k0s v0.10
+3. Amazon Linux 2 base image
+4. Enable network policy by default via the Calico CNI
 
-  1. EKS-D binaries from v1.18.9-eks-1-18-1
-  1. Packaged with k0s v0.10
-  1. Amazon Linux 2 base image
-  1. Enable network policy by default via the Calico CNI
+### The KIND provider
 
-The KIND provider
+1. EKS-D binaries from v1.18.9-eks-1-18-1
+2. Using KIND v0.10
+3. Packaged using KIND v1.18.15 node image
+4. Enable network policy by default via the Calico CNI
 
-  1. EKS-D binaries from v1.18.9-eks-1-18-1
-  1. Using KIND v0.10
-  1. Packaged using KIND v1.18.15 node image
-  1. Enable network policy by default via the Calico CNI

SUMMARY.md

@@ -0,0 +1,18 @@
+# Table of contents
+
+* [The EKZ Project](README.md)
+* [Documentation](docs/README.md)
+  * [Command References](docs/cmd/README.md)
+    * [ekz](docs/cmd/ekz.md)
+    * [ekz create](docs/cmd/ekz_create.md)
+    * [ekz create cluster](docs/cmd/ekz_create_cluster.md)
+    * [ekz delete](docs/cmd/ekz_delete.md)
+    * [ekz delete cluster](docs/cmd/ekz_delete_cluster.md)
+    * [ekz get](docs/cmd/ekz_get.md)
+    * [ekz get kubeconfig](docs/cmd/ekz_get_kubeconfig.md)
+    * [ekz list](docs/cmd/ekz_list.md)
+    * [ekz list cluster](docs/cmd/ekz_list_cluster.md)
+    * [ekz load](docs/cmd/ekz_load.md)
+    * [ekz load docker-image](docs/cmd/ekz_load_docker-image.md)
+* [Using EKZ Without CLI](without_cli.md)
+

docs/README.md

@@ -0,0 +1,2 @@
+# Documentation
+

docs/cmd/README.md

@@ -0,0 +1,2 @@
+# Command References
+

docs/cmd/ekz.md

@@ -1,16 +1,14 @@
-## ekz
+# ekz
 
 Command line utility for creating EKS-D clusters on desktop
 
-### Synopsis
+## Synopsis
 
-This program is a command line utility for creating and managing EKS-D clusters on desktop.
-It currently supports clusters provided by EKZ (k0s-based) and KIND.
-All EKS-D cluster is single-node and run inside Docker.
+This program is a command line utility for creating and managing EKS-D clusters on desktop. It currently supports clusters provided by EKZ \(k0s-based\) and KIND. All EKS-D cluster is single-node and run inside Docker.
 
-### Examples
+## Examples
 
-```
+```text
   # Create an EKS-D cluster with the default provider
   ekz create cluster
 
@@ -30,22 +28,21 @@ All EKS-D cluster is single-node and run inside Docker.
   ekz create cluster --provider=kind
   ekz get kubeconfig --provider=kind
   ekz delete cluster --provider=kind
-
 ```
 
-### Options
+## Options
 
-```
+```text
   -h, --help              help for ekz
       --provider string   cluster provider possible values: "ekz", "kind". env: EKZ_PROVIDER (default "ekz")
       --verbose           run verbosely
 ```
 
-### SEE ALSO
+## SEE ALSO
 
-* [ekz create](ekz_create.md)	 - Create clusters
-* [ekz delete](ekz_delete.md)	 - Delete clusters
-* [ekz get](ekz_get.md)	 - Get properties of an EKS-D cluster
-* [ekz list](ekz_list.md)	 - List clusters
-* [ekz load](ekz_load.md)	 - Load artifacts into the cluster
+* [ekz create](ekz_create.md)     - Create clusters
+* [ekz delete](ekz_delete.md)     - Delete clusters
+* [ekz get](ekz_get.md)     - Get properties of an EKS-D cluster
+* [ekz list](ekz_list.md)     - List clusters
+* [ekz load](ekz_load.md)     - Load artifacts into the cluster
 

docs/cmd/ekz_create.md

@@ -1,26 +1,26 @@
-## ekz create
+# ekz create
 
 Create clusters
 
-### Synopsis
+## Synopsis
 
 The create sub-commands create EKS-D clusters.
 
-### Options
+## Options
 
-```
+```text
   -h, --help   help for create
 ```
 
-### Options inherited from parent commands
+## Options inherited from parent commands
 
-```
+```text
       --provider string   cluster provider possible values: "ekz", "kind". env: EKZ_PROVIDER (default "ekz")
       --verbose           run verbosely
 ```
 
-### SEE ALSO
+## SEE ALSO
 
-* [ekz](ekz.md)	 - Command line utility for creating EKS-D clusters on desktop
-* [ekz create cluster](ekz_create_cluster.md)	 - Create a cluster
+* [ekz](ekz.md)     - Command line utility for creating EKS-D clusters on desktop
+* [ekz create cluster](ekz_create_cluster.md)     - Create a cluster
 

docs/cmd/ekz_create_cluster.md

@@ -1,18 +1,18 @@
-## ekz create cluster
+# ekz create cluster
 
 Create a cluster
 
-### Synopsis
+## Synopsis
 
 The create sub-commands create EKS-D clusters.
 
-```
+```text
 ekz create cluster [flags]
 ```
 
-### Examples
+## Examples
 
-```
+```text
   # Create an EKS-D cluster with the default provider
   # The KubeConfig will be merged to $HOME/.kube/config. The default cluster name is 'ekz'.
   ekz create cluster
@@ -42,12 +42,11 @@ ekz create cluster [flags]
 
   # Create EKS-D cluster with a specific version of EKS-D
   ekz create --eksd-version=v1.18.9-eks-1-18-1 cluster
-
 ```
 
-### Options
+## Options
 
-```
+```text
       --eksd-version string   specify a version of EKS-D (default "v1.18.9-eks-1-18-1")
   -h, --help                  help for cluster
       --host                  run in the host mode
@@ -56,14 +55,14 @@ ekz create cluster [flags]
   -o, --output string         specify output file to write kubeconfig to (default "~/.kube/config")
 ```
 
-### Options inherited from parent commands
+## Options inherited from parent commands
 
-```
+```text
       --provider string   cluster provider possible values: "ekz", "kind". env: EKZ_PROVIDER (default "ekz")
       --verbose           run verbosely
 ```
 
-### SEE ALSO
+## SEE ALSO
 
-* [ekz create](ekz_create.md)	 - Create clusters
+* [ekz create](ekz_create.md)     - Create clusters
 

docs/cmd/ekz_delete.md

@@ -1,26 +1,26 @@
-## ekz delete
+# ekz delete
 
 Delete clusters
 
-### Synopsis
+## Synopsis
 
 The delete sub-commands delete EKS-D clusters.
 
-### Options
+## Options
 
-```
+```text
   -h, --help   help for delete
 ```
 
-### Options inherited from parent commands
+## Options inherited from parent commands
 
-```
+```text
       --provider string   cluster provider possible values: "ekz", "kind". env: EKZ_PROVIDER (default "ekz")
       --verbose           run verbosely
 ```
 
-### SEE ALSO
+## SEE ALSO
 
-* [ekz](ekz.md)	 - Command line utility for creating EKS-D clusters on desktop
-* [ekz delete cluster](ekz_delete_cluster.md)	 - Delete a cluster
+* [ekz](ekz.md)     - Command line utility for creating EKS-D clusters on desktop
+* [ekz delete cluster](ekz_delete_cluster.md)     - Delete a cluster