Helm Chart Reference
The Hookbase Operator is distributed as a Helm chart in the operator repository. The chart is not published to a Helm repository, so you install it from a clone of the repository.
Installation
Clone the repository at a release tag:
git clone --branch v0.4.1 https://github.com/HookbaseApp/hookbase-operator.git
cd hookbase-operatorCreate the bootstrap API key Secret, then install the chart from the local ./chart directory:
kubectl create namespace hookbase-system
kubectl create secret generic hookbase-bootstrap-key \
--namespace hookbase-system \
--from-literal=apiKey=whr_your_api_key_here
helm install hookbase-operator ./chart \
--namespace hookbase-system \
--set hookbase.apiKeySecretRef.name=hookbase-bootstrap-key \
--set hookbase.apiKeySecretRef.key=apiKeyRelease v0.4.1 contains chart version 0.3.1, which runs the operator image ghcr.io/hookbaseapp/hookbase-operator:0.4.1 (the chart's appVersion). Image tags have no v prefix.
Values Reference
Hookbase Configuration
| Value | Default | Description |
|---|---|---|
hookbase.apiKey | "" | Bootstrap API key in plain text, set directly in the Deployment's environment. Takes precedence over apiKeySecretRef if both are set. Prefer apiKeySecretRef |
hookbase.apiKeySecretRef.name | "" | Existing Secret in the release namespace that holds the bootstrap API key |
hookbase.apiKeySecretRef.key | "apiKey" | Key within the Secret |
hookbase.baseURL | "https://api.hookbase.app" | Hookbase API base URL. The tunnel agent's WebSocket URL is derived from it |
Operator Settings
| Value | Default | Description |
|---|---|---|
image.repository | "ghcr.io/hookbaseapp/hookbase-operator" | Operator image repository |
image.tag | "" | Image tag (defaults to the chart's appVersion, 0.4.1 in chart 0.3.1) |
image.pullPolicy | "IfNotPresent" | Image pull policy |
imagePullSecrets | [] | Image pull secrets for the operator pod |
nameOverride | "" | Override the chart name used in resource names |
fullnameOverride | "" | Override the full name used for the chart's resources |
replicaCount | 1 | Number of operator replicas. Set controller.leaderElect: true if you run more than one |
agent.image | "ghcr.io/hookbaseapp/hookbase-agent:latest" | Default tunnel agent sidecar image. A WebhookTunnel can override it with sidecarInjection.agentImage |
controller.reconcileInterval | "5m" | Drift detection reconciliation interval |
controller.leaderElect | false | Enable leader election (required for more than one replica) |
watchNamespaces | [] | Not used by chart 0.3.1. The operator watches all namespaces regardless of this value |
Resources
| Value | Default | Description |
|---|---|---|
resources.requests.cpu | "100m" | CPU request |
resources.requests.memory | "128Mi" | Memory request |
resources.limits.cpu | "200m" | CPU limit |
resources.limits.memory | "256Mi" | Memory limit |
Admission Webhooks
| Value | Default | Description |
|---|---|---|
webhook.enabled | false | Start the operator's webhook server on port 9443 and create a -webhook Service. Read the warning below first |
webhook.certManager.enabled | false | Not used by chart 0.3.1 |
webhook.certManager.issuerRef.name | "" | Not used by chart 0.3.1 |
webhook.certManager.issuerRef.kind | "ClusterIssuer" | Not used by chart 0.3.1 |
Warning
Leave webhook.enabled at false with chart 0.3.1. The chart does not create a serving certificate or a ValidatingWebhookConfiguration. With webhook.enabled: true, the operator pod mounts a TLS Secret named <fullname>-webhook-cert (hookbase-operator-webhook-cert for a release named hookbase-operator) and does not start until that Secret exists, and the API server still never calls the webhooks.
Prometheus Metrics
| Value | Default | Description |
|---|---|---|
metrics.enabled | true | Create a Service for the metrics port (8080). The operator serves /metrics on that port either way |
metrics.serviceMonitor.enabled | false | Create a ServiceMonitor for Prometheus Operator (also needs metrics.enabled) |
metrics.serviceMonitor.namespace | "" | ServiceMonitor namespace (defaults to release namespace) |
metrics.serviceMonitor.interval | "30s" | Scrape interval |
metrics.serviceMonitor.labels | {} | Additional labels for ServiceMonitor |
Security Context
| Value | Default | Description |
|---|---|---|
podSecurityContext.runAsNonRoot | true | Run the pod as non-root (the images run as UID 65532) |
podSecurityContext.seccompProfile.type | "RuntimeDefault" | Pod seccomp profile |
securityContext.allowPrivilegeEscalation | false | Container privilege escalation |
securityContext.readOnlyRootFilesystem | true | Read-only root filesystem for the container |
securityContext.capabilities.drop | ["ALL"] | Linux capabilities dropped from the container |
Pod Scheduling
| Value | Default | Description |
|---|---|---|
nodeSelector | {} | Node selector |
tolerations | [] | Tolerations |
affinity | {} | Affinity rules |
Service Account
| Value | Default | Description |
|---|---|---|
serviceAccount.create | true | Create a service account |
serviceAccount.name | "" | Service account name (generated if empty) |
serviceAccount.annotations | {} | Service account annotations |
Example Configurations
Minimal
hookbase:
apiKey: "whr_your_api_key_here"Production
hookbase:
apiKeySecretRef:
name: hookbase-bootstrap-key
key: apiKey
baseURL: "https://api.hookbase.app"
replicaCount: 2
controller:
leaderElect: true
reconcileInterval: "5m"
resources:
requests:
cpu: 100m
memory: 256Mi
limits:
cpu: "1"
memory: 512Mi
metrics:
serviceMonitor:
enabled: true
interval: "30s"
affinity:
podAntiAffinity:
preferredDuringSchedulingIgnoredDuringExecution:
- weight: 100
podAffinityTerm:
labelSelector:
matchExpressions:
- key: app.kubernetes.io/name
operator: In
values:
- hookbase-operator
topologyKey: kubernetes.io/hostnameCRD Management
The CRDs are in the chart's templates/crds/ directory. They are ordinary chart templates, not Helm's special crds/ directory, so Helm manages them like any other resource in the release:
helm installcreates them.--skip-crdshas no effect on them.helm upgradeupdates them along with the operator.helm uninstalldeletes them, and deleting a CRD deletes every custom resource of that kind in the cluster. See Uninstalling before you run it.- They belong to one release. A second release of the chart in the same cluster fails to install because the CRDs already exist.
Upgrading
In your clone, check out the release you want, then run helm upgrade from the local chart:
cd hookbase-operator
git fetch --tags
git checkout v0.4.1 # the release to upgrade to
helm upgrade hookbase-operator ./chart \
--namespace hookbase-system \
--set hookbase.apiKeySecretRef.name=hookbase-bootstrap-key \
--set hookbase.apiKeySecretRef.key=apiKeyPass the same --set flags or values file you installed with: helm upgrade does not keep earlier values unless you add --reuse-values. The upgrade also applies the new release's CRDs, so there is no separate CRD step.
Uninstalling
Delete your Hookbase custom resources first, while the operator is still running. Each one carries the hookbase.io/finalizer finalizer, and the operator deletes the matching resource from Hookbase before it removes the finalizer. Delete HookbaseAPIKey resources last, because the other resources may need those keys to clean up:
kubectl delete webhookroutes,webhooksources,webhookdestinations,webhooktunnels,webhooktransforms,webhookfilters,webhookschemas,hookbasecronjobs --all -A
kubectl delete hookbaseapikeys --all -AThen uninstall the chart. This also deletes the CRDs:
helm uninstall hookbase-operator --namespace hookbase-systemWarning
Uninstall the chart only after the custom resources are gone. If you uninstall first, the operator is removed before it can process the deletions. The custom resources stay stuck on their finalizer, the CRDs stay in Terminating, and the matching sources, destinations and routes stay in your Hookbase account.
RBAC
The chart creates a ClusterRole with fine-grained permissions for all 10 CRD types, Secrets (for API key resolution), Deployments (for sidecar injection), and Ingress resources.
See Also
- Kubernetes Operator Guide -- getting started
- CRD Reference -- all CRD specifications