Skip to content

Commit 360a1c7

Browse files
christianhuthSispheor
authored andcommitted
Add Helm option to installation docs
1 parent 5f8a68c commit 360a1c7

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

docs/installation/kubernetes.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,40 @@
11
# Kubernetes deployment
22

3+
There are currently two deployment options available:
4+
5+
- Official Ansible-based installation
6+
- Community-maintained Helm Chart
7+
8+
## Ansible-based Installation
9+
310
!!!warning
411

512
This deployment is still a beta feature. Feel free to send pull requests to enhance the deployment or give us feedback though Gitter chat or GitHub discutions.
613

7-
## Pre-requisites
14+
### Pre-requisites
815

916
The Kubernetes deployment is wrapped by Ansible. The code has been tested with Ansible version `2.15.5`.
1017

11-
### Python
18+
#### Python
1219

1320
Install Python dependencies:
1421
```bash
1522
pip3 install -r k8s/requirements.txt
1623
```
1724

18-
### Ansible
25+
#### Ansible
1926

2027
Install Ansible dependencies:
2128

2229
```bash
2330
ansible-galaxy install -r k8s/requirements.yml
2431
```
2532

26-
### Helm
33+
#### Helm
2734

2835
Operators installation is handled by Helm. Follow [the official documentation](https://helm.sh/docs/intro/install/) to install Helm on your workstation.
2936

30-
## Ansible inventory
37+
### Ansible inventory
3138

3239
An example inventory file is present in `k8s/inventory/group_vars/all/squest.yml`.
3340

@@ -39,7 +46,7 @@ squest_namespace: "squest"
3946
k8s_storage_class: "thin"
4047
```
4148
42-
## Deploy Squest using Ansible
49+
### Deploy Squest using Ansible
4350
4451
Run the `deploy` playbook against your inventory config file:
4552

@@ -64,7 +71,7 @@ ansible-playbook -v -i inventory deploy.yml
6471

6572
## Configuration
6673

67-
### Squest config
74+
#### Squest config
6875

6976
The [Squest configuration](../configuration/squest_settings.md) is injected as environment variables. The environment is placed in `squest.yml` as `env` flag like the following:
7077
```yaml
@@ -117,3 +124,21 @@ squest_django:
117124
annotations:
118125
ingress_key: "ingress_value"
119126
```
127+
128+
## Helm-based Installation
129+
130+
### Pre-requisites
131+
132+
Installation is handled by Helm. Follow [the official documentation](https://helm.sh/docs/intro/install/) to install Helm on your workstation.
133+
134+
### Installation
135+
136+
```bash
137+
helm repo add christianhuth https://charts.christianhuth.de
138+
helm repo update
139+
helm install my-release christianhuth/squest
140+
```
141+
142+
### Configuration
143+
144+
Please check the documentation of the Chart for all available configuration options: [Documentation on ArtifactHub](https://artifacthub.io/packages/helm/christianhuth/squest).

0 commit comments

Comments
 (0)