Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kvaps/kube-linstor
Containerized LINSTOR SDS for Kubernetes, ready for production use.
https://github.com/kvaps/kube-linstor
docker drbd kubernetes linstor lvm sds zfs
Last synced: about 2 months ago
JSON representation
Containerized LINSTOR SDS for Kubernetes, ready for production use.
- Host: GitHub
- URL: https://github.com/kvaps/kube-linstor
- Owner: kvaps
- License: apache-2.0
- Created: 2018-06-25T12:30:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-16T08:31:24.000Z (over 2 years ago)
- Last Synced: 2024-06-03T09:39:52.085Z (4 months ago)
- Topics: docker, drbd, kubernetes, linstor, lvm, sds, zfs
- Language: Shell
- Homepage:
- Size: 328 KB
- Stars: 129
- Watchers: 7
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kube-Linstor
Containerized Linstor Storage easy to run in your Kubernetes cluster.
> :warning: **This project currently unmaintained**
>
> I decided join forces over creation the union solution for running LINSTOR on Kubenretes, and contribute missing features of this chart to upstream project: [piraeus-operator](https://github.com/piraeusdatastore/piraeus-operator).
>
> If you want to upgrade, you can easily switch between them, see https://github.com/kvaps/kube-linstor/issues/53#issuecomment-1028006151 for more details.
>
> Dockefiles continue maintaining in [Deckhouse](https://github.com/deckhouse/deckhouse/tree/main/modules/031-linstor/images) project.
## Images
| Image | Latest Tag |
|:---------------------------------|:-----------------------------------------------------------------------------------------|
| **[linstor-controller]** | [![linstor-controller-version]](https://hub.docker.com/r/kvaps/linstor-controller) |
| **[linstor-satellite]** | [![linstor-satellite-version]](https://hub.docker.com/r/kvaps/linstor-satellite) |
| **[linstor-csi]** | [![linstor-csi-version]](https://hub.docker.com/r/kvaps/linstor-csi) |
| **[linstor-stork]** | [![linstor-stork-version]](https://hub.docker.com/r/kvaps/linstor-stork) |
| **[linstor-ha-controller]** | [![linstor-ha-controller-version]](https://hub.docker.com/r/kvaps/linstor-ha-controller) |
[linstor-controller]: dockerfiles/linstor-controller/Dockerfile
[linstor-controller-version]: https://img.shields.io/docker/v/kvaps/linstor-controller.svg?sort=semver
[linstor-satellite]: dockerfiles/linstor-satellite/Dockerfile
[linstor-satellite-version]: https://img.shields.io/docker/v/kvaps/linstor-satellite.svg?sort=semver
[linstor-csi]: dockerfiles/linstor-csi/Dockerfile
[linstor-csi-version]: https://img.shields.io/docker/v/kvaps/linstor-csi.svg?sort=semver
[linstor-stork]: dockerfiles/linstor-stork/Dockerfile
[linstor-stork-version]: https://img.shields.io/docker/v/kvaps/linstor-stork.svg?sort=semver
[linstor-ha-controller]: dockerfiles/linstor-ha-controller/Dockerfile
[linstor-ha-controller-version]: https://img.shields.io/docker/v/kvaps/linstor-ha-controller.svg?sort=semver
## Requirements
* Working Kubernetes cluster (`v1.18` or higher).
* DRBD9 kernel module installed on each satellite node.
* PostgeSQL database / etcd or any other backing store for redundancy.
* [Snapshot Controller](https://kubernetes-csi.github.io/docs/snapshot-controller.html#snapshot-controller) (optional)
## QuckStart
Kube-Linstor consists of several components:
* **Linstor-controller** - Controller is the main control point for Linstor. It provides an API for clients and communicates with satellites for creating and monitoring DRBD-devices.
* **Linstor-satellite** - Satellites run on every node. They listen and perform controller tasks, and operate directly with LVM and ZFS subsystems.
* **Linstor-csi** - CSI driver provides compatibility level for adding Linstor support for Kubernetes.
* **Linstor-stork** - Stork is a scheduler extender plugin for Kubernetes which allows a storage driver to give the Kubernetes scheduler hints about where to place a new pod so that it is optimally located for storage performance.
#### Preparation
[Install Helm](https://helm.sh/docs/intro/).
> **_NOTE:_**
> Commands below provided for Helm v3 but Helm v2 is also supported.
> You can use `helm template` instead of `helm install`, this is also working as well.
Create `linstor` namespace.
```
kubectl create ns linstor
```
Install Helm repository:
```
helm repo add kvaps https://kvaps.github.io/charts
```
#### Database
* Install [stolon](https://github.com/kvaps/stolon-chart) chart:
```bash
# download example values
curl -LO https://github.com/kvaps/kube-linstor/raw/v1.14.0/examples/linstor-db.yaml
# install release
helm install linstor-db kvaps/stolon \
--namespace linstor \
-f linstor-db.yaml
```
> **_NOTE:_**
> The current example will deploy stolon cluster on your Kubernetes-master nodes
> **_NOTE:_**
> In case of update your stolon add `--set job.autoCreateCluster=false` flag to not reinitialisate your cluster.
* Create Persistent Volumes:
```bash
helm install data-linstor-db-stolon-keeper-0 kvaps/pv-hostpath \
--namespace linstor \
--set path=/var/lib/linstor-db \
--set node=node1
helm install data-linstor-db-stolon-keeper-1 kvaps/pv-hostpath \
--namespace linstor \
--set path=/var/lib/linstor-db \
--set node=node2
helm install data-linstor-db-stolon-keeper-2 kvaps/pv-hostpath \
--namespace linstor \
--set path=/var/lib/linstor-db \
--set node=node3
```
Parameters `name` and `namespace` **must match** the PVC's name and namespace of your database, `node` should match exact node name.
Check your PVC/PV list after creation, if everything right, they should obtain **Bound** status.
* Connect to database:
```bash
kubectl exec -ti -n linstor sts/linstor-db-stolon-keeper -- bash
PGPASSWORD=$(cat $STKEEPER_PG_SU_PASSWORDFILE) psql -h linstor-db-stolon-proxy -U stolon postgres
```
* Create user and database for linstor:
```bash
CREATE DATABASE linstor;
CREATE USER linstor WITH PASSWORD 'hackme';
GRANT ALL PRIVILEGES ON DATABASE linstor TO linstor;
```
#### Linstor
* Install kube-linstor chart:
```bash
# download example values
curl -LO https://github.com/kvaps/kube-linstor/raw/v1.14.0/examples/linstor.yaml
# install release
helm install linstor kvaps/linstor --version 1.14.0 \
--namespace linstor \
-f linstor.yaml
```
> **_NOTE:_**
> The current example will deploy linstor- and csi-controllers on your Kubernetes-master nodes and satellites on all nodes in the cluster.
## Install snapshot-controller
https://kubernetes-csi.github.io/docs/snapshot-controller.html#deployment
## Usage
The satellite nodes will register themselves on controller automatically by init-container.
You can get interactive linstor shell by simple exec into **linstor-controller** pod:
```bash
kubectl exec -ti -n linstor deploy/linstor-controller -- linstor interactive
```
Refer to [official linstor documentation](https://docs.linbit.com/docs/linstor-guide/) to define ***storage pools*** on them and configure ***resource groups***.
#### SSL notes
This chart enables SSL encryption for control-plane by default. It does not affect the DRBD performance but makes your LINSTOR setup more secure.
If you want to have external access, you need to download certificates for linstor client:
```bash
kubectl get secrets --namespace linstor linstor-client-tls \
-o go-template='{{ range $k, $v := .data }}{{ $v | base64decode }}{{ end }}'
```
Then follow [official linstor documentation](https://www.linbit.com/drbd-user-guide/users-guide-linstor/#s-rest-api-https-restricted-client) to configure the client.
## Additional Information
* [Perform backups and database management](docs/BACKUP.md)
* [Upgrade notes](docs/UPGRADE.md)
## How Kube-Linstor compares to other DRBD-on-Kubernetes solutions
### Piraeus Operator
[Piraeus Operator][piraeus-operator] is the operator that powers [Piraeus][piraeus], [LINBIT][linbit]'s official Software Defined Storage (SDS) solution for Kubernetes. The dependencies of Kube-Linstor and Piraeus Operator are mostly shared, as both projects aim to create and administer LINSTOR clusters, but there are some differences in methodology and features:
- Kube-Linstor aims to be simple to operate, with less built-in logic for more straight-forward administration. To achieve this goal Kube-Linstor installs via a simple Helm chart, and installs primarily Kubernetes-native resources (Deployments, DaemonSets, etc).
- Piraeus Operator relies heavily on a [Custom Resource Definition][k8s-crd]-driven approach to bootstrapping pieces of infrastructure like the [Linstor-Server][linstor-server] (satellites, etc) itself. With Piraeus Operator you create CRDs that manage the creation of Kubernetes-native resources
- Kube-Linstor directly contains the Deployments, DaemonSets and other Kubernetes-native resources as necessary
- Both Piraeus Operator and Kube-Linstor offer offers automatic configuration of nodes, storage pools and other LINSTOR-related resources. Where Piraeus Operator accomplishes this with CRDs, Kube-Linstor uses simple shell script with template helpers integrated into the Helm chart
- Piraeus Operator offers automatic DRBD9 Kernel Module Injection Image. Kube-Linstor expects the DRBD9 kernel module to pre-installed on all nodes.
[piraeus-operator]: https://github.com/piraeusdatastore/piraeus-operator
[piraeus]: https://piraeus.io/
[linstor-server]: https://github.com/LINBIT/linstor-server
[k8s-crd]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/
[linbit]: https://linbit.com
## Licenses
* **[This project](LICENSE)** under **Apache License**
* **[linstor-server]**, **[drbd]** and **[drbd-utils]** is **GPL** licensed by LINBIT
* **[linstor-csi]** under **Apache License** by LINBIT
* **[stork]** under **Apache License**
[linstor-server]: https://github.com/LINBIT/linstor-server/blob/master/COPYING
[drbd]: https://github.com/LINBIT/drbd-9.0/blob/master/COPY
[drbd-utils]: https://github.com/LINBIT/drbd-utils/blob/master/COPYING
[linstor-csi]: https://github.com/piraeusdatastore/linstor-csi/blob/master/LICENSE
[stork]: https://github.com/libopenstorage/stork/blob/master/LICENSE