Skip to content

[docs] Add Helm option to installation docs #827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2025
Merged

[docs] Add Helm option to installation docs #827

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 32 additions & 7 deletions docs/installation/kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,40 @@
# Kubernetes deployment

There are currently two deployment options available:

- Official Ansible-based installation
- Community-maintained Helm Chart

## Ansible-based Installation

!!!warning

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.

## Pre-requisites
### Pre-requisites

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

### Python
#### Python

Install Python dependencies:
```bash
pip3 install -r k8s/requirements.txt
```

### Ansible
#### Ansible

Install Ansible dependencies:

```bash
ansible-galaxy install -r k8s/requirements.yml
```

### Helm
#### Helm

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

## Ansible inventory
### Ansible inventory

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

Expand All @@ -39,7 +46,7 @@ squest_namespace: "squest"
k8s_storage_class: "thin"
```

## Deploy Squest using Ansible
### Deploy Squest using Ansible

Run the `deploy` playbook against your inventory config file:

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

## Configuration

### Squest config
#### Squest config

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:
```yaml
Expand Down Expand Up @@ -117,3 +124,21 @@ squest_django:
annotations:
ingress_key: "ingress_value"
```

## Helm-based Installation

### Pre-requisites

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

### Installation

```bash
helm repo add christianhuth https://charts.christianhuth.de
helm repo update
helm install my-release christianhuth/squest
```

### Configuration

Please check the documentation of the Chart for all available configuration options: [Documentation on ArtifactHub](https://artifacthub.io/packages/helm/christianhuth/squest).