Skip to content

Deploying Inference Services

AIMService is the primary resource for deploying inference endpoints. It combines a model image, optional runtime configuration, and HTTP routing to produce a production-ready inference service.

Quick Start

The minimal service requires just an AIM container image:

apiVersion: aim.eai.amd.com/v1alpha1
kind: AIMService
metadata:
  name: qwen-chat
  namespace: ml-team
spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5

This creates an inference service using the default runtime configuration and automatically selected profile.

Common Configuration

Scaling

Control the number of replicas:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  replicas: 3

Autoscaling

AIMService supports automatic scaling based on custom metrics using KEDA (Kubernetes Event-driven Autoscaling). This enables your inference services to scale dynamically based on real-time demand.

Basic Autoscaling

Enable autoscaling by specifying minimum and maximum replica counts:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  minReplicas: 1
  maxReplicas: 5

This configures KEDA to manage scaling between 1 and 5 replicas. Without custom metrics, KEDA uses default scaling behavior.

Custom Metrics with OpenTelemetry

For precise control over scaling behavior, configure custom metrics from the inference runtime. vLLM exposes metrics via OpenTelemetry that can drive scaling decisions:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  minReplicas: 1
  maxReplicas: 3
  autoScaling:
    metrics:
      - type: PodMetric
        podmetric:
          metric:
            backend: "opentelemetry"
            metricNames:
              - vllm:num_requests_running
            query: "vllm:num_requests_running"
            operationOverTime: "avg"
          target:
            type: Value
            value: "1"

This configuration scales based on the average number of running requests across pods. When the average exceeds 1, KEDA scales up; when it drops below, KEDA scales down.

Metric Configuration Options

Field Description Default
backend Metrics backend to use opentelemetry
serverAddress Address of the metrics server keda-otel-scaler.keda.svc:4317
metricNames List of metrics to collect from pods -
query Query to retrieve metrics from the backend -
operationOverTime Aggregation operation: last_one, avg, max, min, rate, count last_one

Target Types

Type Description Field
Value Scale based on absolute metric value value
AverageValue Scale based on average value across pods averageValue
Utilization Scale based on percentage utilization (resource metrics only) averageUtilization

Common vLLM Metrics

These metrics are commonly used for autoscaling vLLM-based inference services:

Metric Description Scaling Use Case
vllm:num_requests_running Number of requests currently being processed Scale based on concurrent load
vllm:num_requests_waiting Number of requests waiting in queue Scale based on queue depth

How It Works

When autoscaling is configured, AIMService:

  1. Creates a KServe InferenceService with the serving.kserve.io/autoscalerClass: keda annotation
  2. KEDA creates a ScaledObject that monitors the specified metrics
  3. KEDA creates and manages an HorizontalPodAutoscaler (HPA) based on the ScaledObject
  4. The HPA scales the deployment between minReplicas and maxReplicas based on metric values

Monitoring Autoscaling

First, get the derived KServe InferenceService name for the AIMService:

kubectl -n <namespace> get inferenceservice -l aim.eai.amd.com/service.name=<service-name>

KEDA resources are named from the InferenceService name (<isvc-name>), not the AIMService name:

kubectl -n <namespace> get scaledobject <isvc-name>-predictor -o yaml
kubectl -n <namespace> get hpa keda-hpa-<isvc-name>-predictor

Watch scaling events in real-time:

kubectl -n <namespace> get hpa keda-hpa-<isvc-name>-predictor -w

View current metrics:

kubectl -n <namespace> describe hpa keda-hpa-<isvc-name>-predictor

Prerequisites

Autoscaling requires:

  • KEDA installed in the cluster
  • KEDA OpenTelemetry Scaler (keda-otel-scaler) deployed if using OpenTelemetry metrics
  • OpenTelemetry Collector configured to scrape metrics from inference pods

Resource Limits

Override default resource allocations:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  resources:
    limits:
      cpu: "8"
      memory: 64Gi
    requests:
      cpu: "4"
      memory: 32Gi

Runtime Configuration

Reference a specific runtime configuration for credentials and defaults:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  runtimeConfigName: team-config  # defaults to 'default' if omitted

Runtime configurations provide: - Routing defaults

See Runtime Configuration for details.

HTTP Routing

Enable external HTTP access through Gateway API:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  routing:
    enabled: true
    gatewayRef:
      name: inference-gateway
      namespace: gateways

Custom Paths

Override the default path using templates:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  routing:
    enabled: true
    gatewayRef:
      name: inference-gateway
      namespace: gateways
    pathTemplate: "/{.metadata.namespace}/chat/{.metadata.name}"

Templates use JSONPath expressions wrapped in {...}: - {.metadata.namespace} - service namespace - {.metadata.name} - service name - {.metadata.labels['team']} - label value (label must exist)

The final path is lowercased, URL-encoded, and limited to 200 characters.

Note: If a label or field doesn't exist, the service will enter a degraded state. Ensure all referenced fields are present.

Authentication

For models requiring authentication (e.g., gated Hugging Face models):

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  env:
    - name: HF_TOKEN
      valueFrom:
        secretKeyRef:
          name: huggingface-creds
          key: token

For private container registries:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  imagePullSecrets:
    - name: registry-credentials

Monitoring Service Status

Check service readiness:

kubectl -n <namespace> get aimservice <name>

View detailed status:

kubectl -n <namespace> describe aimservice <name>

Status Values

