Skip to content

README.md

Latest commit

 

History

History
182 lines (134 loc) · 7.35 KB

README.md

File metadata and controls

182 lines (134 loc) · 7.35 KB

HyperFleet Adapter Helm Chart

HyperFleet Adapter - Event-driven adapter for HyperFleet cluster provisioning. Consumes CloudEvents from message brokers (GCP Pub/Sub, RabbitMQ), processes AdapterConfig, manages Kubernetes resources, and reports status via API.

Prerequisites

  • Kubernetes 1.19+
  • Helm 3.0+
  • GCP Workload Identity (for Pub/Sub access)

Installing the Chart

helm install hyperfleet-adapter ./charts/ -f ./charts/examples/values.yaml

Uninstalling the Chart

helm delete hyperfleet-adapter

Configuration

Key Parameters

Parameter Description Default
replicaCount Number of replicas 1
image.registry Image registry quay.io/openshift-hyperfleet
image.repository Image repository hyperfleet-adapter
image.tag Image tag latest
image.pullPolicy Image pull policy Always
command Container command ["/app/adapter"]
args Container arguments ["serve"]

ServiceAccount & Workload Identity

If the adapter requires creating kubernetes objects in the cluster, it needs to create a serviceAccount with proper rbac permissions

Parameter Description Default
serviceAccount.create Create ServiceAccount true
serviceAccount.name ServiceAccount name (auto-generated if empty) ""
rbac.resources Helper property to give CRUD permission for resources (pods, jobs...) ""
rbac.rules Fine grained permissions for the service account ""

Adapter + Task Configuration

An adapter instance now loads two configs:

  • AdapterConfig (deployment/client config) via adapterConfig.*
  • AdapterTaskConfig (business logic) via adapterTaskConfig.*

Each config can be sourced from an existing ConfigMap (configMapName) or created by the Helm chart from inline yaml or files.

Beware of template resolution within files referenced in an AdapterTaskConfig. These files are not processed by Helm, but you can use go templates to resolve dynamic values (e.g. property: "{{ .paramFromAdapterConfig }}").

Parameter Description Default
adapterConfig.create Enable AdapterConfig ConfigMap true
adapterConfig.configMapName AdapterConfig ConfigMap name ""
adapterConfig.yaml AdapterConfig YAML content ""
adapterConfig.files AdapterConfig YAML files packaged with chart {}
adapterConfig.hyperfleetApi.baseUrl HyperFleet API base URL (HYPERFLEET_API_BASE_URL) "http://hyperfleet-api:8000"
adapterConfig.hyperfleetApi.version API version (HYPERFLEET_API_VERSION) "v1"
adapterConfig.log.level Adapter log level "info"
adapterTaskConfig.create Enable AdapterTaskConfig ConfigMap true
adapterTaskConfig.configMapName AdapterTaskConfig ConfigMap name ""
adapterTaskConfig.yaml AdapterTaskConfig YAML content ""
adapterTaskConfig.files AdapterTaskConfig YAML files packaged with chart {}

AdapterConfig supports debug_config to log the full merged configuration after load (default: false). It can also be set via HYPERFLEET_DEBUG_CONFIG or --debug-config.

Broker Configuration

An adapter uses the hyperfleet-broker library to interact with a message broker, so the code in the adapter framework is broker agnostic. This ConfigMap can be:

  1. An existing ConfigMap referenced by the broker.configMapName property
  2. An embedded YAML file using broker.yaml
  3. Created out of individual properties that are broker specific (e.g. googlepubsub, rabbitmq)

The ConfigMap will be:

  • Mounted at /etc/broker/broker.yaml
  • The library needs the environment variable BROKER_CONFIG_FILE=/etc/broker/broker.yaml
Parameter Description Default
broker.create Create broker ConfigMap true
broker.configMapName Broker ConfigMap name ""
broker.googlepubsub.projectId Google Cloud project ID ""
broker.googlepubsub.subscriptionId Subscription ID override (HYPERFLEET_BROKER_SUBSCRIPTION_ID) ""
broker.googlepubsub.topic Topic name override (HYPERFLEET_BROKER_TOPIC) ""
broker.yaml Broker YAML config content ""

When broker.yaml is set:

  • Creates broker.yaml key in ConfigMap
  • Mounts at /etc/broker/broker.yaml
  • Sets BROKER_CONFIG_FILE=/etc/broker/broker.yaml

Resources

Parameter Description Default
resources.limits.cpu CPU limit 500m
resources.limits.memory Memory limit 512Mi
resources.requests.cpu CPU request 100m
resources.requests.memory Memory request 128Mi

Pod Configuration

Parameter Description Default
podAnnotations Pod annotations {}
podLabels Additional pod labels {}
nodeSelector Node selector {}
tolerations Tolerations []
affinity Affinity rules {}
terminationGracePeriodSeconds Termination grace period 30

Health Probes (Enabled by Default)

The adapter is a message consumer but exposes some HTTP endpoints by default.

Parameter Description Default
livenessProbe.enabled Enable liveness probe true
readinessProbe.enabled Enable readiness probe true
startupProbe.enabled Enable startup probe false

Pod Disruption Budget

Parameter Description Default
podDisruptionBudget.enabled Enable PDB false
podDisruptionBudget.minAvailable Minimum available pods -
podDisruptionBudget.maxUnavailable Maximum unavailable pods -

Examples

Basic Installation

helm install hyperfleet-adapter ./charts/ \
  -f ./charts/examples/values.yaml \
  --set image.registry=quay.io/my-quay-registry \
  --set broker.create=true \
  --set broker.googlepubsub.projectId=my-gcp-project \
  --set broker.googlepubsub.subscriptionId=my-subscription \
  --set broker.googlepubsub.topic=my-topic

Environment Variables

The deployment sets these environment variables automatically:

Variable Value Condition
HYPERFLEET_API_BASE_URL From adapterConfig.hyperfleetApi.baseUrl When adapterConfig.hyperfleetApi.baseUrl is set
HYPERFLEET_API_VERSION From adapterConfig.hyperfleetApi.version Always (default: v1)
BROKER_CONFIG_FILE /etc/broker/broker.yaml When broker.yaml is set
HYPERFLEET_BROKER_SUBSCRIPTION_ID From values When broker.googlepubsub.subscriptionId is set
HYPERFLEET_BROKER_TOPIC From values When broker.googlepubsub.topic is set

GCP Workload Identity Setup

To use GCP Pub/Sub with Workload Identity, a principal to a Kubernetes service account in the namespace is allowed the required roles (e.g. pubsub)

# 1. Create Google Service Account
gcloud iam service-accounts create hyperfleet-adapter \
  --project=MY_PROJECT

# 2. Grant Pub/Sub permissions
gcloud projects add-iam-policy-binding MY_PROJECT \
  --member="principal://iam.googleapis.com/projects/275239757837/locations/global/workloadIdentityPools/hcm-hyperfleet.svc.id.goog/subject/ns/amarin/sa/landing-zone" \
  --role="roles/pubsub.subscriber"