Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weaveworks/wks-quickstart-firekube
Example configuration to create Kubernetes clusters powered by ignite and gitops
https://github.com/weaveworks/wks-quickstart-firekube
Last synced: about 1 month ago
JSON representation
Example configuration to create Kubernetes clusters powered by ignite and gitops
- Host: GitHub
- URL: https://github.com/weaveworks/wks-quickstart-firekube
- Owner: weaveworks
- Archived: true
- Created: 2019-09-06T10:29:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-29T13:34:34.000Z (over 1 year ago)
- Last Synced: 2024-08-03T01:38:12.237Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 297 KB
- Stars: 343
- Watchers: 43
- Forks: 375
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-repositories - weaveworks/wks-quickstart-firekube - Example configuration to create Kubernetes clusters powered by ignite and gitops (Shell)
README
# Deprecated
This repository is no longer maintained. For a more up-to-date way to manage microVMs, please take a look at [Flintlock](https://github.com/weaveworks-liquidmetal/flintlock).
# Firekube
Firekube is a Kubernetes cluster working on top of [ignite][gh-ignite] and
[firecracker][gh-firecracker]. Firekube clusters are operated with
[GitOps][ww-gitops].
[ignite][gh-ignite] and [firecracker][gh-firecracker] only work on Linux as
they need [KVM][kvm]. Fortunately we will also work on macOS using
[footloose][footloose]: the Kubernetes nodes are then running inside
containers.
## Creating a Firekube cluster
**Prerequisites**: docker, git, [kubectl 1.14+][kubectl].
1. Fork this repository.
1. Clone your fork and `cd` into it. Use the `SSH` git URL as the script will
push an initial commit to your fork:
```console
export user="" # Your GitHub handle or org
git clone [email protected]:$user/wks-quickstart-firekube.git
cd wks-quickstart-firekube
```
1. Start the cluster:
```console
./setup.sh
```
This step will take several minutes.
**Please note** that the `setup.sh` script will detect which OS you're on.
If it's macOS, the script will automatically set `backend: docker` inside `config.yaml`. This config is to start the cluster in containers as there is no KVM on macOS. However, Firekube on Linux will run either with `backend: ignite` (ignite VMs) or `backend: docker` (containers). So the `setup.sh` script won't touch the backend value inside `config.yaml` if you're on Linux. In case you started Firekube (in containers) on macOS then switched to try it on Linux, please make sure that the backend value is set to `backend: ignite` so that you can start the cluster on ignite / firecracker VMs.
1. Export the `KUBECONFIG` environment variable as indicated at the end of the installation:
```console
export KUBECONFIG=/home/damien/.wks/weavek8sops/example/kubeconfig
```
Enjoy your Kubernetes cluster!
```console
$ kubectl get nodes
NAME STATUS ROLES AGE VERSION
67bb6c4812b19ce4 Ready master 3m42s v1.14.1
a5cf619fa058882d Ready 75s v1.14.1
```
[gh-ignite]: https://github.com/weaveworks/ignite
[gh-firecracker]: https://github.com/firecracker-microvm/firecracker
[footloose]: https://github.com/weaveworks/footloose
[kubectl]: https://v1-14.docs.kubernetes.io/docs/tasks/tools/install-kubectl/
[kvm]: https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine
[ww-gitops]: https://www.weave.works/technologies/gitops/
## Watch GitOps in action
Now that we have a cluster installed, we can commit Kubernetes objects to the
git repository and have them appear in the cluster. Let's add
[podinfo][podinfo], an example Go microservice, to the cluster.
[podinfo]: https://github.com/stefanprodan/podinfo
```sh
kubectl apply --dry-run -k github.com/stefanprodan/podinfo//kustomize -o yaml > podinfo.yaml
git add podinfo.yaml
git commit -a -m 'Add podinfo Deployment'
git push
```
A few seconds later, you should witness the apparition of a podinfo pod in
the cluster:
```console
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
podinfo-677768c755-z76xk 1/1 Running 0 30s
```
To view `podinfo` web UI:
1. Expose `podinfo` locally:
```
kubectl port-forward deploy/podinfo 9898:9898
```
1. Point your browser to `http://127.0.0.1:9898`:
## Deleting a Firekube cluster
Run:
```console
./cleanup.sh
```
## Using a private git repository with firekube
To use a private git repository instead of a fork of `wks-quickstart-firekube`:
1. Create a private repository and push the `wks-quickstart-firekube`
`master` branch there. Use the SSH git URL when cloning the private
repository:
```
git clone [email protected]:$user/$repository.git
cd $repository
git remote add quickstart [email protected]:weaveworks/wks-quickstart-firekube.git
git fetch quickstart
git merge quickstart/master
git push
```
1. Create an SSH key pair:
```console
ssh-keygen -t rsa -b 4096 -C "[email protected]" -f deploy-firekube -N ""
```
1. Upload the deploy key to your private repository (with read/write access):
1. Start the cluster:
```console
./setup.sh --git-deploy-key ./deploy-firekube
```
## Getting Help
If you have any questions about, feedback for or problems with `wks-quickstart-firekube`:
- Invite yourself to the Weave Users Slack.
- Ask a question on the [#general](https://weave-community.slack.com/messages/general/) slack channel.
- [File an issue](https://github.com/weaveworks/wks-quickstart-firekube/issues/new).
- Join the discussion
- Invite yourself to the Weave community Slack
- Ask a question on the [#firekube](https://weave-community.slack.com/messages/firekube/) Slack channel
Weaveworks follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Weaveworks project maintainer, or Alexis Richardson ([email protected]).
Your feedback is always welcome!
## License
[Apache 2.0](LICENSE)