Fork me on GitHub

Teleport

teleport-plugin-event-handler Chart Reference

Improve

The teleport-plugin-event-handler Helm chart is used to configure the Event Handler Teleport plugin which allows users to send events and session logs to a Fluentd instance for further processing or storage.

You can browse the source on GitHub.

This reference details available values for the teleport-plugin-event-handler chart.

Warning

Backing up production instances, environments, and/or settings before making permanent modifications is encouraged as a best practice. Doing so allows you to roll back to an existing state if needed.

teleport.address

TypeDefault valueRequired?
string""Yes

This parameter contains the host/port combination of the Teleport Auth Service.

teleport:
  address: "teleport.example.com:3025"
--set teleport.address="teleport.example.com:3025"

teleport.identitySecretName

TypeDefault valueRequired?
string""Yes

Name of the Kubernetes secret that contains the credentials for the connection.

The secret should be in the following format:

apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: teleport-plugin-event-handler-identity
data:
  auth_id: ...

Check out the Event Handler Helm Chart documentation for more information about how to acquire these credentials.

teleport:
  identitySecretName: "teleport-plugin-event-handler-identity"
--set teleport.identitySecretName="teleport-plugin-event-handler-identity"

teleport.identitySecretPath

TypeDefault valueRequired?
string"auth_id"No

Name of the key in the Kubernetes secret that holds the credentials for the connection. If the secret follows the format above, it can be omitted.

teleport:
  identitySecretPath: "auth_id"
--set teleport.identitySecretPath="auth_id"

fluentd.url

TypeDefault valueRequired?
string""Yes

Fluentd URL where the events will be sent.

fluentd:
  url: "https://fluentd:24224/events.log"
--set fluentd.url="https://fluentd:24224/events.log"

fluentd.sessionUrl

TypeDefault valueRequired?
string""Yes

Fluentd URL where the session logs will be sent.

fluentd:
  sessionUrl: "https://fluentd:24224/session.log"
--set fluentd.sessionUrl="https://fluentd:24224/session.log"

fluentd.certificate.secretName

TypeDefault valueRequired?
string""Yes

Secret containing the credentials to connect to Fluentd. It must to contain the CA certificate, the client key and the client certificate.

fluentd:
  secretName: "teleport-plugin-event-handler-fluentd"
--set fluentd.secretName="teleport-plugin-event-handler-fluentd"

fluentd.certificate.caPath

TypeDefault valueRequired?
string"ca.crt"No

Name of the key which contains the CA certificate inside the secret.

fluentd:
  caPath: "ca.crt"
--set fluentd.caPath="ca.crt"

fluentd.certificate.keyPath

TypeDefault valueRequired?
string"client.key"No

Name of the key which contains the client's private key inside the secret.

fluentd:
  keyPath: "client.key"
--set fluentd.keyPath="client.key"

fluentd.certificate.certPath

TypeDefault valueRequired?
string"client.crt"No

Name of the key which contains the client's certificate inside the secret.

fluentd:
  certPath: "client.crt"
--set fluentd.certPath="client.crt"

log.output

TypeDefault valueRequired?
stringstdoutNo

Logger output. Can be stdout, stderr or a file name, eg. /var/log/teleport/fluentd.log.

log:
  output: /var/log/teleport/fluentd.log
--set log.output="/var/log/teleport/fluentd.log"

log.severity

TypeDefault valueRequired?
stringstdoutNo

Logger severity. Possible values are INFO, ERROR, DEBUG or WARN.

log:
  severity: DEBUG
--set log.severity="DEBUG"