> For the complete documentation index, see [llms.txt](https://docs.openiam.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openiam.com/installation/installation.md).

# Installation Guide

Build an OpenIAM deployment — choose a route, provision for it, install, and verify.

This guide builds a working OpenIAM deployment. It assumes you have been asked to stand one up, that you have a terminal and a change window, and that you have not read anything else about the product.

**Start with** [**Choose your route**](https://docs.openiam.com/installation/choose-your-route.md)**.** It matches your infrastructure to one of eleven supported routes and lists the pages that route uses, in order.

**Building an evaluation and want the short version?** [Quick start — one host](https://docs.openiam.com/installation/one-host.md) and [Quick start — Kubernetes](https://docs.openiam.com/installation/cluster.md) condense the same procedures onto one page each, with the decisions made for you. They are the fast lane, not a second version of the truth — each step names the page that is the authority for it.

**Then read** [**Scope and availability**](https://docs.openiam.com/installation/scope-and-availability.md)**.** It states what this release covers — all deployments here are single-zone — and what each shape does and does not protect against. Choosing a shape on an incorrect availability assumption is the most expensive mistake available here.

## What this guide builds

<table><thead><tr><th width="178.8000030517578">Shape</th><th>Use it for</th></tr></thead><tbody><tr><td><strong>RPM, single node</strong></td><td>Evaluations, development and test, and production where a single host meets the availability requirement. Bundled, external or managed database</td></tr><tr><td><strong>RPM, three nodes</strong></td><td>Production needing redundancy across the platform's own tiers, tolerating the loss of one application host within a zone</td></tr><tr><td><strong>Kubernetes</strong></td><td>Organizations already running a cluster, where OpenIAM should share its deployment pipeline, monitoring and upgrade rhythm</td></tr></tbody></table>

Each runs on your own infrastructure, on AWS, or on Azure. **Terraform is the recommended route for a new AWS or Azure Kubernetes environment**; Helm is the route for a cluster that already exists.

## Related guides

| You want to                                              | Read                                                                                                                                                                        |
| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Choose a topology and size it                            | [Solution Architecture and Design Guide](https://docs.openiam.com/solution-architecture/solution-architecture.md)                                                           |
| Upgrade an existing deployment                           | [Upgrading OpenIAM — RPM](https://docs.openiam.com/installation/rpm/rpm-upgrade.md) or [Kubernetes](https://docs.openiam.com/installation/kubernetes/kubernetes-upgrade.md) |
| Configure managed systems, roles, policies and campaigns | [Administration Guide](https://docs.openiam.com/administration-guide/admin.md)                                                                                              |
| Get oriented and see the product working                 | *Getting Started*                                                                                                                                                           |

## How to use this guide

1. [**Choose your route**](https://docs.openiam.com/installation/choose-your-route.md) — and read [**Scope and availability**](https://docs.openiam.com/installation/scope-and-availability.md) before committing to a shape.
2. **Before you start** — what to provision, and how to obtain the software.
3. **Your route's pages**, in the order that route lists them.
4. **Verify** — every route ends with a verification page confirming the deployment is ready to configure.

Each page opens with what you are about to create, how long it takes, and whether it can be undone, before it tells you what to run. Every step states what you should see, so you always know where you are.

## How commands in this guide are written

**Every procedure page that needs values from you sets them as shell variables in one block, before the first command.** Fill that block in once and the commands below it can be copied and run as they are.

The same names are used throughout:

<table><thead><tr><th width="230.80001831054688">Variable</th><th>What to set it to</th></tr></thead><tbody><tr><td><code>OPENIAM_HOST</code></td><td>The host you are installing on</td></tr><tr><td><code>OPENIAM_URL</code></td><td>The address users will type, once you have decided it</td></tr><tr><td><code>NODE1</code>, <code>NODE2</code>, <code>NODE3</code></td><td>The three hosts of a three-node deployment. <code>NODE1</code> is the first node</td></tr><tr><td><code>DB_HOST</code>, <code>DB_PORT</code>, <code>DB_ADMIN</code></td><td>Your database server, its port, and an administrative account on it</td></tr><tr><td><code>OPENIAM_VERSION</code></td><td>The release you are installing</td></tr><tr><td><code>NS</code>, <code>APP</code></td><td>On Kubernetes: the namespace, and the deployment name</td></tr><tr><td><code>RWX_CLASS</code></td><td>On Kubernetes: the storage class that supports <code>ReadWriteMany</code></td></tr><tr><td><code>DIAG_IMAGE</code></td><td>On Kubernetes: a small pinned utility image, used only by the diagnostic checks</td></tr></tbody></table>

Angle brackets — `<like this>` — appear only where a value is illustrative rather than something you would set once, and the surrounding text always says what to put there.

## If you get stuck

Every path has a troubleshooting page: what you see, what it means, what to do. [Diagnostics](https://docs.openiam.com/installation/diagnostics.md) has a health snapshot, a symptom index and a collection script for a support case.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openiam.com/installation/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
