Back to Charts

⚠️ Repo Archive Notice

stable/sumokube/README.md

latest4.6 KB
Original Source

⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

SumoKube

Sumo Logic is a hosted logging platform.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

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:

bash
$ 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:

bash
$ helm delete my-release

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

Configuration

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

ParameterDescriptionDefault
sumologic.accessIdYour Sumo Logic access ID keyNil You must provide your own id
sumologic.accessKeyYour Sumo Logic access keyNil You must provide your own key
sumologic.collectorNameSumo Logic collector namekubernetes-collector
sumologic.categoryNameSource category namekubernetes
sumologic.multilineProcessingEnabledEnable if working with multi-line messagesfalse
sumologic.automaticDateParsingDetermines if timestamp information is parsed or nottrue
sumologic.forceTimeZoneForce the Source to use a specific time zonefalse
sumologic.pathExpressionPath to your container logs/var/log/containers/*.log
image.nameThe image repository and name to pull fromsumologic/collector
image.tagThe image tag to pulllatest
imagePullPolicyImage pull policyIfNotPresent
resources.requests.cpuCPU resource requests100m
resources.limits.cpuCPU resource limits256m
resources.requests.memoryMemory resource requests128Mi
resources.limits.memoryMemory resource limits256Mi
daemonset.tolerationsList of node taints to tolerate (requires Kubernetes >= 1.6)[]
daemonset.updateStrategyStrategy for applying template changes (requires Kubernetes >= 1.6)[]

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

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

Example of adding daemonset tolerations to run on master nodes. Requires Helm >=2.5

bash
$ helm install --name my-release \
    --set sumologic.accessId=YOUR-ID-HERE,sumologic.accessKey=YOUR-KEY-HERE,sumologic.categoryName=my-source-category-name,daemonset.tolerations[0].effect=NoSchedule,daemonset.tolerations[0].key=node-role.kubernetes.io/master \
    stable/sumokube

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

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

Tip: You can use the default values.yaml