Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 3.73 KB

README.md

File metadata and controls

65 lines (50 loc) · 3.73 KB

Mezmo Edge

Helm chart for managing a Mezmo Edge deployment

Prerequisites

  • Kubernetes 1.10+ (1.23+ if using autoscaling)
  • Mezmo Account with Edge Pipeline support
  • Mezmo API Token

Quickstart

helm install edge mezmo/edge \
  --set mezmoApiAccessToken=<MEZMO_API_ACCESS_TOKEN>

By default ports in the range [8000, 8010] are configured. See service.sourcePorts.* values for configuring different ranges.

Specifying a different port range

You may specify a different port range if desired. For example, to configure with no contiguous range and two ports (syslog and http) exposed:

helm install edge mezmo/edge \
  --set mezmoApiAccessToken=<MEZMO_API_ACCESS_TOKEN> \
  --set service.sourcePorts.end=0 \
  --set service.sourcePorts.list="{514,80}"

Or choose a custom range:

helm install edge mezmo/edge \
  --set mezmoApiAccessToken=<MEZMO_API_ACCESS_TOKEN> \
  --set service.sourcePorts.start=20000 \
  --set service.sourcePorts.end=20020

Configuration

Values

Key Type Default Description
mezmoApiAccessToken string Your Mezmo API access token. This has a lower precedence than mezmoApiAccessSecret
mezmoApiAccessSecret string Existing secret containing your Mezmo API access token. Given secret should have the token in a key named api-access-token and be in the same namespace as the Edge instance. This takes precedence over mezmoApiAccessToken
mezmoDeploymentGroup string Deployment group to apply to this Edge instance. Leaving undefined pulls all Edge pipelines for the org
mezmoApiScheme string "https" The scheme to use for the Mezmo API URL
mezmoApiHost string "api.mezmo.com" The hostname(:port) of the Mezmo API
namespace string Optional namespace for compartmentalization
logLevel string info Controls the logging verbosity of the deployment
autoscaling.enabled boolean false Whether or not to enable a HorizontalPodAutoscaler for this deployment
service.sourcePorts.start int 8000 The start of the port range (inclusive [start, end])
service.sourcePorts.end int 8010 The end of the port range (set 0 or "" to disable port range)
service.sourcePorts.list array[] [] Optional list of discrete ports to configure on the service
enableK8sLogs boolean false Whether or not to add ClusterRole and Volume access required for k8s logs source
pvcName string "" Optional name for an existing PersistentVolumeClaim to use for disk buffering, aggregate persistence and k8s log checkpoints. Leaving undefined will default to ephemeral storage lasting the lifetime of the pod
maxDiskBufferBytes int 268435488 (256MiB) Optional max number of bytes to store in a disk-backed buffer.
maxMemBufferEvents int 1000 Optional max number of events to store in a memory buffer.
reduceByteThresholdPerState int 104857600 (100MiB) Optional max number of bytes to store in a memory for any given reduce component.
reduceByteThresholdAllStates int 1073741824 (1GiB) Optional max number of bytes to store in a memory for all given reduce components.

* Port 8686 is reserved for internal use, and should not be additionally configured for sourcePorts