Kubernetes - Superblocks Docs

The Superblocks data plane can be deployed on any Kubernetes cluster with the Superblocks Helm chart. If your organization doesn’t use Helm to manage Kubernetes resources, you can still install the Helm CLI and use it to generate the manifest templates to deploy directly.

Installation

Add the chart repository

helm repo add superblocks https://charts.superblocks.com/superblocks
helm repo update

Configure values file

Create a local values.yaml file with the default chart values. You can export the defaults by running helm show values superblocks/superblocks-agent > values.yaml. Aside from the default settings, the following settings are required to enable Ingress and allow communication from your users to the agent running in the cluster.

superblocks:
  agentHostUrl: "https://SUBDOMAIN.DOMAIN.TLD"

  agentRedisPassword: "my-redis-password"
  # Existing agentRedisPassword secret must contain the value:
  # SUPERBLOCKS_AGENT_REDIS_PASSWORD: <my-redis-password>
  # agentRedisPasswordExistingSecret: "my-redis-password-secret", optional. Secret is created for you if not specified.

#(...)
service:
  # Use ClusterIP if your ingress controller routes traffic directly to pods.
  # Otherwise, update the service type based on your ingress controller settings.
  # For example, defaults for native cloud controllers require NodePort.
  type: ClusterIP
  ports:
    grpc: 8081
    http: 8080
    metrics: 9090

ingress:
  enabled: true
  class: "" # nginx
  annotations: {}
    # kubernetes.io/tls-acme: "true"
  
  hosts:
    - host: SUBDOMAIN.DOMAIN.TLD
      paths:
        - path: /
          pathType: Prefix
  tls: []
  # - secretName: chart-example-tls
  #   hosts:
  #     - SUBDOMAIN.DOMAIN.TLD

The values for superblocks.agentHostUrl and ingress.hosts[0].host should be the same DNS entry (CNAME or A record) that points to the ingress-managed load balancer in front of the agent.

Deploy the chart

After making changes to values.yaml, save and deploy the chart. Adjust superblocks.agentTags as needed depending on your environment.

helm upgrade -i -n superblocks superblocks-agent superblocks/superblocks-agent \
  --create-namespace \
  -f values.yaml \
  --set superblocks.agentKey='<AGENT_KEY>' \
  --set superblocks.agentTags='profile:*' \
  --set superblocks.agentDataDomain="app.superblocks.com"

Billable services

When running the data plane on Kubernetes, it is important to be aware of your container management provider’s pricing (i.e. EKS, GKE, AKS) and the cost of any associated infrastructure like networking, load balancers, and DNS.

⌘I