Upgrade component version v3 to v4

Version 4.x is a major overhaul of the configuration parameters of the component, see Release Notes for more details.

The component has lots of options to configure each part of the Mimir installation. Please have a look at the parameters documentation for reference.

This component will no longer support Helm charts < v6.x of Mimir.

Explanation of configuration changes

Migrate to Unified Gateway Deployment

The nginx deployment is deprecated and is removed in Helm chart v6.x. It is necessary to migrate to the unified gateway deployment before you upgrade.

See Migration to Unified Gateway Deployment for further instructions.

(Optional) Consider disabling Zone Aware Replication

This version of the component disables zone aware replication by default, because the rollout-operator in this version of the component installs CRDs for certain functionalities.

That can be a problem, when more than 1 instance of this component is installed. We recommend disabling zone aware replication, unless you need this feature and have a cluster that actually has multiple availability zones enabled.

See global configuration for reference.

New Namespace Naming

This component will change the default name of the namespace to the instance name. It is also no longer allowed to configure an non-instantiated version.

If you have configured a namespace name that is different than the instance name, then change the namespace name here:

namespace:
  name: ${_instance} (1)
1 Overwrite the default namespace name.

If you have configured the component in a non-instantiated version, then change the following:

applications:
  - mimir as your-new-instance-name (1)

parameters:
  your_new_instance_name: (2)
    namespace:
      name: ${_instance} (3)
1 Redefine the component include in applications.
2 Rename the component configuration as your new instance name.
3 Overwrite the default namespace name.

New Default Resource Requests

This component changes its default resource requests and limits, please check the output of your catalog compilation and adjust if needed. See components and caches to adjust your settings.

This component supports the following presets:

  • none: Use the Helm charts defaults.

  • extra-small: Component defaults for small production deployments (default).

  • small: Upstream defaults for small production deployments.

  • large: Upstream defaults for large production deployments.

legacy globalNodeSelector

The values for the global node selector has moved to global.nodeSelector.

This change is backward compatible, but migrating the values to the new structure is recommended.

legacy nginx_resolver_override

The values for the nginx dns resolver override has moved to global.nginxResolverOverride.

This version of the component uses the gateway deployment, but if you still need to override the gateway/nginx resolver, you can now do so through a Helm chart value:

applications:
  - mimir as your-new-instance-name

parameters:
  your-new-instance-name
    components:
      gateway:
        nginx:
          config:
            resolver: 172.30.0.10 (1)
1 Configure the resolver override.