diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 27ece04..372a4ee 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -26,6 +26,7 @@ jobs: overwrite: 'true' files: | ${{ github.workspace }}/bin/k3k + ${{ github.workspace }}/bin/k3kcli - name: Docker Hub Login uses: docker/login-action@v2 with: diff --git a/README.md b/README.md new file mode 100644 index 0000000..5de5b61 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# K3K + +A Kubernetes in Kubernetes tool, k3k provides a way to run multiple embedded isolated k3s clusters on your kubernetes cluster. + +## Why? + +![alt text](https://github.com/galal-hussein/k3k/blob/main/hack/becausewecan.jpg?raw=true) + + +## Usage + +K3K consists of a controller and a cli tool, the controller can be deployed via a helm chart and the cli can be downloaded from the releases page. + +### Deploy Controller + +[Helm](https://helm.sh) must be installed to use the charts. Please refer to +Helm's [documentation](https://helm.sh/docs) to get started. + +Once Helm has been set up correctly, add the repo as follows: + + helm repo add k3k https://galal-hussein.github.io/k3k + +If you had already added this repo earlier, run `helm repo update` to retrieve +the latest versions of the packages. You can then run `helm search repo +k3k` to see the charts. + +To install the k3k chart: + + helm install my-k3k k3k/k3k + +To uninstall the chart: + + helm delete my-k3k + +### Create a new cluster + +To create a new cluster you need to install and run the cli or create a cluster object, to install the cli: + +``` +wget https://github.com/galal-hussein/k3k/releases/download/v0.0.0-alpha2/k3k +chmod +x k3k +sudo cp k3k /usr/local/bin +``` + +To create a new cluster you can use: +``` +k3k cluster create --name example-cluster --token test +``` \ No newline at end of file diff --git a/hack/becausewecan.jpg b/hack/becausewecan.jpg new file mode 100644 index 0000000..a09201a Binary files /dev/null and b/hack/becausewecan.jpg differ