https://github.com/mgoltzsche/kubeainer
A Kubernetes container image and Docker Compose project
https://github.com/mgoltzsche/kubeainer
compose container container-image cri-o crio development-environment development-tools docker-compose k8s kubernetes
Last synced: 8 months ago
JSON representation
A Kubernetes container image and Docker Compose project
- Host: GitHub
- URL: https://github.com/mgoltzsche/kubeainer
- Owner: mgoltzsche
- Created: 2019-01-20T21:48:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-10T21:22:20.000Z (over 3 years ago)
- Last Synced: 2024-12-28T15:49:50.655Z (9 months ago)
- Topics: compose, container, container-image, cri-o, crio, development-environment, development-tools, docker-compose, k8s, kubernetes
- Language: Shell
- Homepage:
- Size: 135 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Kubeainer 
=
A [Kubernetes](https://kubernetes.io/) container image and [Docker Compose](https://docs.docker.com/compose/compose-file/compose-file-v3/) project to spin up a local cluster for development and experimentation purposes.
It uses upstream Kubernetes as well as [CRI-O](https://github.com/cri-o/cri-o) and initializes the cluster using [kubeadm](https://github.com/kubernetes/kubeadm).
## Build and run from source
Clone the repo, build and run the container:
```sh
git clone https://github.com/mgoltzsche/kubeainer.git
make apps image compose-up
```
_Set the `NODES` parameter to scale._
## Usage
### Docker
Run a single-node cluster:
```sh
docker run -d --name mykube --privileged -v "`pwd`:/output" mgoltzsche/kubeainer:latest
```
Wait for the cluster to initialize:
```sh
docker exec mykube kubeainer install
export KUBECONFIG="`pwd`/kubeconfig.yaml
```
_You can provide additional apps to the `kubeainer install` command as shown [below](#apps)._
Complete example with ingress:
```sh
docker run -d --name mykube --privileged -p 80:80 -v "`pwd`:/output" mgoltzsche/kubeainer:latest
docker exec mykube kubeainer install ingress-nginx sample-app
docker exec mykube kubeainer retry 90 curl -fsS -H 'Host: sample-app.kubeainer.example.org' http://localhost
curl -fsS -H 'Host: sample-app.kubeainer.example.org' http://localhost
```
### Docker Compose
Run a single-node cluster:
```sh
docker-compose up -d --scale kube-node=0
```
_You can run a multi-node cluster by scaling the `kube-node` service._
Wait for the cluster to initialize:
```sh
docker-compose exec -T kube-master kubeainer install
```
_You can provide additional apps to the `kubeainer install` command as shown [below](#apps)._
Once the cluster is initialized the Kubernetes client configuration is written to `$PWD/kubeconfig.yaml` (`$PWD` is the compose directory) and can be used as follows:
```sh
export KUBECONFIG="$PWD/kubeconfig.yaml"
```
## Init processes
```
entrypoint.sh
└── exec systemd
├── crio
├── kubelet
└── kubeadm-bootstrap.sh
└── kubeadm
```
## Apps
The `kubeainer` script within the container can be used to install additional apps.
An app can be provided as directory that contains Kubernetes manifests.
The image already contains some apps within the `/etc/kubeainer/apps` directory.
By default the `flannel` app is installed.
To install additional apps, run e.g.:
```sh
docker-compose exec -T kube-master kubeainer install local-path-provisioner ingress-nginx cert-manager metallb external-dns
```
You can also mount your own Kubernetes manifests into the kubeainer container and use them as apps.