Skip to content

docs(redis): the tls.enabled description implies TLS can be enabled on a running instance #4624

Open

Description

The redis tls.enabled field description reads as if TLS can be turned on for a running instance, and it cannot. The dashboard and the generated API reference show this text, so a user reading only the form gets the wrong idea.

The description says "Enabling it moves Redis and Sentinel to a TLS-only listener, so existing plaintext clients must be migrated at the same time" (packages/apps/redis/values.yaml:95 at c983b5c, copied into values.schema.json, api/apps/v1alpha1/redis/types.go and the redis-rd ApplicationDefinition). The README of the same chart says the opposite, and is right: TLS is chosen when the instance is created, the RedisFailover schema refuses a change, and on an existing instance the HelmRelease fails while the instance keeps serving what it served before.

Fix: say that TLS is chosen at creation and cannot be switched on an existing instance, then regenerate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    triage/needs-triageIndicates an issue needs triage by a maintainer

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions