values.yaml

# These are the default values for running Optimizely Agent in Kubernetes.

# Copy this file. Then, install Agent into your K8s cluster using the `-f`ile flag eg
# `helm install  -f <./path-to/your-custom-values.yaml> <agent-deployment-name> optimizely-agent/agent --version <version>`

#################

# Use name overrides to adjust the name of this Chart [optional] and/or...
nameOverride: ""
# overriding the fully qualified name [optional] of the app once deployed
fullnameOverride: ""

image:
  # Use `optimizely/agent` unless you have a specific usecase; Pulls from https://hub.docker.com/r/optimizely/agent 
  repository: optimizely/agent
  # If you wish to use a specific image tag set that here (https://kubernetes.io/docs/concepts/containers/images/#image-names)
  tag: ""
  # Use `IfNotPresent` to get the image if not available locally. Alternatives (https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)
  pullPolicy: IfNotPresent

# Set image pull secrets if you use a private container registry (https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod)
imagePullSecrets: [] # 👈 Remember: remove the empty object `[]` and place collection values indented on the next lines 

serviceAccount:
  # Specifies whether a service account (https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) should be created
  create: true
  # The name of the service account to use. If not set and `create` is true, a name is generated using the fullname template [optional]
  name: ""
  # Annotations (https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to add to the service account [optional]
  annotations: {} # 👈 Remember: remove the empty object `{}` and place sub-properties indented on the next lines 

# Set the number of replica pods to run >= 1. 
# For dynamic load balancing use the autoscaling section below.
replicaCount: 1

# Configure how auto-scaling of pod counts should occur
autoscaling:
  # First, set `enabled` to `true` then...
  enabled: false
  # ...configure the following values to meet your traffic requirements [consumed in the hpa.yaml for HorizontalPodAutoscaler when enabled]
  minReplicas: 1
  maxReplicas: 100
  targetCPUUtilizationPercentage: 80
  targetMemoryUtilizationPercentage: 80

# Constrain pods to be scheduled on a particular node with a given spec (https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) [optional]
nodeSelector: {}

# Set expanded types of constraints for scheduling on nodes (https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity)  [optional]
affinity: {}

# Set pod toleration of given taints on the node (https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) [optional]
tolerations: []
  # - key: "example-key-1"
  #   operator: "Exists"
  #   effect: "NoSchedule"
  # - key: "example-key-2"
  #   operator: "Exists"
  #   effect: "NoSchedule"

# Annotations (https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to add to each pod [optional]
podAnnotations: {}

# Pod-level security context (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) [optional]
podSecurityContext: {}
  # fsGroup: 2000

# Container-level security context (https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container) [optional]
securityContext: {}
  # capabilities:
  #   drop:
  #   - ALL
  # readOnlyRootFilesystem: true
  # runAsNonRoot: true
  # runAsUser: 1000

# Service configuration for exposing pods to network traffic (https://kubernetes.io/docs/concepts/services-networking/service/)
service:
  # `ClusterIP` is default allowing access only from within the cluster. Change the `type` based on your network's
  # requirements (https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)
  type: ClusterIP
  # These are the 3 ports on which the Agent's functinoality is exposed. 
  # Please do not adjust the `targetPort`s. You may adjust the external port as you need. 
  ports:
   - port: 8080
     protocol: TCP
     name: api
     targetPort: 8080
   - port: 8085
     protocol: TCP
     name: webhook
     targetPort: 8085
   - port: 8088
     protocol: TCP
     name: admin
     targetPort: 8088

# Allow for exposing inbound traffic to the cluster (https://kubernetes.io/docs/concepts/services-networking/ingress/)
ingress:
  # Set `enabled` to `true` then ...
  enabled: false
  # .. uncomment the following lines and configure the ingress values below 
  # annotations: {}
  # hosts:
  #   - host: api.optimizely-agent.local
  #     paths:
  #     - port: 8080
  #       path: /
  #       pathType: Prefix
  #   - host: webhook.optimizely-agent.local
  #     paths:
  #     - port: 8085
  #       path: /
  #       pathType: Prefix
  #   - host: admin.optimizely-agent.local
  #     paths:
  #     - port: 8088
  #       path: /
  #       pathType: Prefix
  # Set any TLS configurations in a collection below (https://kubernetes.io/docs/concepts/services-networking/ingress/#tls)
  # tls: []

# Set custom Container (https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#example-1) compute resources [optional]
resources: {} 

# Configure logging level for Optimizely-specific `config` below
logs:
  # Set `level` to panic, fatal, error, warn, info, or debug
  level: debug
  pretty: true
  includeSdkKey: true

