Name	Name	Last commit message	Last commit date
parent directory ..
templates	templates
Chart.yaml	Chart.yaml
README.md	README.md
requirements.yaml	requirements.yaml
values.yaml	values.yaml

DEPRECATED - Graylog

This chart has been deprecated and moved to its new home:

GitHub repo: https://github.com/KongZ/charts
Charts repo: https://charts.kong-z.com/

This chart provide the Graylog deployments. Note: It is strongly recommend to use on Official Graylog image to run this chart.

Quick Installation

This chart requires the following charts before install Graylog

MongoDB
Elasticsearch

To install the Graylog Chart with all dependencies

kubectl create namespace graylog

helm install --namespace "graylog" -n "graylog" stable/graylog

Manually Install Dependencies

This method is recommended when you want to expand the availability, scalability, and security of the services. You need to install MongoDB replicaset and Elasticsearch with proper settings before install Graylog.

To install MongoDB, run

helm install --namespace "graylog" -n "mongodb" stable/mongodb-replicaset

To install Elasticsearch, run

helm install --namespace "graylog" -n "elasticsearch" stable/elasticsearch

Note: There are many alternative Elasticsearch available on GitHub. If you found the stable/elasticsearch is not suitable, you can search other charts from GitHub repositories.

Install Chart

To install the Graylog Chart into your Kubernetes cluster (This Chart requires persistent volume by default, you may need to create a storage class before install chart.

helm install --namespace "graylog" -n "graylog" stable/graylog \
  --set tags.install-mongodb=false\
  --set tags.install-elasticsearch=false\
  --set graylog.mongodb.uri=mongodb://mongodb-mongodb-replicaset-0.mongodb-mongodb-replicaset.graylog.svc.cluster.local:27017/graylog?replicaSet=rs0 \
  --set graylog.elasticsearch.hosts=http://elasticsearch-client.graylog.svc.cluster.local:9200

After installation succeeds, you can get a status of Chart

helm status "graylog"

If you want to delete your Chart, use this command

helm delete --purge "graylog"

Install Chart with specific Graylog cluster size

By default, this Chart will create a graylog with 2 nodes (1 master, 1 coordinating). If you want to change the cluster size during installation, you can use --set graylog.replicas={value} argument. Or edit values.yaml

For example: Set cluster size to 5

helm install --namespace "graylog" -n "graylog" --set graylog.replicas=5 stable/graylog

The command above will install 1 master and 4 coordinating.

Install Chart with specific node pool

Sometime you may need to deploy your graylog to specific node pool to allocate resources.

Using node selector

For example, you have 6 vms in node pools and you want to deploy graylog to node which labeled as cloud.google.com/gke-nodepool: graylog-pool Set the following values in values.yaml

graylog:
   nodeSelector: { cloud.google.com/gke-nodepool: graylog-pool }

Using tolerations

For example, you have 6 vms in node pools and 3 nodes are tainted with NO_SCHEDULE graylog=true Set the following values in values.yaml

graylog:
  tolerations:
    - key: graylog
      value: "true"
      operator: "Equal"

Configuration

The following table lists the configurable parameters of the Graylog chart and their default values.

Parameter	Description	Default
`graylog.image.repository`	`graylog` image repository	`graylog/graylog:3.1`
`graylog.imagePullPolicy`	Image pull policy	`IfNotPresent`
`graylog.replicas`	The number of Graylog instances in the cluster. The chart will automatic create assign master to one of replicas	`2`
`graylog.resources`	CPU/Memory resource requests/limits	Memory: `1024Mi`, CPU: `500m`
`graylog.heapSize`	Override Java heap size. If this value empty, chart will allocate heapsize using `-XX:+UseCGroupMemoryLimitForHeap`
`graylog.externalUri`	External URI that Graylog is available at
`graylog.nodeSelector`	Graylog server pod assignment	`{}`
`graylog.affinity`	Graylog server affinity	`{}`
`graylog.tolerations`	Graylog server tolerations	`[]`
`graylog.nodeSelector`	Graylog server node selector	`{}`
`graylog.env`	Graylog server env variables	`{}`
`graylog.envRaw`	Graylog server env variables in raw yaml format	`{}`
`graylog.privileged`	Run as a privileged container	`false`
`graylog.additionalJavaOpts`	Graylog service additional `JAVA_OPTS`
`graylog.service.type`	Kubernetes Service type	`ClusterIP`
`graylog.service.port`	Graylog Service port	`9000`
`graylog.service.ports`	Graylog Service extra ports	`[]`
`graylog.service.master.enabled`	If true, Graylog Master Service will be created	`true`
`graylog.service.master.port`	Graylog Master Service port	`9000`
`graylog.service.master.annotations`	Graylog Master Service annotations	`{}`
`graylog.service.headless.suffix`	If present, suffix appended to the name of the chart to form the headless service name, ie: `-headless` would result in `graylog-headless`
`graylog.podAnnotations`	Kubernetes Pod annotations	`{}`
`graylog.terminationGracePeriodSeconds`	Pod termination grace period	`120`
`graylog.updateStrategy`	Update Strategy of the StatefulSet	`RollingUpdate`
`graylog.persistence.enabled`	Use a PVC to persist data	`true`
`graylog.persistence.storageClass`	Storage class of backing PVC (uses storage class annotation)	`nil`
`graylog.persistence.accessMode`	Use volume as ReadOnly or ReadWrite	`ReadWriteOnce`
`graylog.persistence.size`	Size of data volume	`10Gi`
`graylog.tls.enabled`	If true, Graylog will listen on HTTPS	`false`
`graylog.tls.keyFile`	Path to key file for HTTPS	`/etc/graylog/server/server.key`
`graylog.tls.certFile`	Path to crt file for HTTPS	`/etc/graylog/server/server.cert`
`graylog.ingress.enabled`	If true, Graylog Ingress will be created	`false`
`graylog.ingress.port`	Graylog Ingress port	`false`
`graylog.ingress.annotations`	Graylog Ingress annotations	`{}`
`graylog.ingress.hosts`	Graylog Ingress host names	`[]`
`graylog.ingress.tls`	Graylog Ingress TLS configuration (YAML)	`[]`
`graylog.ingress.extraPaths`	Ingress extra paths to prepend to every host configuration. Useful when configuring custom actions with AWS ALB Ingress Controller.	`[]`
`graylog.input`	Graylog Input configuration (YAML) Sees #Input section for detail	`{}`
`graylog.metrics.enabled`	If true, add Prometheus annotations to pods	`false`
`graylog.geoip.enabled`	If true, Maxmind Geoip Lite will be installed to ${GRAYLOG_HOME}/etc/GeoLite2-City.mmdb	`false`
`graylog.geoip.mmdbUri`	If set and geoip enabled, Maxmind Geoip Lite will be installed from the URL you have defined to ${GRAYLOG_HOME}/etc/GeoLite2-City.mmdb
`graylog.plugins`	A list of Graylog installation plugins	`[]`
`graylog.rootUsername`	Graylog root user name	`admin`
`graylog.rootPassword`	Graylog root password. If not set, random 16-character alphanumeric string
`graylog.rootEmail`	Graylog root email.
`graylog.existingRootSecret`	Graylog existing root secret
`graylog.rootTimezone`	Graylog root timezone.	`UTC`
`graylog.elasticsearch.hosts`	Graylog Elasticsearch host name. You need to specific where data will be stored.
`graylog.elasticsearch.uriSecretName`	K8s secret name where elasticsearch hosts will be set from.	`{{ graylog.fullname }}-es`
`graylog.elasticsearch.uriSecretKey`	K8s secret key name where elasticsearch hosts will be set from.
`graylog.elasticsearch.uriSSL`	Prepends 'https://' to the URL fetched from 'uriSecretKey' if true. Prepends `http://` otherwise.	`false`
`graylog.mongodb.uri`	Graylog MongoDB connection string. You need to specific where data will be stored.
`graylog.mongodb.uriSecretName`	K8s secret name where MongoDB URI will be set from.	`{{ graylog.fullname }}-mongodb`
`graylog.mongodb.uriSecretKey`	K8s secret key name where MongoDB URI will be set from.
`graylog.transportEmail.enabled`	If true, enable transport email settings on Graylog	`false`
`graylog.transportEmail.hostname`	The hostname of the server used to send the email
`graylog.transportEmail.port`	The port of the server used to send the email
`graylog.transportEmail.useTls`	If true, use TLS to connect to the mailserver
`graylog.transportEmail.useSsl`	If true, use SSL to connect to the mailserver
`graylog.transportEmail.useAuth`	If true, authenticate to the email server
`graylog.transportEmail.authUsername`	The username for server authentication
`graylog.transportEmail.authPassword`	The password for server authentication
`graylog.transportEmail.subjectPrefix`	Prepend this string to every mail subjects
`graylog.transportEmail.fromEmail`	Use this as a FROM address
`graylog.config`	Add additional server configuration to `graylog.conf` file.
`graylog.serverFiles`	Add additional server files on /etc/graylog/server. This is useful for enable TLS on input	`{}`
`graylog.logInJson`	If true, Graylog pods will be configured to log in JSON (one event per line	`false`
`graylog.journal.deleteBeforeStart`	Delete all journal files before start Graylog	`false`
`graylog.init.resources`	Configure resource requests and limits for the Graylog StatefulSet initContainer	`{}`
`graylog.provisioner.enabled`	Enable optional Job to run an arbitrary Bash script	`false`
`graylog.provisioner.annotations`	Graylog provisioner Job annotations	`{}`
`graylog.provisioner.useGraylogServiceAccount`	Use the same ServiceAccount used by Graylog pod	`false`
`graylog.provisioner.script`	The contents of the provisioner Bash script
`graylog.sidecarContainers`	Sidecar containers to run in the server statefulset	`[]`
`graylog.extraVolumeMounts`	Additional Volume mounts	`[]`
`graylog.extraVolumes`	Additional Volumes	`[]`
`graylog.extraInitContainers`	Additional Init containers	`[]`
`rbac.create`	If true, create & use RBAC resources	`true`
`rbac.resources`	List of resources	`[pods, secrets]`
`serviceAccount.create`	If true, create the Graylog service account	`true`
`serviceAccount.name`	Name of the server service account to use or create	`{{ graylog.fullname }}`
`tags.install-mongodb`	If true, this chart will install MongoDB from requirement dependencies. If you want to install MongoDB by yourself, please set to `false`	`true`
`tags.install-elasticsearch`	If true, this chart will install Elasticsearch from requirement dependencies. If you want to install Elasticsearch by yourself, please set to `false`	`true`
`imagePullSecrets`	Configuration for imagePullSecrets so that you can use a private registry for your images	`[]`

How it works

This chart will create a Graylog statefulset with one Master node. The chart will automatically create Master node Pod label graylog-role=master, if it does not exists. The others Pods will be label with graylog-role=coordinating

This chart will automatically calculate Java heap size from given resources.requests.memory value. If you want to specify number of heap size, you can set graylog.heapSize to your desired value. The graylog.heapSize value must be in JVM -Xmx format.

Input

You can enable input ports by edit the input values. For example, you want to create a GELF input on port 12222, and 12223 with Cloud LoadBalancer and syslog on UDP port 5410 without load balancer.

In services of type: LoadBalancer, the default externalTrafficPolicy is Cluster, but may be overridden in order to preserve the client IP with Local.

  input:
    tcp:
      service:
        type: LoadBalancer
        externalTrafficPolicy: Local
        loadBalancerIP:
      ports:
        - name: gelf1
          port: 12222
        - name: gelf2
          port: 12223
    udp:
      service:
        type: ClusterIP
      ports:
        - name: syslog
          port: 5410

OR, if you want to expose only a single service with all the input ports open, you can do so by specifying the service.ports value:

  service:
    ports:
      - name: gelf
        port: 12222
        protocol: TCP
      - name: syslog
        port: 5410
        protocol: UDP

Note: Name must be in IANA_SVC_NAME format - at most 15 characters, matching regex [a-z0-9], containing at least one letter, and hyphens cannot be adjacent to other hyphens

Note: The port list should be sorted by port number.

TLS

To enable TLS on input in Graylog, you need to specify the server private key and certificate. You can add them in graylog.serverFiles value. For example

graylog:
  serverFiles:
    server.cert: |
      -----BEGIN CERTIFICATE-----
      MIIFYTCCA0mgAwIBAgICEAIwDQYJKoZIhvcNAQELBQAwcjELMAkGA1UEBhMCVEgx
      EDAOBgNVBAgMB0Jhbmdrb2sxEDAOBgNVBAcMB0Jhbmdrb2sxGDAWBgNVBAoMD09t
      aXNlIENvLiwgTHRkLjEPMA0GA1UECwwGRGV2b3BzMRQwEgYDVQQDDAtjYS5vbWlz
      ZS5jbzAeFw0xNzA2MDEwOTQ0NTJaFw0xOTA2MjEwOTQ0NTJaMHkxCzAJBgNVBAYT
      AlRIMRAwDgYDVQQIDAdCYW5na29rMRAwDgYDVQQHDAdCYW5na29rMRgwFgYDVQQK
      DA9PbWlzZSBDby4sIEx0ZC4xDzANBgNVBAsMBkRldm9wczEbMBkGA1UEAwwSZ3Jh
      4YE6FOKJmiDV7KsmoSO2JTEaZAK6sdxI7zFJJH0TNFIuKewEBsVH/W5RccjwK/z/
      BHwoTQc95zbfFjt1JwDiq8jGTVnQoXH99wAIW+HDYq6hqHyqW3YuQ8QvXfi/ebAs
      rn0urmEC7JhsZIg92AqVYEgdp5H6uFqPIK1U6aYrz5zzZpRfEA==
      -----END CERTIFICATE-----
    server.key: |
      -----BEGIN PRIVATE KEY-----
      MIIEugIBADANBgkqhkiG9w0BAQEFAASCBKQwggSgAgEAAoIBAQC1zwgrnurQGlwe
      ZcKe2RXLs9XzQo4PzNsbxRQXSZef/siUZ/X3phd7Tt7QbQv8sxoZFR1/R4neN3KV
      tsWJ6YL3CY1IwqzxtR6SHzkg/CgUFgP4Jq9NDodOFRlmkZBK9iO9x/VITxLZPBQt
      f+ygeNhfG/oZZxlLSWNC/adlFfUGI8TujCGGyydxAegyWRYmhkLM7F3vRqMXiUn2
      UP/nPEMasHiHS7r99RzJILbU494aNYTxprfBAoGAdWwO/4I/r3Zo672AvCs2s/P6
      G85cX2hKMFy3B4/Ww53jFA3bsWTOyXBv4srl3v9C3xkQmDwUxPDshEN45JX1AMIc
      vxQkW5cm2IaPHB1BsuQpAuW6qIBT/NZqLmexb4jipAjTN4wQ2dkjI/zK2/SST5wb
      vNufGafZ1IpvkUsDkA0=
      -----END PRIVATE KEY-----

Input TLS

The certificates will be mounted into the /etc/graylog/server, so Inputs (e.g. TCP/UDP) can be configured to leverage those certificates with the following Input API configuration:

Parameter	Value
tls_cert_file:	/etc/graylog/server/server.cert
tls_enable:	true
tls_key_file:	/etc/graylog/server/server.key

Web HTTPS

Graylog can be autoconfigured to run in HTTPS mode when provided certificates by setting the graylog.tls.enabled value to true.

If the certificates are different than those provided above (different hostname for example), then the web-specific certificates can be added to graylog.serverFiles and you can configure the graylog.tls.certPath and graylog.tls.keyPath to match.

Each Graylog node coordinates with each other through the DNS entry exposed via the headless service, so when generating the certificates, be sure to include a SAN entry for *.graylog[-<suffix>].<namespace>.cluster.local (or your configured FQDN).

Get Graylog status

You can get your Graylog status by running the command

kubectl get po -L graylog-role

Output

NAME                        READY     STATUS    RESTARTS   AGE       graylog-ROLE
graylog-0                   1/1       Running     0          1d        master
graylog-1                   1/1       Running     0          1d        coordinating
graylog-2                   1/1       Running     0          1m        coordinating

Troubleshooting

If you are encounter "Unprocessed Messages" or Journal files corrupted, you may need to delete all journal files before staring Graylog. You can do this automatically by setting graylog.journal.deleteBeforeStart to true

The chart will delete all journal files before starting Graylog.

Note: All uncommitted logs will be permanently DELETED when this value is true

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

graylog

graylog

README.md

DEPRECATED - Graylog

Quick Installation

Manually Install Dependencies

Install Chart

Install Chart with specific Graylog cluster size

Install Chart with specific node pool

Using node selector

Using tolerations

Configuration

How it works

Input

TLS

Input TLS

Web HTTPS

Get Graylog status

Troubleshooting

Files

graylog

Directory actions

More options

Directory actions

More options

Latest commit

History

graylog

Folders and files

parent directory

README.md

DEPRECATED - Graylog

Quick Installation

Manually Install Dependencies

Install Chart

Install Chart with specific Graylog cluster size

Install Chart with specific node pool

Using node selector

Using tolerations

Configuration

How it works

Input

TLS

Input TLS

Web HTTPS

Get Graylog status

Troubleshooting