Skip to content

Allow for Graylog Helm Repo to Support Multiple Charts #52

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
monrax merged 5 commits into from
Dec 19, 2025
Merged

Allow for Graylog Helm Repo to Support Multiple Charts #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8c6b598
First look at the migration to charts
alix-graylog Nov 17, 2025
7463a06
Updates for cleaner migration
alix-graylog Nov 17, 2025
f194808
Merge branch 'main' into multi-chart-move
monrax Dec 19, 2025
93e2b86
update action
monrax Dec 19, 2025
475cbb5
update docs
monrax Dec 19, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/lint-and-test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ jobs:
steps:
- uses: actions/checkout@v3
- uses: d3adb5/helm-unittest-action@v2
- run: helm lint graylog
- run: helm lint charts/graylog
164 changes: 7 additions & 157 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,129 +17,19 @@ git commit -m "docs: add CONTRIBUTING.md"
git fetch origin
git rebase origin/main
```
- All PRs must be reviewed by at least one maintainer before merging.

# Testing
- Review and complete the steps in [docs/TESTING.md](docs/TESTING.md) before submitting a PR

- All PRs must be reviewed by at least one maintainer before merging.

- [Setting up a MicroK8s cluster](#setting-up-a-microk8s-cluster)
- [Validating chart](#validating-chart)
- [Installing Graylog](#installing-chart)
- [Upgrading chart](#upgrading-chart)
- [Verifying configurations](#verifying-different-configurations)
- [Running Helm tests](#running-the-helm-test-suite)
## Local Development

## Setting up a MicroK8s cluster
### Setting up a dev Kubernetes cluster

This Helm chart should ideally work on any Kubernetes cluster.
For local development and iterative testing, we recommend using MicroK8s.
This setup enables a rapid development workflow without the need to manage complex infrastructure.

#### Back up your existing Kubernetes configuration

```bash
[ -d $HOME/.kube ] && mv $HOME/.kube $HOME/.kube.old
```

### Install MicroK8s

```bash
microk8s install --cpu 8 --mem 24 --disk 200 --channel latest/stable
```
#### Configure access to your new MicroK8s Kubernetes cluster

```bash
mkdir $HOME/.kube && microk8s config -o yaml > $HOME/.kube/config
chmod 400 $HOME/.kube/config
```

### Enable [DNS](https://microk8s.io/docs/addon-dns) and [local storage](https://microk8s.io/docs/addon-hostpath-storage) addons

```bash
microk8s enable dns
microk8s enable hostpath-storage
```

### Enable MetalLB

You will need a valid IP address range on your network that MetalLB can use for LoadBalancer services.

#### Getting your CIDR

Depending on your OS, you might be running MicroK8s directly on Linux or inside a virtual machine on macOS.
Below are example commands for each setup:


<details>
<summary>Get CIDR on Linux using the <code>eth0</code> interface</summary>
<pre><code>CIDR=$(ip -4 -o addr show scope global | grep 'eth0' | awk '{print $4}' | sed 's|[0-9]\+/|0/|')</code></pre>
</details>

<details>
<summary>Get CIDR on macOS using the MicroK8s VM address</summary>
<pre><code>CIDR=$(multipass info microk8s-vm --format json | jq -r '.info["microk8s-vm"].ipv4[0] + "/32"')</code></pre>
</details>

You can verify that the CIDR was captured correctly with:

```bash
echo $CIDR
```

#### Enable MetalLB addon

Once you have your CIDR, you can enable metallb

```bash
microk8s enable metallb:$CIDR
```

> [!IMPORTANT]
> If you are running **MicroK8s on macOS**, you will need to increase the memory map areas per VM process

```bash
# only if running microk8s on macOS
multipass exec microk8s-vm -- sudo sysctl -w vm.max_map_count=262144
```

### Validating chart

```bash
# lint the chart for syntax
helm lint graylog

# check template rendering
helm template graylog . --debug | less

# do a dry run with a small configuration
helm install graylog . --dry-run --debug --create-namespace -n graylog --set graylog.replicas=1 --set datanode.replicas=1 --set mongodb.replicas=1 --set mongodb.arbiters=0

# do a dry run with the default configuration
helm install graylog . --dry-run --debug --create-namespace -n graylog

# validate against the JSON schema
helm template graylog . --validate
```

### Installing chart

```bash
# install the MongoDB Kubernetes Operator (required dependency)
helm upgrade --install mongodb-kubernetes-operator mongodb-kubernetes \
--repo https://mongodb.github.io/helm-charts --version "1.6.1" \
--set operator.watchNamespace="*" --reuse-values \
--namespace operators --create-namespace

# install the Graylog Helm chart
helm install graylog . -n graylog --set graylog.service.type="LoadBalancer" \
--set graylog.replicas=1 --set datanode.replicas=1 \
--namespace graylog --create-namespace

# watch pods come up
kubectl get pods -n graylog -w

# verify all resources
helm get all graylog -n graylog
```
For more info on how to set up a local MicroK8s environment, see: [Setting up a MicroK8s cluster](docs/microk8s-setup-guide.md)

### Upgrading chart

Expand All @@ -162,45 +52,5 @@ helm get all graylog -n graylog
> `--reuse-values` will be used by default. Otherwise, `--reset-values` will be used by default.
```bash
# keeps previously set values and overrides current "appVersion"
helm upgrade graylog . -n graylog --reuse-values --set version="6.3"
```

### Verifying different configurations

Verify that:
- All pods reach Running state (Graylog, DataNode, MongoDB)
- MongoDB replica set initializes properly
- Graylog UI is accessible and login works
- DataNodes register with Graylog (visible in System > Nodes)
- Inputs can be configured and receive data
- Persistence survives pod restarts

```sh
# scaling
helm upgrade graylog . -n graylog --set graylog.replicas=3 --reuse-values

# using a LoadBalancer service
helm upgrade graylog . -n graylog --set graylog.service.type=LoadBalancer --reuse-values

# with ingress enabled
helm upgrade graylog . -n graylog --set ingress.enabled=true --set ingress.web.enabled=true --reuse-values
helm upgrade graylog ./charts/graylog -n graylog --reuse-values --set version="7.1"
```

### Running the Helm test suite

This chart includes a test suite that can be run on a given Helm release, with the following tests:

| File | Test Name | Purpose |
|-------------------------------------|------------------------------------|---------------------------------------------------------------|
| `test-graylog-api-health.yaml` | graylog-test-api-health | Basic smoke test - checks /api/system/lbstatus returns 200 |
| `test-graylog-cluster-status.yaml` | graylog-test-cluster-status | Validates authentication and queries cluster nodes API |
| `test-datanode-registration.yaml` | graylog-test-datanode-registration | Verifies expected number of DataNodes registered with Graylog |
| `test-mongodb-connectivity.yaml` | graylog-test-mongodb | Tests MongoDB replica set connectivity and health |

```sh
# install the chart (if you haven't already)
helm upgrade -i graylog . -n graylog --create-namespace --reset-values

# run the test suite
helm test graylog -n graylog --logs
```
Loading
Loading