> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation overview

> Choose a platform and follow the end-to-end path: distribution, cluster, Helm install, ingress, and validation for self-hosted Arize AX.

Self-hosted Arize AX installs on Kubernetes using the **distribution archive** (Helm operator chart, `arize.sh`, Terraform, and offline `docs/`), your **`values.yaml`**, and your platform’s networking and storage.

## Before you install

1. [Installation flow](/ax/selfhosting/getting-started/overview) — Operator, Helm, and how the pieces connect.
2. [Prerequisites](/ax/selfhosting/getting-started/prerequisites) — sizing, pools, storage, and tools.
3. [Download and unpack the distribution](/ax/selfhosting/getting-started/download-and-unpack-the-distribution) — obtain and extract the release tarball.

## Install by platform

<Tabs>
  <Tab title="GCP">
    ## Overview

    The diagram below depicts the target topology for GCP.

    ![](https://storage.googleapis.com/arize-assets/assets/images/arize-docs-images/993bdd6d-image.jpeg)

    Throughout this section, **distribution archive** means the **Arize AX release tarball** you download with your JWT (Helm chart, `arize.sh`, Terraform, examples, and offline HTML docs).

    **Read the ordered steps below once** so you know the sequence (download → cluster → install → ingress → validate). Complete [Prerequisites](/ax/selfhosting/getting-started/prerequisites), including [deployment types](/ax/selfhosting/getting-started/deployment-types) for your network model, before you start. Then open each linked page below; you can return here anytime as the hub.

    For the full Helm reference, use **Advanced → Helm** in the HTML documentation under **`docs/`** inside your extracted distribution archive.

    <Steps>
      <Step title="Download the distribution">
        Obtain the distribution archive with your JWT, extract it, and review the Helm chart, scripts, Terraform, and example manifests included in the bundle.

        <CardGroup cols={1}>
          <Card title="Download and extract" href="/ax/selfhosting/getting-started/download-and-unpack-the-distribution" icon="download">
            JWT, `get_latest.sh`, folder layout, and what to open next.
          </Card>
        </CardGroup>
      </Step>

      <Step title="GKE cluster and infrastructure">
        Bring an existing GKE cluster and supporting GCP resources in line with Arize AX, or use the Terraform modules shipped in the distribution archive to provision them.

        <CardGroup cols={2}>
          <Card title="Existing cluster" href="/ax/selfhosting/installation/gcp/cluster-existing-gke" icon="server">
            Node pools, labels, GCS buckets, IAM, and Workload Identity.
          </Card>

          <Card title="Terraform" href="/ax/selfhosting/installation/gcp/cluster-terraform" icon="cloud">
            Use bundled modules and README; align static IPs and outputs with ingress.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Install Arize AX">
        Configure `values.yaml` for GCP and install the operator chart.

        <CardGroup cols={2}>
          <Card title="Quick start" href="/ax/selfhosting/installation/gcp/install-arize-quickstart" icon="zap">
            **Use when:** you want a complete example `values.yaml` and a single Helm command to get running fast.
          </Card>

          <Card title="Detailed walkthrough" href="/ax/selfhosting/installation/gcp/install-arize-detailed" icon="book">
            **Use when:** you need every field explained, base64 secrets, optional mirroring, and `./arize.sh` versus Helm called out step by step.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Create ingress">
        Expose the UI and APIs with a Google Cloud HTTP(S) load balancer and the GCP examples, or use NGINX, Istio, Kong, or another controller with the bundled example manifests.

        <CardGroup cols={2}>
          <Card title="GCP load balancer" href="/ax/selfhosting/installation/gcp/ingress-gcp-load-balancer" icon="cloud">
            Static IPs, `examples/endpoints/gcp`, and `appBaseUrl` / `expBaseUrl`.
          </Card>

          <Card title="NGINX, Istio, Kong, …" href="/ax/selfhosting/installation/ingress/other-controllers" icon="plug">
            Example paths under `examples/endpoints` and `ingressMode` guidance.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Validate the deployment">
        Confirm pods are healthy, ingress and DNS resolve, and the UI is reachable before sending data.

        <CardGroup cols={1}>
          <Card title="Validation checklist" href="/ax/selfhosting/installation/validate-deployment" icon="check-circle">
            `kubectl` health checks, ingress inspection, login, and SDK testing.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Use Arize AX">
        Open the public Arize AX documentation for product guides and configure your application with the on-prem SDK documentation.

        <CardGroup cols={3}>
          <Card title="Arize AX documentation" href="https://docs.arize.com" icon="book-open">
            Product documentation, quickstarts, and observability guides on docs.arize.com.
          </Card>

          <Card title="SDK usage (self-hosted)" href="/ax/selfhosting/guides/sdk-usage" icon="code">
            Python SDK versions and endpoint configuration for self-hosted deployments.
          </Card>

          <Card title="Integrations" href="/ax/selfhosting/guides/integrations" icon="plug">
            Framework and provider integrations for tracing and monitoring.
          </Card>
        </CardGroup>
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure">
    ## Overview

    The diagram below depicts the target topology for Azure.

    ![](https://storage.googleapis.com/arize-assets/assets/images/arize-docs-images/3ed7c039-image.jpeg)

    Throughout this section, **distribution archive** means the **Arize AX release tarball** you download with your JWT (Helm chart, `arize.sh`, Terraform, examples, and offline HTML docs).

    **Read the ordered steps below once** so you know the sequence (download → cluster → install → ingress → validate). Complete [Prerequisites](/ax/selfhosting/getting-started/prerequisites), including [deployment types](/ax/selfhosting/getting-started/deployment-types) for your network model, before you start. Then open each linked page below; you can return here anytime as the hub.

    For the full Helm reference, use **Advanced → Helm** in the HTML documentation under **`docs/`** inside your extracted distribution archive.

    <Steps>
      <Step title="Download the distribution">
        Obtain the distribution archive with your JWT, extract it, and review the Helm chart, scripts, Terraform, and example manifests included in the bundle.

        <CardGroup cols={1}>
          <Card title="Download and extract" href="/ax/selfhosting/getting-started/download-and-unpack-the-distribution" icon="download">
            JWT, `get_latest.sh`, folder layout, and what to open next.
          </Card>
        </CardGroup>
      </Step>

      <Step title="AKS cluster and infrastructure">
        Bring an existing AKS cluster and supporting Azure resources in line with Arize AX, or use the Terraform modules shipped in the distribution archive to provision them.

        <CardGroup cols={2}>
          <Card title="Existing cluster" href="/ax/selfhosting/installation/azure/cluster-existing-aks" icon="server">
            Node pools, labels, Blob Storage containers, managed identity, and storage access.
          </Card>

          <Card title="Terraform" href="/ax/selfhosting/installation/azure/cluster-terraform" icon="cloud">
            Use bundled modules and README; align static IPs and outputs with ingress.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Install Arize AX">
        Configure `values.yaml` for Azure and install the operator chart.

        <CardGroup cols={2}>
          <Card title="Quick start" href="/ax/selfhosting/installation/azure/install-arize-quickstart" icon="zap">
            **Use when:** you want a complete example `values.yaml` and a single Helm command to get running fast.
          </Card>

          <Card title="Detailed walkthrough" href="/ax/selfhosting/installation/azure/install-arize-detailed" icon="book">
            **Use when:** you need every field explained, base64 secrets, optional mirroring, and `./arize.sh` versus Helm called out step by step.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Create ingress">
        Expose the UI and APIs with an Azure load balancer and the bundled examples, or use NGINX, Istio, Kong, or another controller with the bundled example manifests.

        <CardGroup cols={2}>
          <Card title="Azure load balancer" href="/ax/selfhosting/installation/azure/ingress-azure-load-balancer" icon="cloud">
            Static IPs, `examples/endpoints/azure`, and `appBaseUrl` / `expBaseUrl`.
          </Card>

          <Card title="NGINX, Istio, Kong, …" href="/ax/selfhosting/installation/ingress/other-controllers" icon="plug">
            Example paths under `examples/endpoints` and `ingressMode` guidance.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Validate the deployment">
        Confirm pods are healthy, ingress and DNS resolve, and the UI is reachable before sending data.

        <CardGroup cols={1}>
          <Card title="Validation checklist" href="/ax/selfhosting/installation/validate-deployment" icon="check-circle">
            `kubectl` health checks, ingress inspection, login, and SDK testing.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Use Arize AX">
        Open the public Arize AX documentation for product guides and configure your application with the on-prem SDK documentation.

        <CardGroup cols={3}>
          <Card title="Arize AX documentation" href="https://docs.arize.com" icon="book-open">
            Product documentation, quickstarts, and observability guides on docs.arize.com.
          </Card>

          <Card title="SDK usage (self-hosted)" href="/ax/selfhosting/guides/sdk-usage" icon="code">
            Python SDK versions and endpoint configuration for self-hosted deployments.
          </Card>

          <Card title="Integrations" href="/ax/selfhosting/guides/integrations" icon="plug">
            Framework and provider integrations for tracing and monitoring.
          </Card>
        </CardGroup>
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWS">
    ## Overview

    The diagram below depicts the target topology for AWS.

    ![](https://storage.googleapis.com/arize-assets/assets/images/arize-docs-images/44346ada-image.jpeg)

    Throughout this section, **distribution archive** means the **Arize AX release tarball** you download with your JWT (Helm chart, `arize.sh`, Terraform, examples, and offline HTML docs).

    **Read the ordered steps below once** so you know the sequence (download -> cluster -> install -> ingress -> validate). Complete [Prerequisites](/ax/selfhosting/getting-started/prerequisites), including [deployment types](/ax/selfhosting/getting-started/deployment-types) for your network model, before you start. Then open each linked page or section below; you can return here anytime as the hub.

    For the full Helm reference, use **Advanced -> Helm** in the HTML documentation under **`docs/`** inside your extracted distribution archive.

    <Steps>
      <Step title="Download the distribution">
        Obtain the distribution archive with your JWT, extract it, and review the Helm chart, scripts, Terraform, and example manifests included in the bundle.

        <CardGroup cols={1}>
          <Card title="Download and extract" href="/ax/selfhosting/getting-started/download-and-unpack-the-distribution" icon="download">
            JWT, `get_latest.sh`, folder layout, and what to open next.
          </Card>
        </CardGroup>
      </Step>

      <Step title="EKS cluster and AWS infrastructure">
        Prepare the EKS cluster, S3 buckets, storage classes, IAM permissions, and private-network endpoints needed by Arize AX.

        <CardGroup cols={2}>
          <Card title="Existing EKS cluster" href="/ax/selfhosting/installation/aws/cluster-existing-eks" icon="server">
            EKS node pools, S3 buckets, storage classes, IAM, IRSA, and VPC endpoint access.
          </Card>

          <Card title="Terraform" href="/ax/selfhosting/installation/aws/cluster-terraform" icon="cloud">
            Use bundled modules and README to provision EKS, networking, S3, IAM, and load-balancer support.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Install Arize AX">
        Configure `values.yaml` for AWS and install the operator chart from the extracted distribution directory.

        <CardGroup cols={2}>
          <Card title="Quick start" href="/ax/selfhosting/installation/aws/install-arize-quickstart" icon="zap">
            Example `values.yaml` and Helm command for an AWS install.
          </Card>

          <Card title="Detailed walkthrough" href="/ax/selfhosting/installation/aws/install-arize-detailed" icon="book">
            Required AWS fields, base64 secrets, S3 buckets, IAM role, and registry settings.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Create ingress">
        Expose the UI and APIs with the AWS load-balancing pattern your platform uses, or use NGINX, Istio, Kong, or another controller with the bundled example manifests.

        <CardGroup cols={2}>
          <Card title="AWS load balancer" href="/ax/selfhosting/installation/aws/ingress-aws-load-balancer" icon="cloud">
            AWS load balancer planning, endpoint examples, `appBaseUrl`, and DNS checks.
          </Card>

          <Card title="NGINX, Istio, Kong, ..." href="/ax/selfhosting/installation/ingress/other-controllers" icon="plug">
            Example paths under `examples/endpoints` and `ingressMode` guidance.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Validate the deployment">
        Confirm pods are healthy, ingress and DNS resolve, and the UI is reachable before sending data.

        <CardGroup cols={1}>
          <Card title="Validation checklist" href="/ax/selfhosting/installation/validate-deployment" icon="check-circle">
            `kubectl` health checks, ingress inspection, login, and SDK testing.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Use Arize AX">
        Open the public Arize AX documentation for product guides and configure your application with the on-prem SDK documentation.

        <CardGroup cols={3}>
          <Card title="Arize AX documentation" href="https://docs.arize.com" icon="book-open">
            Product documentation, quickstarts, and observability guides on docs.arize.com.
          </Card>

          <Card title="SDK usage (self-hosted)" href="/ax/selfhosting/guides/sdk-usage" icon="code">
            Python SDK versions and endpoint configuration for self-hosted deployments.
          </Card>

          <Card title="Integrations" href="/ax/selfhosting/guides/integrations" icon="plug">
            Framework and provider integrations for tracing and monitoring.
          </Card>
        </CardGroup>
      </Step>
    </Steps>
  </Tab>

  <Tab title="OpenShift">
    ## Overview

    This section provides guidance for installing Arize AX on Red Hat OpenShift, including Red Hat OpenShift Service on AWS (ROSA). The diagram below shows a typical OpenShift private-cloud topology.

    ![](https://storage.googleapis.com/arize-assets/assets/images/arize-docs-images/e38827ba-image.jpeg)

    Throughout this section, **distribution archive** means the **Arize AX release tarball** you download with your JWT (Helm chart, `arize.sh`, Terraform, examples, and offline HTML docs).

    **Read the ordered steps below once** so you know the sequence (download -> cluster -> install -> ingress -> validate). Complete [Prerequisites](/ax/selfhosting/getting-started/prerequisites), including [deployment types](/ax/selfhosting/getting-started/deployment-types) for your network model, before you start. Then open each linked page below; you can return here anytime as the hub.

    For the full Helm reference, use **Advanced -> Helm** in the HTML documentation under **`docs/`** inside your extracted distribution archive.

    <Steps>
      <Step title="Download the distribution">
        Obtain the distribution archive with your JWT, extract it, and review the Helm chart, scripts, Terraform, and example manifests included in the bundle.

        <CardGroup cols={1}>
          <Card title="Download and extract" href="/ax/selfhosting/getting-started/download-and-unpack-the-distribution" icon="download">
            JWT, `get_latest.sh`, folder layout, and what to open next.
          </Card>
        </CardGroup>
      </Step>

      <Step title="OpenShift cluster and infrastructure">
        Prepare namespaces, SCC-compatible security context values, object storage, storage classes, and registry access for the OpenShift target.

        <CardGroup cols={1}>
          <Card title="Existing OpenShift cluster" href="/ax/selfhosting/installation/openshift/cluster-existing-openshift" icon="boxes">
            ROSA and private-cloud requirements, sizing, storage, namespaces, and SCC-aligned security context notes.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Install Arize AX">
        Configure `values.yaml` for OpenShift and install the operator chart from the extracted distribution directory.

        <CardGroup cols={2}>
          <Card title="Quick start" href="/ax/selfhosting/installation/openshift/install-arize-quickstart" icon="zap">
            Example OpenShift `values.yaml` and Helm command for a fast install path.
          </Card>

          <Card title="Detailed walkthrough" href="/ax/selfhosting/installation/openshift/install-arize-detailed" icon="book">
            Ceph/S3-compatible storage fields, base64 secrets, runAs IDs, `ingressMode`, and `arize.sh`.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Create ingress">
        Expose the UI and APIs with OpenShift ingress mode or the endpoint pattern your platform team standardizes on.

        <CardGroup cols={2}>
          <Card title="OpenShift ingress mode" href="/ax/selfhosting/installation/openshift/ingress-openshift" icon="route">
            Set `ingressMode: 'openshift'`, plan endpoint hostnames, and verify OpenShift routes or ingress resources.
          </Card>

          <Card title="Configuring endpoints" href="/ax/selfhosting/installation/ingress/configuring-endpoints" icon="plug">
            Hostnames, `appBaseUrl`, endpoint inventory, TLS, and DNS planning.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Validate the deployment">
        Confirm pods are healthy, ingress and DNS resolve, and the UI is reachable before sending data.

        <CardGroup cols={1}>
          <Card title="Validation checklist" href="/ax/selfhosting/installation/validate-deployment" icon="check-circle">
            `kubectl` health checks, ingress inspection, login, and SDK testing.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Use Arize AX">
        Open the public Arize AX documentation for product guides and configure your application with the on-prem SDK documentation.

        <CardGroup cols={3}>
          <Card title="Arize AX documentation" href="https://docs.arize.com" icon="book-open">
            Product documentation, quickstarts, and observability guides on docs.arize.com.
          </Card>

          <Card title="SDK usage (self-hosted)" href="/ax/selfhosting/guides/sdk-usage" icon="code">
            Python SDK versions and endpoint configuration for self-hosted deployments.
          </Card>

          <Card title="Integrations" href="/ax/selfhosting/guides/integrations" icon="plug">
            Framework and provider integrations for tracing and monitoring.
          </Card>
        </CardGroup>
      </Step>
    </Steps>
  </Tab>

  <Tab title="Single host">
    <Callout title="Development and testing only" type="warning">
      Single-host installs are not for production. Use this path only for testing or development.
    </Callout>

    <CardGroup cols={1}>
      <Card title="Single-host installation" href="/ax/selfhosting/installation/installation-on-single-host" icon="server">
        One VM with k3s, Helm, S3-compatible object storage, Arize AX install values, Traefik ingress, and validation.
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="Rancher">
    ## Overview

    Use this page when Kubernetes is already running and is managed by Rancher. Rancher can manage clusters across cloud, private cloud, and bare-metal infrastructure; this guide starts from an existing Rancher-managed Kubernetes cluster and does not cover provisioning Rancher or the underlying hosts.

    Your platform team owns the cluster-level choices: storage classes, ingress, DNS, registry access, and object storage. The Arize AX install flow is still the same: point `kubectl` at the target cluster, create `values.yaml` next to `arize.sh`, then run `./arize.sh install` from the extracted distribution directory.

    Throughout this section, **distribution archive** means the **Arize AX release tarball** you download with your JWT (Helm chart, `arize.sh`, examples, and offline HTML docs).

    **Read the ordered steps below once** so you know the sequence (download -> cluster/storage -> values -> install -> ingress -> validate). Then open each linked page below; you can return here anytime as the hub.

    <Steps>
      <Step title="Download the distribution">
        Obtain the distribution archive with your JWT, extract it, and review the Helm chart, scripts, examples, and offline docs included in the bundle.

        <CardGroup cols={1}>
          <Card title="Download and extract" href="/ax/selfhosting/getting-started/download-and-unpack-the-distribution" icon="download">
            JWT, `get_latest.sh`, folder layout, and what to open next.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Prepare cluster and storage">
        Confirm kubeconfig, namespaces, storage classes, object storage, sizing, and Rancher-specific cluster constraints before installing.

        <CardGroup cols={1}>
          <Card title="Cluster and storage" href="/ax/selfhosting/installation/rancher-bare-metal/cluster-and-storage" icon="database">
            Kubeconfig, namespaces, object storage, sizing, small-cluster values, tolerations, and baseOverlay guidance.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Install Arize AX">
        Create `values.yaml` in the extracted distribution directory, run the installer, and apply platform-specific adjustments when needed.

        <CardGroup cols={2}>
          <Card title="Install Arize AX" href="/ax/selfhosting/installation/rancher-bare-metal/install-arize" icon="terminal">
            Create `values.yaml`, encode secrets, run `./arize.sh -y -t 5400 install`, and handle namespace ownership.
          </Card>

          <Card title="Restricted PodSecurity" href="/ax/selfhosting/installation/rancher-bare-metal/talos-podsecurity" icon="shield">
            Promtail `hostPath`, PodSecurity baseline, and policy guidance.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Create ingress">
        Expose the UI and APIs with the ingress controller, load balancer, DNS, and TLS pattern your platform team standardizes on.

        <CardGroup cols={2}>
          <Card title="Configuring endpoints" href="/ax/selfhosting/installation/ingress/configuring-endpoints" icon="route">
            Hostnames, `appBaseUrl`, endpoint inventory, TLS, and DNS planning.
          </Card>

          <Card title="NGINX, Istio, Kong, ..." href="/ax/selfhosting/installation/ingress/other-controllers" icon="plug">
            Example paths under `examples/endpoints` and `ingressMode` guidance.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Validate and troubleshoot">
        Check operator status, pods, jobs, and logs. Use cleanup guidance only when intentionally discarding a previous install.

        <CardGroup cols={2}>
          <Card title="Validate and troubleshoot" href="/ax/selfhosting/installation/rancher-bare-metal/validate-troubleshoot" icon="check-circle">
            Operator status, pods, jobs, stuck-job recovery, and log-safety reminders.
          </Card>

          <Card title="Fresh reinstall cleanup" href="/ax/selfhosting/advanced/fresh-reinstall-cleanup" icon="rotate-ccw">
            Destructive reset path for intentionally discarded installs.
          </Card>
        </CardGroup>
      </Step>

      <Step title="Use Arize AX">
        Open the public Arize AX documentation for product guides and configure your application with the on-prem SDK documentation.

        <CardGroup cols={3}>
          <Card title="Arize AX documentation" href="https://docs.arize.com" icon="book-open">
            Product documentation, quickstarts, and observability guides on docs.arize.com.
          </Card>

          <Card title="SDK usage (self-hosted)" href="/ax/selfhosting/guides/sdk-usage" icon="code">
            Python SDK versions and endpoint configuration for self-hosted deployments.
          </Card>

          <Card title="Integrations" href="/ax/selfhosting/guides/integrations" icon="plug">
            Framework and provider integrations for tracing and monitoring.
          </Card>
        </CardGroup>
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Bare metal environments

Arize AX can run on Kubernetes platforms deployed on bare metal, but these docs assume the Kubernetes platform already exists.

<CardGroup cols={1}>
  <Card title="Bare metal compatibility" href="/ax/selfhosting/installation/bare-metal-compatibility" icon="server">
    Rancher, OpenShift, and single-host k3s options, plus what your platform team needs to provide before installing Arize AX.
  </Card>
</CardGroup>

## Shared configuration

* [External PostgreSQL requirements](/ax/selfhosting/installation/external-postgres-requirements)
* [Configuring ingress and endpoints](/ax/selfhosting/installation/ingress/configuring-endpoints)
* [Ingress — NGINX, Istio, Kong, and others](/ax/selfhosting/installation/ingress/other-controllers)
* [Configuring SAML](/ax/selfhosting/installation/configuring-saml)

For release versions and artifacts, see [On-premise releases](/ax/selfhosting/on-premise-releases).