redpanda-data / redpanda-data/redpanda-operator

Document `registry` field for Console image in Redpanda v1alpha2 CRD

Open Beginner friendly
#1,722 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
84
Forks
32
Avg merge
1d 19h
Merged PRs (30d)
104

Description

The Redpanda v1alpha2 CRD supports configuring a separate registry for the Redpanda Console image, but this is not visible from the CRD documentation exposed through kubectl explain.

Running:

kubectl explain Redpanda.spec.clusterSpec.console.image

returns:

GROUP:      cluster.redpanda.com
KIND:       Redpanda
VERSION:    v1alpha2

FIELD: image <Object>

DESCRIPTION:
    Defines the container image for the Redpanda Console, including the
    repository, name, and tag.

The description does not mention the supported registry field.

When configuring a custom image like this:

spec:
  clusterSpec:
    console:
      image:
        repository: reg.mini.dev/redpanda-data-console
        tag: v3.9.0

the resulting image becomes:

docker.redpanda.com/reg.mini.dev/redpanda-data-console:v3.9.0

and the pod fails with an image pull error because the default Console registry is still prepended.

The working configuration is:

spec:
  clusterSpec:
    console:
      image:
        registry: reg.mini.dev
        repository: redpanda-data-console
        tag: v3.9.0

which correctly results in:

reg.mini.dev/redpanda-data-console:v3.9.0

Expected improvement

Please update the CRD schema description and/or generated documentation to explicitly document the supported Console image fields:

console:
  image:
    registry: <registry>
    repository: <repository>
    tag: <tag>

It would also be helpful to clarify that repository should not contain the registry when using the Console image configuration.

Environment

Redpanda Operator Helm chart:

helmCharts:
  - name: operator
    repo: https://charts.redpanda.com
    version: v26.2.1
    releaseName: redpanda-controller
    namespace: redpanda
    includeCRDs: true

Redpanda resource API:

apiVersion: cluster.redpanda.com/v1alpha2
kind: Redpanda

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the v1alpha2 Redpanda CRD schema or generated documentation that supplies the image field description. Update the documentation to list registry, repository, and tag, and clarify that repository should not include the registry. Run kubectl explain Redpanda.spec.clusterSpec.console.image to verify the fields are visible.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.