Skip to content

Commit 96a4326

Browse files
committed
Update README.md
1 parent dbfcb18 commit 96a4326

File tree

1 file changed

+42
-56
lines changed

1 file changed

+42
-56
lines changed

charts/graylog/README.md

Lines changed: 42 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -71,31 +71,10 @@ Make sure you have [Ingress Controller](#ingress-controller) installed, and that
7171
Then, configure `ingress.web.tls` and `ingress.config.issuer` with the name of an existing Issuer resource,
7272
and let `cert-manager` do the rest!
7373

74-
<!--
75-
### Install
76-
```sh
77-
helm install graylog graylog/graylog -n graylog --create-namespace
78-
```
79-
80-
### Upgrades
81-
```sh
82-
helm upgrade graylog graylog/graylog -n graylog --reuse-values
83-
```
84-
-->
85-
8674
# Installation
8775

8876
## Installing on Kubernetes
8977

90-
### Clone this repo
91-
```sh
92-
# clone repo
93-
git clone [email protected]:Graylog2/graylog-helm.git
94-
95-
# cd into the newly created graylog-helm directory
96-
cd graylog-helm
97-
```
98-
9978
### Install the official MongoDB Kubernetes Operator using Helm
10079
```sh
10180
helm upgrade --install mongodb-kubernetes-operator mongodb-kubernetes \
@@ -106,7 +85,14 @@ helm upgrade --install mongodb-kubernetes-operator mongodb-kubernetes \
10685

10786
### Install the official Graylog Helm chart
10887
```sh
109-
helm install graylog ./graylog --namespace graylog --create-namespace
88+
# add the repo
89+
helm repo add graylog https://graylog2.github.io/graylog-helm
90+
helm repo update
91+
```
92+
93+
```sh
94+
# install the chart
95+
helm install graylog graylog/graylog -n graylog --create-namespace
11096
```
11197

11298
That's it!
@@ -120,15 +106,6 @@ permissions to make calls to AWS APIs on your behalf, so be sure to
120106
[create the corresponding IAM role](https://docs.aws.amazon.com/eks/latest/userguide/csi-iam-role.html), or attach the
121107
`AmazonEBSCSIDriverPolicy` to your existing role.
122108

123-
### Clone this repo
124-
```sh
125-
# clone repo
126-
git clone [email protected]:Graylog2/graylog-helm.git
127-
128-
# cd into the newly created graylog-helm directory
129-
cd graylog-helm
130-
```
131-
132109
### Install the official MongoDB Kubernetes Operator using Helm
133110
```sh
134111
helm upgrade --install mongodb-kubernetes-operator mongodb-kubernetes \
@@ -137,10 +114,19 @@ helm upgrade --install mongodb-kubernetes-operator mongodb-kubernetes \
137114
--namespace operators --create-namespace
138115
```
139116

117+
### Install the official Graylog Helm chart
118+
119+
```sh
120+
# add the repo
121+
helm repo add graylog https://graylog2.github.io/graylog-helm
122+
helm repo update
123+
```
124+
140125
When deploying to Amazon EKS, use the `--set provider=aws` option to enable AWS-specific configurations:
141126

142127
```sh
143-
helm install graylog ./graylog --namespace graylog --create-namespace --set provider=aws
128+
# install the chart
129+
helm install graylog graylog/graylog --namespace graylog --create-namespace --set provider=aws
144130
```
145131

146132
When this option is set, the chart configures a custom `gp3` StorageClass optimized for Amazon EBS volumes,
@@ -149,7 +135,7 @@ and applies it to all PVCs managed by this chart.
149135
Alternatively, you may also specify another existing StorageClass (e.g., `gp2`), if available in your cluster:
150136

151137
```sh
152-
helm install graylog ./graylog --namespace graylog --create-namespace --set provider=aws --set global.storageClass=gp2
138+
helm install graylog graylog/graylog --namespace graylog --create-namespace --set provider=aws --set global.storageClass=gp2
153139
```
154140

155141
> [!NOTE]
@@ -168,7 +154,7 @@ the following command:
168154

169155
```sh
170156
echo "Enter your new password and press return:" && read -s pass
171-
helm upgrade graylog ./graylog --namespace graylog --reuse-values --set "graylog.config.rootPassword=$pass"; unset pass
157+
helm upgrade graylog graylog/graylog --namespace graylog --reuse-values --set "graylog.config.rootPassword=$pass"; unset pass
172158
```
173159

174160
## Set external access
@@ -181,15 +167,15 @@ Once an Ingress Controller has been installed and configured, run the following
181167
[Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) resource:
182168

183169
```sh
184-
helm upgrade graylog ./graylog -n graylog --set ingress.web.enabled="true" --reuse-values
170+
helm upgrade graylog graylog/graylog -n graylog --set ingress.web.enabled="true" --reuse-values
185171
```
186172

187173
### Alternative: LoadBalancer Service
188174
Alternatively, external access can be configured directly through the provided service without the need for any
189175
pre-existing dependencies.
190176

191177
```sh
192-
helm upgrade graylog ./graylog -n graylog --set graylog.service.type="LoadBalancer" --reuse-values
178+
helm upgrade graylog graylog/graylog -n graylog --set graylog.service.type="LoadBalancer" --reuse-values
193179
```
194180

195181
### Temporary access: Port Forwarding
@@ -204,22 +190,22 @@ kubectl port-forward service/graylog-svc 9000:9000 -n graylog
204190
## Scale Graylog
205191
```sh
206192
# scaling out: add more Graylog nodes to your cluster
207-
helm upgrade graylog ./graylog -n graylog --set graylog.replicas=3 --reuse-values
193+
helm upgrade graylog graylog/graylog -n graylog --set graylog.replicas=3 --reuse-values
208194

209195
# scaling in: remove Graylog nodes from your cluster
210-
helm upgrade graylog ./graylog -n graylog --set graylog.replicas=1 --reuse-values
196+
helm upgrade graylog graylog/graylog -n graylog --set graylog.replicas=1 --reuse-values
211197
```
212198

213199
## Scale DataNode
214200
```sh
215201
# scaling out: add more Graylog Data Nodes to your cluster
216-
helm upgrade graylog ./graylog -n graylog --set datanode.replicas=5 --reuse-values
202+
helm upgrade graylog graylog/graylog -n graylog --set datanode.replicas=5 --reuse-values
217203
```
218204

219205
## Scale MongoDB
220206
```sh
221207
# scaling out: add more MongoDB nodes to your replica set
222-
helm upgrade graylog ./graylog -n graylog --set mongodb.replicas=4 --reuse-values
208+
helm upgrade graylog graylog/graylog -n graylog --set mongodb.replicas=4 --reuse-values
223209
```
224210

225211
## Modify Graylog `server.conf` parameters
@@ -228,33 +214,33 @@ helm upgrade graylog ./graylog -n graylog --set mongodb.replicas=4 --reuse-value
228214
# A few examples:
229215

230216
# change server tz
231-
helm upgrade graylog ./graylog -n graylog --set graylog.config.timezone="America/Denver" --reuse-values
217+
helm upgrade graylog graylog/graylog -n graylog --set graylog.config.timezone="America/Denver" --reuse-values
232218

233219
# set JVM options
234-
helm upgrade graylog ./graylog -n graylog --set graylog.config.serverJavaOpts="-Xms2g -Xmx1g" --reuse-values
220+
helm upgrade graylog graylog/graylog -n graylog --set graylog.config.serverJavaOpts="-Xms2g -Xmx1g" --reuse-values
235221

236222
# redefine message journal maxAge
237-
helm upgrade graylog ./graylog -n graylog --set graylog.config.messageJournal.maxAge="24h" --reuse-values
223+
helm upgrade graylog graylog/graylog -n graylog --set graylog.config.messageJournal.maxAge="24h" --reuse-values
238224

239225
# enable CORS headers for HTTP interface
240-
helm upgrade graylog ./graylog -n graylog --set graylog.config.network.enableCors=true --reuse-values
226+
helm upgrade graylog graylog/graylog -n graylog --set graylog.config.network.enableCors=true --reuse-values
241227

242228
# enable email transport and set sender address
243-
helm upgrade graylog ./graylog -n graylog --set graylog.config.email.enabled=true --set graylog.config.email.senderAddress="[email protected]" --reuse-values
229+
helm upgrade graylog graylog/graylog -n graylog --set graylog.config.email.enabled=true --set graylog.config.email.senderAddress="[email protected]" --reuse-values
244230
```
245231

246232
## Customize deployed Kubernetes resources
247233
```sh
248234
# A few examples:
249235

250236
# expose the Graylog application with a LoadBalancer service
251-
helm upgrade graylog ./graylog -n graylog --set graylog.service.type="LoadBalancer" --reuse-values
237+
helm upgrade graylog graylog/graylog -n graylog --set graylog.service.type="LoadBalancer" --reuse-values
252238

253239
# modify readiness probe initial delay
254-
helm upgrade graylog ./graylog -n graylog --set graylog.readinessProbe.initialDelaySeconds=5 --reuse-values
240+
helm upgrade graylog graylog/graylog -n graylog --set graylog.readinessProbe.initialDelaySeconds=5 --reuse-values
255241

256242
# use a custom Storage Class for all resources (e.g. for AWS EKS)
257-
helm upgrade graylog ./graylog -n graylog --set global.storageClass="gp2" --reuse-values
243+
helm upgrade graylog graylog/graylog -n graylog --set global.storageClass="gp2" --reuse-values
258244
```
259245

260246
## Add inputs
@@ -278,7 +264,7 @@ Then, save it as `inputs.yaml`
278264

279265
Finally, upgrade your installation like so:
280266
```sh
281-
helm upgrade graylog ./graylog -n graylog -f inputs.yaml --reuse-values
267+
helm upgrade graylog graylog/graylog -n graylog -f inputs.yaml --reuse-values
282268
```
283269

284270
The inputs should now be exposed. Make sure to complete their configuration through the Graylog UI.
@@ -326,7 +312,7 @@ ingress:
326312
```
327313

328314
```sh
329-
helm upgrade graylog ./graylog -n graylog --reuse-values -f ingress-with-tls.yaml
315+
helm upgrade graylog graylog/graylog -n graylog --reuse-values -f ingress-with-tls.yaml
330316
```
331317

332318
### Option 2: Auto-issued certificates using cert-manager
@@ -356,7 +342,7 @@ ingress:
356342
```
357343

358344
```sh
359-
helm upgrade graylog ./graylog -n graylog --reuse-values -f ingress-with-tls.yaml --set ingress.config.tls.issuer.existingName='<name of your existing issuer resource>'
345+
helm upgrade graylog graylog/graylog -n graylog --reuse-values -f ingress-with-tls.yaml --set ingress.config.tls.issuer.existingName='<name of your existing issuer resource>'
360346
```
361347

362348
> [!NOTE]
@@ -382,15 +368,15 @@ kubectl create secret tls my-cert --cert=public.pem --key=private.key -n graylog
382368

383369
Enable TLS for your Graylog nodes, referencing the Kubernetes secret:
384370
```sh
385-
helm upgrade graylog ./graylog -n graylog --reuse-values --set graylog.config.tls.enabled=true --set graylog.config.tls.secretName="my-cert" --set graylog.config.tls.updateKeyStore=true
371+
helm upgrade graylog graylog/graylog -n graylog --reuse-values --set graylog.config.tls.enabled=true --set graylog.config.tls.secretName="my-cert" --set graylog.config.tls.updateKeyStore=true
386372
```
387373
The default set of trusted Certificate Authorities bundled in the Java Runtime for Java 17 is aligned with major,
388374
well-known public root CAs. Make sure to set `graylog.config.tls.updateKeyStore` to `true` if you are using a
389375
self-signed certificate, or if you think the CA that signed your certificate might not be among this default set.
390376

391377
## Enable Geolocation
392378
```sh
393-
helm upgrade graylog ./graylog -n graylog --reuse-values --set graylog.config.geolocation.enabled=true --set graylog.config.geolocation.maxmindGeoIp.enabled=true --set graylog.config.geolocation.maxmindGeoIp.accountId="<YOUR-MAXMIND-ACCOUNT-ID-HERE>" --set graylog.config.geolocation.maxmindGeoIp.licenseKey="<YOUR-MAXMIND-LICENSE-KEY-HERE>"
379+
helm upgrade graylog graylog/graylog -n graylog --reuse-values --set graylog.config.geolocation.enabled=true --set graylog.config.geolocation.maxmindGeoIp.enabled=true --set graylog.config.geolocation.maxmindGeoIp.accountId="<YOUR-MAXMIND-ACCOUNT-ID-HERE>" --set graylog.config.geolocation.maxmindGeoIp.licenseKey="<YOUR-MAXMIND-LICENSE-KEY-HERE>"
394380
```
395381

396382
Use the following paths when enabling the Geo-location processor in the Graylog web UI:
@@ -406,7 +392,7 @@ By default, this chart manages application secrets (including MongoDB credential
406392
If you already manage secrets using an external system, you can disable Helm-managed secrets and point the chart to your existing resources.
407393

408394
```sh
409-
helm upgrade -i graylog ./graylog -n graylog --reuse-values --set global.existingSecretName="<your secret name>"
395+
helm upgrade -i graylog graylog/graylog -n graylog --reuse-values --set global.existingSecretName="<your secret name>"
410396
```
411397

412398
> [!IMPORTANT]
@@ -427,15 +413,15 @@ corresponding pods.
427413
If you prefer to use your own MongoDB instance, you can disable the custom MongoDB resource and configure the chart to
428414
connect to your external database:
429415
```sh
430-
helm upgrade --install graylog ./graylog --namespace graylog --reuse-values \
416+
helm upgrade --install graylog graylog/graylog --namespace graylog --reuse-values \
431417
--set mongodb.communityResource.enabled=false \
432418
--set graylog.config.mongodb.customUri="mongodb[+srv]://<username>:<password>@<hostname>:<port>[,<i-th hostname>:<i-th port>]/<db name>"
433419
```
434420

435421
**Alternatively**, the MongoDB URI can also be provided as part of an externally-managed secret:
436422

437423
```sh
438-
helm upgrade --install graylog ./graylog --namespace graylog --reuse-values \
424+
helm upgrade --install graylog graylog/graylog --namespace graylog --reuse-values \
439425
--set mongodb.communityResource.enabled=false \
440426
--set global.existingSecretName="<your secret name>"
441427
```

0 commit comments

Comments
 (0)