Skip to main content

Introduction

MintPress is deployed using Helm, a package manager for Kubernetes. Helm is used to deploy the MintPress application and its dependencies to your Kubernetes cluster, under a configurable namespace.

Configuration​

The MintPress installation is customized by modifying a values.yaml file, which is then used by Helm to deploy the MintPress application and its dependencies to your Kubernetes cluster. This file contains all the configuration options for MintPress and its services, including encryption keys, passwords, TLS and hostname settings, database configuration, LDAP settings and more.

Setting management

MintPress settings are managed in one of two ways:

  • Managed by the deployment — a defined set of settings (such as service hostnames and ports, encryption keys, etc.) is owned by your values.yaml file. These are applied at install or upgrade time and cannot be edited via the OpsChain GUI or API; to change one, update the values.yaml and redeploy. The full list appears in the settings managed by the deployment section.
  • Configurable via the GUI or API — every other setting can be modified at any time via dedicated pages in the OpsChain GUI and endpoints in the OpsChain API. These settings apply live across all clusters in a high availability deployment, with no restart of the OpsChain API required. For these settings, the value in values.yaml is only used to seed the initial value on first install; afterwards the stored value is the source of truth.

If a setting is misconfigured in a way that locks you out, you can recover by overriding it from a deploy.

The settings defined in this file overwrite the default values defined in the MintPress Helm chart.

Patching

By running the installation command with a modified values.yaml file, you'll be patching MintPress to use these new settings. Refer to the patching guide for more information.

As MintPress receives new releases, the Helm chart might be updated to include new settings or modify the existing ones. Refer to the release notes page to see all such modifications made to the Helm chart and the MintPress application.

Sample values.yaml files​

You can find a list of different sample values.yaml files here, each file comes with its own set of features for different use cases.

  • MintPress with MintModel rendering capabilities: this example file installs MintPress with MintModel rendering capabilities. It defines 5 worker pods and 5 MintModel rendering pods. You can obtain it by running the following command:

    curl -fsSL https://docs.mintpress.io/files/config_file_examples/values.yaml.example -o values.yaml.example

  • MintPress without MintModel rendering capabilities: this example file installs MintPress without MintModel rendering capabilities. It defines 5 worker pods. You can obtain it by running the following command:

    curl -fsSL https://docs.mintpress.io/files/config_file_examples/values.yaml.example-simple -o values.yaml.example
File name

After making the configuration in your values.yaml.example file, you should rename it to values.yaml so it's compatible with the commands used in the following guides.

Obtaining a full values.yaml from the chart​

Advanced usage

This method is only recommended for advanced users who are familiar with the MintPress Helm chart and its configuration options. If you are unsure, we recommend using the sample values.yaml files provided above.

Alternatively, once you have logged in to Helm, you can obtain a full values.yaml file for a version of the MintPress Helm chart by running the following command:

helm show values oci://docker.io/limepoint/mintpress --version ${MINTPRESS_CHART_VERSION} > values.yaml

What to do next​