# Environmental values for... 
env:
  # The ConfigMap (https://kubernetes.io/docs/concepts/configuration/configmap/) to store non-confidential data in key-value pairs
  # Alternatively or in addition, you can use a `config` section below (https://github.com/optimizely/agent#configuration-options)
  variables: {}
    # OPTIMIZELY_SDKKEYS: sdk_keys
    # OPTIMIZELY_CLIENT_FLUSHINTERVAL: flush_interval
  # ...the Secrets configuration. Be sure to follow the proper encoding for the `data` field (https://kubernetes.io/docs/concepts/configuration/secret/#editing-a-secret)
  secrets: {}
    # OPTIMIZELY_ADMIN_AUTH_HMACSECRETS: hmac_secrets
    # OPTIMIZELY_API_AUTH_HMACSECRETS: hmac_secrets

# Config file contents (https://github.com/optimizely/agent/blob/master/config.yaml) to be consumed by Agent directly as a 
# scalar value after Helm template interpretation 
config: |
  ## config.yaml provides a default set of configuration options

  ## service author included in the /info response
  author: "Optimizely Inc."
  ## name of the running application included in the /info response
  name: "{{ include "optimizely-agent.fullname" . }}"
  ## version of the application included in the /info response and startup logs
  version: {{ .Chart.AppVersion }}

  ## list of SDK keys to be pre-fetched during startup (recommended for production)
  #sdkkeys:
  #    - <sdk-key-1>
  #    - <sdk-key-2>

  ##
  ## log: logger configuration
  ##
  log:
      ## log level used to filter logs of lesser severity (from highest to lowest):
      ## panic, fatal, error, warn, info, debug
      level: {{ .Values.logs.level }}
      ## enable pretty colorized console logging. setting to false will output
      ## structured JSON logs. Recommended false in production.
      pretty: {{ .Values.logs.pretty }}
      ## to set whether or not the SDK key is included in the logging output.
      includeSdkKey: {{ .Values.logs.includeSdkKey }}

  ##
  ## tracing: tracing configuration
  ##
  ## For distributed tracing, trace context should be sent on "traceparent" header
  ## The value set in HTTP Header must be a hex compliant with the W3C trace-context specification.
  ## See more at https://www.w3.org/TR/trace-context/#trace-id
  tracing:
      ## bydefault tracing is disabled
      ## to enable tracing set enabled to true
      enabled: false
      # opentelemetry tracing configuration
      opentelemetry:
          ## bydefault stdout exporter is enabled
          ## to enable remote exporter set default as "remote"
          default: "stdout"
          ## tracing service name
          serviceName: "optimizely-agent"
          ## tracing environment name
          ## example: for production environment env can be set as "prod"
          env: "dev"
          ## tracing service configuration
          services:
              ## stdout exporter configuration
              stdout:
                  ## for stdout tracing data is saved in the specified file
                  filename: "trace.out"
              ## remote exporter configuration
              remote:
                  ## remote collector endpoint
                  endpoint: "localhost:4317"
                  ## supported protocols are "http" and "grpc"
                  protocol: "grpc"
                  ## "sampleRate" refers to the rate at which traces are collected and recorded.
                  ## sampleRate >= 1 will always sample.
                  ## sampleRate < 0 are treated as zero i.e. never sample.
                  sampleRate: 1.0

  ##
  ## http server configuration
  ##
  server:
      ## List of allowed request host values.
      ## Requests whose host value does not match either the configured server.host, or one of these, will be rejected
      ## with a 404 response.
      ## To match all subdomains, you can use a leading dot (for example .example.com matches my.example.com, hello.world.example.com, etc.).
      ## You can use the value "." to disable allowed host checking, allowing requests with any host.
      ## Request host is determined in the following priority order:
      ## 1. X-Forwarded-Host header value
      ## 2. Forwarded header host= directive value
      ## 3. Host property of request (see Host under https://golang.org/pkg/net/http/#Request)
      ## Note: don't include port in these hosts values - port is stripped from the request host before comparing against these.
      allowedHosts:
          - "."
      ## the maximum duration for reading the entire request, including the body.
      ## Value can be set in seconds (e.g. "5s") or milliseconds (e.g. "5000ms")
      readTimeout: 5s
      ## the maximum duration before timing out writes of the response.
      ## Value can be set in seconds (e.g. "5s") or milliseconds (e.g. "5000ms")
      writeTimeout: 10s
      ## path for the health status api
      healthCheckPath: "/health"
      ## the location of the TLS key file
  #    keyFile: <key-file>
      ## the location of the TLS certificate file
  #    certFile: <cert-file>
      ## IP of the host
      host: "0.0.0.0"
      ## configure optional Agent interceptors
  #    interceptors:
  #        httplog: {}

  ##
  ## api service configuration
  ##
  api:
      ## the maximum number of concurrent requests handled by the api listener
  #    maxConns: 10000
      ## http listener port
      {{ with index .Values.service.ports 0 }}
      port: {{ .targetPort | quote }}
      {{ end }}
      ## set to true to enable subscribing to notifications via an SSE event-stream
      enableNotifications: false
      ## set to true to be able to override experiment bucketing. (recommended false in production)
      enableOverrides: true
      ## CORS support is provided via chi middleware
      ## https://github.com/go-chi/cors
  #    cors:
  #      ## If allowedOrigins is nil or empty, value is set to ["*"].
  #      allowedOrigins: ["*"]
  #      ## If allowedMethods is nil or empty, value is set to (HEAD, GET and POST).
  #      allowedMethods:
  #      - "HEAD"
  #      - "GET"
  #      - "POST"
  #      - "OPTIONS"
  #      ## Default value is [] but "Origin" is always appended to the list.
  #      allowedHeaders: ["*"]
  #      exposedHeaders: []
  #      allowedCredentials: false
  #      maxAge: 300

  ##
  ## admin service configuration
  ##
  admin:
      ## http listener port
      {{ with index .Values.service.ports 2 }}
      port: {{ .targetPort | quote }}
      {{ end }}
  ##
  ## webhook service receives update notifications to your Optimizely project. Receipt of the webhook will
  ## trigger an immediate download of the datafile from the CDN
  ##
  webhook:
      ## http listener port
      {{ with index .Values.service.ports 1 }}
      port: {{ .targetPort | quote }}
      {{ end }}
  #    ## a map of Optimizely Projects to one or more SDK keys
  #    projects:
  #        ## <project-id>: Optimizely project id as an integer
  #        <project-id>:
  #            ## sdkKeys: a list of SDKs linked to this project
  #            sdkKeys:
  #                - <sdk-key-1>
  #                - <sdk-key-1>
  #            ## secret: webhook secret used the validate the notification
  #            secret: <secret-10000>
  #            ## skipSignatureCheck: override the signature check (not recommended for production)
  #            skipSignatureCheck: true

  ##
  ## optimizely client configurations (options passed to the underlying go-sdk)
  ##
  client:
      ## the time between successive polls for updated project configuration
      pollingInterval: 1m
      ## the number of events in a batch
      batchSize: 10
      ## the max number of events pending dispatch, setting this too low may result in events being dropped
      queueSize: 1000
      ## the maximum time between events being dispatched
      flushInterval: 30s
      ## Template URL for SDK datafile location. The template should specify a "%s" token for SDK key substitution.
      datafileURLTemplate: "https://cdn.optimizely.com/datafiles/%s.json"
      ## URL for dispatching events.
      eventURL: "https://logx.optimizely.com/v1/events"
      ## Validation Regex on the request SDK Key
      ## By default Agent assumes only alphanumeric characters as part of the SDK Key string.
      ## https://github.com/google/re2/wiki/Syntax
      sdkKeyRegex: "^\\w+(:\\w+)?$"
      ## configure optional User profile service
      userProfileService:
        default: ""
        services:
          # in-memory: 
          #   capacity: 0
          #   storageStrategy: "fifo"
          # redis: 
          #   host: "localhost:6379"
          #   password: ""
          #   database: 0
          # rest:
          #   async: false 
          #   host: "http://localhost"
          #   lookupPath: "/ups/lookup"
          #   lookupMethod: "POST"
          #   savePath: "/ups/save"
          #   saveMethod: "POST"
          #   userIDKey: "user_id"
          #   headers: 
          #     Content-Type: "application/json"
          #     Auth-Token: "12345"

  ##
  ## optimizely runtime configuration can be used for debugging and profiling the go runtime.
  ## These should only be configured when debugging in a non-production environment.
  ##
  runtime:
      ## SetBlockProfileRate controls the fraction of goroutine blocking events
      ## that are reported in the blocking profile. The profiler aims to sample
      ## an average of one blocking event per rate nanoseconds spent blocked.
      ##
      ## To include every blocking event in the profile, pass rate = 1.
      ## To turn off profiling entirely, pass rate <= 0.
      blockProfileRate: 0

      ## mutexProfileFraction controls the fraction of mutex contention events
      ## that are reported in the mutex profile. On average 1/rate events are
      ## reported. The previous rate is returned.
      ##
      ## To turn off profiling entirely, pass rate 0.
      ## To just read the current rate, pass rate < 0.
      ## (For n>1 the details of sampling may change.)
      mutexProfileFraction: 0
  ## synchronization should be enabled when features for multiple nodes like notification streaming are deployed
  synchronization:
      pubsub:
          redis:
              host: "redis.demo.svc:6379"
              password: ""
              database: 0
      ## if notification synchronization is enabled, then the active notification event-stream API
      ## will get the notifications from available replicas
      notification:
          enable: false
          default: "redis"
      ## if datafile synchronization is enabled, then for each webhook API call
      ## the datafile will be sent to all available replicas to achieve better eventual consistency
      datafile:
          enable: false
          default: "redis"