/sumokube

Sumo Logic daemon set for Kubernetes

#SumoKube sumokube

Sumo Logic is a hosted logging platform.

Introduction

This chart adds the Sumo Logic Collector to all nodes in your cluster via a DaemonSet.

Prerequisites

  • Kubernetes 1.2+ with Beta APIs enabled

Installing the Chart

To install the chart with the release name my-release, retrieve your Sumo Logic Access ID and key from using the instructions found at Sumo Logic Access Keys and run:

$ helm install --name my-release \
    --set sumologic.accessId=YOUR-ID-HERE,sumologic.accessKey=YOUR-KEY-HERE stable/sumokube

After a few minutes, you should see logs available in Sumo Logic.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following tables lists the configurable parameters of the Sumokube chart and their default values.

Parameter Description Default
sumologic.accessId Your Sumo Logic access ID key Nil You must provide your own id
sumologic.accessKey Your Sumo Logic access key Nil You must provide your own key
sumologic.collectorName Sumo Logic collector name kubernetes-collector
sumologic.categoryName Source category name kubernetes
sumologic.multilineProcessingEnabled Enable if working with multi-line messages false
sumologic.automaticDateParsing Determines if timestamp information is parsed or not true
sumologic.forceTimeZone Force the Source to use a specific time zone false
sumologic.pathExpression Path to your container logs /var/log/containers/*.log
image.name The image repository and name to pull from sumologic/collector
image.tag The image tag to pull latest
imagePullPolicy Image pull policy IfNotPresent
resources.requests.cpu CPU resource requests 100m
resources.limits.cpu CPU resource limits 256m
resources.requests.memory Memory resource requests 128Mi
resources.limits.memory Memory resource limits 256Mi

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
    --set sumologic.accessId=YOUR-ID-HERE,sumologic.accessKey=YOUR-KEY-HERE,sumologic.categoryName=my-source-category-name \
    stable/sumokube

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml stable/sumokube

Tip: You can use the default values.yaml