> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ulm.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install ULM 9

Deploy ULM 9 into a private cloud environment via the required Helm charts. Make a copy of each microservice's `values.yaml` file and edit the file with your organization's information to upload into the cluster.

Preconditions:

* Kubernetes configured with an image pull Secret completed
* Docker images installed

Landscape is installed first because every microservice depends on it, in addition to the inter-microservice communication with either the Platform or OpenID Connect microservices. A best practice is to install the following Helm charts in this order:

| Order | Helm Chart | Description |
| :-: | - | - |
| 1. | ULM Landscape | Prepares in-cluster resources and the required third-party components |
| 2. | ULM Platform | The core ULM base product, bundled with ULM's APIs and the Process Framework |
| 3. | ULM OpenID Connect | Also known as ulmid-oidc, this chart provides ULM's support for the OpenID Connect specification |
| 4. | All other microservices | Depends on the organization's requirements |

**Note:** If one of the remaining microservices fails to start due to a dependency issue, Kubernetes continues to restart the microservice until all dependencies are resolved.

1. Pull the specific helm chart (microservice) from the repository and decompress the archive.

   * `$ helm repo update`
   * `$ helm pull <repo>/<release name> --version <version> --untar`
     **Example**: `$ helm pull <repo>/ulm-platform-your-private-cloud --version <1.16> --untar`

   **Note:** Review the associated `README.md` file for more chart details.

2. Make a copy of the microservice's `values.yaml` file and edit it with the required settings.

3. Install the new `values.yaml` file and associated Helm chart via the command:

   `helm install <release name> <repo>/<microservice chart> --version <version> --namespace <namespace> --values values.yaml`

   **Example**:`helm install <abc-ulm-platform-ms> <repo>/ulm-platform-ms-private-cloud --version <2023.04.135> --namespace <abc-ulm> --values yourvalues.yaml`

4. Save a copy of the microservice's `values.yaml` file (file is used for future upgrades).

5. Repeat this process (Steps 1-4) for each Helm chart.

All the helm charts installed successfully and a ULM 9 instance is released and operating in your cluster.

* **[ULM 9 Install Details](../topics/ulm9Install#)**

## ULM 9 Install Details

| Variable Name | Description |
| - | - |
| \`\` | The release name associated with the current installation. Helm stores install details and metadata in the release name object within the cluster. The release name is used when working with the installed chart in the future such as upgrade or uninstall operations. |
| \`\` | The repository name submitted when the chart repository was configured via the `helm repo add`command. |
| \`\` | The specific version of the chart to install. See the version matrix from the latest ULM 9 Release Notes. |
| \`\` | Defines the namespace to install the chart into. If you're using the default namespace, this parameter can be omitted. |
| `values.yaml` | This is the path or location that the customized values file is saved to such as the `values.yaml` file. **Note:** The yaml file can be renamed anything that you require. Include the path of specific directory if the file is in a different location other than the working directory. |
| **Parent topic:**[Install ULM 9](../topics/ulm9Install#) | |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.