Back to Charts

⚠️ Repo Archive Notice

stable/signalsciences/README.md

latest6.0 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.

SignalSciences

SignalSciences is a hosted web application firewall.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

Introduction

This chart adds the SignalSciences agent to all nodes in your cluster via a DaemonSet. This chart exposes a shared unix socket file on every node for your application code to connect to the agent with.

Prerequisites

Kubernetes 1.4+.

Installing the Chart

To install the chart with the release name my-release, retrieve your SignalSciences accessKeyId and secretAccessKey from your Agent Installation Instructions and run:

bash
$ helm install --name my-release \
    --set signalsciences.accessKeyId=YOUR-ACCESS-KEY-ID \
    --set signalsciences.secretAccessKey=YOUR-SECRET-ACCESS-KEY \
    stable/signalsciences

After a few minutes, you should see the agent in your SignalSciences dashboard.

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 SignalSciences chart and their default values.

ParameterDescriptionDefault
signalsciences.accessKeyIdYour SignalSciences accessKeyIdNil You must provide your own accessKeyId
signalsciences.accessKeyIdExistingSecretIf set, use the secret with a provided name instead of creating a new onenil
signalsciences.secretAccessKeyYour SignalSciences secretAccessKeyNil You must provide your own secretAccessKey
signalsciences.secretAccessKeyExistingSecretIf set, use the secret with a provided name instead of creating a new onenil
image.repositoryThe image repository to pull fromsignalsciences/sigsci-agent
image.tagThe image tag to pull4.6.0
image.pullPolicyImage pull policyIfNotPresent
signalsciences.agentTempVolumeTemporary volume to mount the socket and a writeable dir/sigsci/tmp
signalsciences.resources.requests.cpuCPU resource requests200m
signalsciences.resources.limits.cpuCPU resource limits200m
signalsciences.resources.requests.memoryMemory resource requests256Mi
signalsciences.resources.limits.memoryMemory resource limits256Mi
signalsciences.socketAddressIf set, allows you to change the default socket locationnil
daemonset.podAnnotationsAnnotations to add to the DaemonSet's Podsnil
daemonset.tolerationsList of node taints to tolerate (requires Kubernetes >= 1.6)nil
daemonset.nodeSelectorNode selectorsnil
daemonset.affinityNode affinitiesnil
daemonset.updateStrategyNode affinitiesnil
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
bash
$ helm install --name my-release \
    --set signalsciences.accessKeyId=YOUR-ACCESS-KEY-ID,signalsciences.secretAccessKey=YOUR-SECRET-ACCESS-KEY \
    stable/signalsciences

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 my-values.yaml stable/signalsciences

Tip: You can copy and customize the default values.yaml

Secret

By default, this Chart creates two Secrets and puts the accessKeyId and secretAccessKey in those Secrets. However, you can use manually created secret by setting the sginalsciences.accessKeyIdExistingSecret and signalsciences.secretAccessKeyExistingSecret values.