The status field shows the overall service state:

  • Pending: Initial state, resolving model and template references
  • Starting: Creating infrastructure (InferenceService, routing, caches)
  • Running: Service is ready and serving traffic
  • Degraded: Service is running but has warnings (e.g., routing issues, template not optimal)
  • Failed: Service cannot start due to terminal errors

Status Fields

Field Description
status Overall service status (Pending, Starting, Running, Degraded, Failed)
observedGeneration Most recent generation observed by the controller
conditions Detailed conditions tracking different aspects of service lifecycle
resolvedRuntimeConfig Metadata about the runtime config that was resolved (name, namespace, scope, UID)
resolvedModel Metadata about the model image that was resolved (name, namespace, scope, UID)
resolvedTemplate Metadata about the template that was selected (name, namespace, scope, UID)
routing Observed routing configuration including the rendered HTTP path

Conditions

Services track detailed conditions to help diagnose issues:

  • Framework conditions: DependenciesReachable, AuthValid, ConfigValid, Ready
  • Component conditions: ModelReady, TemplateReady, RuntimeConfigReady, CacheReady, InferenceServiceReady, InferenceServicePodsReady, HTTPRouteReady, HPAReady
  • Common reasons:
  • Model/template resolution: ModelNotFound, ModelNotReady, Resolved, TemplateNotFound, TemplateSelectionAmbiguous
  • Runtime and cache lifecycle: CreatingRuntime, RuntimeReady, CacheCreating, CacheReady, CacheFailed
  • Routing and autoscaling: PathTemplateInvalid, HTTPRouteAccepted, HTTPRoutePending, HPAOperational

Example Status

$ kubectl -n ml-team get aimservice qwen-chat -o yaml
status:
  status: Running
  observedGeneration: 1
  conditions:
    - type: ModelReady
      status: "True"
      reason: ModelResolved
      message: "AIMModel qwen-qwen3-32b is ready"
    - type: TemplateReady
      status: "True"
      reason: Resolved
      message: "AIMClusterServiceTemplate qwen3-32b-latency is ready"
    - type: CacheReady
      status: "True"
      reason: CacheReady
      message: "Template cache is ready"
    - type: InferenceServiceReady
      status: "True"
      reason: RuntimeReady
      message: "InferenceService is ready"
    - type: HTTPRouteReady
      status: "True"
      reason: HTTPRouteAccepted
      message: "HTTPRoute is accepted by gateway"
    - type: Ready
      status: "True"
      reason: AllComponentsReady
      message: "All components are ready"
  resolvedRuntimeConfig:
    name: default
    namespace: ml-team
    scope: Namespace
    kind: aim.eai.amd.com/v1alpha1/AIMRuntimeConfig
  resolvedModel:
    name: qwen-qwen3-32b
    namespace: ml-team
    scope: Namespace
    kind: aim.eai.amd.com/v1alpha1/AIMModel
  resolvedTemplate:
    name: qwen3-32b-latency
    scope: Cluster
    kind: aim.eai.amd.com/v1alpha1/AIMClusterServiceTemplate
  routing:
    path: /ml-team/qwen-chat

Complete Example

apiVersion: aim.eai.amd.com/v1alpha1
kind: AIMService
metadata:
  name: qwen-chat
  namespace: ml-team
  labels:
    team: research
spec:
  model:
    name: qwen-qwen3-32b
  template:
    name: qwen3-32b-latency
  runtimeConfigName: team-config
  replicas: 2
  resources:
    limits:
      cpu: "6"
      memory: 48Gi
  routing:
    enabled: true
    gatewayRef:
      name: inference-gateway
      namespace: gateways
    pathTemplate: "/team/{.metadata.labels['team']}/chat"
  env:
    - name: HF_TOKEN
      valueFrom:
        secretKeyRef:
          name: huggingface-creds
          key: token

Model Caching

Model caching is enabled by default in Shared mode, pre-downloading model artifacts so they are ready when the inference service starts. To use a dedicated cache owned by the service instead:

spec:
  model:
    image: amdenterpriseai/aim-qwen-qwen3-32b:0.8.5
  caching:
    mode: Dedicated

How caching works:

  1. An AIMTemplateCache is created for the service's template, if it doesn't already exist
  2. AIMArtifact resources download model artifacts to PVCs
  3. The service waits for caches to become available before starting
  4. Cached models are mounted directly into the inference container

Cache Preservation on Deletion

Cache behavior on service deletion depends on the mode:

  • Shared (default): Caches persist independently and can be reused by future services
  • Dedicated: Caches are garbage-collected with the service

See Model Caching for detailed information on cache lifecycle and management.

Troubleshooting

Service stuck in Pending

Check if the runtime config exists:

kubectl -n <namespace> get aimruntimeconfig

Check if templates are available:

kubectl -n <namespace> get aimservicetemplate
kubectl get aimclusterservicetemplate

Routing not working

Verify the HTTPRoute was created:

kubectl -n <namespace> get httproute -l aim.eai.amd.com/service.name=<service-name>

Check for path template errors in status:

kubectl -n <namespace> get aimservice <name> -o jsonpath='{.status.conditions[?(@.type=="HTTPRouteReady")]}'

Model not found

Verify the model exists:

kubectl -n <namespace> get aimmodel <model-name>
kubectl get aimclustermodel <model-name>

If using spec.model.image directly, verify the image URI is accessible and the runtime config is properly configured for model creation.