Skip to main content
The deployment bundle ships the Poolside documentation site as a container image (public-docs). The same inference chart can deploy it in-cluster, so operators have local access to the documentation alongside the models. This is useful in air-gapped or restricted environments where the hosted documentation is not reachable. This configuration is not enabled by default. You can enable it when you first install the chart, or add it later to a running release with helm upgrade. This page applies to Amazon EKS, OpenShift, and upstream Kubernetes deployments. Follow the tab that matches your platform where the steps differ.

​
Prerequisites

  • A cloud inference deployment, either already installed or in progress. See Install on Amazon EKS, Install on OpenShift, or Install on Kubernetes.
  • The public-docs image uploaded to your registry. The image ships in the bundle’s ./containers/ directory, and upload_images.sh uploads it alongside the atlas image during the install image-upload step. No separate upload is required.

​
Enable the site

Set docs.enabled to true in your inference_values.yaml file:
inference_values.yaml
docs:
  # -- Deploy the public-docs site
  enabled: true
The chart deploys the site as a single Deployment and Service named inference-public-docs. The docs.image registry falls back to the top-level image.registry, and the image name and tag come pre-set to match the shipped public-docs image, so you do not normally set anything under docs.image. With no hostname configured, the site is reachable only inside the cluster, at: 
http://inference-public-docs.poolside-models.svc.cluster.local

​
Expose the site

To reach the site from outside the cluster, give it a hostname. The docs site reuses the same ingress or Route configuration as the models, so it must share the model exposure method.
Exposing the site requires ingress.enabled: true (the same setting the models use). Set docs.ingressHost:
inference_values.yaml
ingress:
  enabled: true
  className: "alb"
docs:
  enabled: true
  # -- Ingress hostname for the docs site
  ingressHost: "docs.example.com"
The docs Ingress reuses the shared ingress.className and ingress.annotations, so it joins the same Application Load Balancer through the alb.ingress.kubernetes.io/group.name annotation. TLS terminates at the load balancer with the ACM certificate from the alb.ingress.kubernetes.io/certificate-arn annotation, so that certificate must also be valid for docs.ingressHost. You do not create an in-cluster TLS secret.

​
Apply the change

Set the docs values in your inference_values.yaml file, then apply them with helm upgrade -i. The -i (--install) flag makes the command idempotent: it installs the release if it does not exist yet, or upgrades it in place if it does. The same command therefore works whether you are enabling the site during the initial install or adding it to a running release. Use the same chart path and flags you used to install. If your install command used --set-file s3.caBundle=... because your S3 backend uses a private CA, include that flag when you run helm upgrade -i on this page: 
helm upgrade -i inference ./charts/inference \
  --namespace poolside-models \
  -f ./inference_values.yaml

​
Verify

Confirm the docs pod is running: 
kubectl get pods -n poolside-models -l app.kubernetes.io/component=public-docs
If you exposed the site, request its hostname and confirm it returns the documentation home page: 
curl -sI http://docs.poolside.local/
The site answers a liveness and readiness check at /healthz, which you can use for external monitoring.