redpanda-data / redpanda-data/redpanda-operator

Configuring Console when deployed using operator chart

Open
#1,272 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

There are some contradictions related to the Console configuration.

  1. This page says:
When you deploy a Redpanda cluster using the [Redpanda Operator or Redpanda Helm chart](https://docs.redpanda.com/current/deploy/redpanda/kubernetes/k-production-deployment/), 
Redpanda Console is automatically deployed alongside your cluster. 

I can confirm, indeed, when I deployed the operator, the Console CR was created and console was successfully deployed along with the rest of the components. All the values like brokers etc are nicely pre-populated and console works right out of the box.

  1. This page, for the operator says:
Configure Redpanda Console in the console section of your Redpanda custom resource:

And right below that statement there is a code snippet for the Console CR, not the Redpanda one.

  1. The API doc for the RedpandaClusterSpec says that console is Deprecated: Use the dedicated Console CRD.

The question is - how do we configure the console if the Console CR is automatically created by the operator? I need to make just small adjustments, while I don't want to loose any pre-populated parameters.

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 with the linked Console deployment, Console configuration, and RedpandaClusterSpec API documentation pages, comparing their descriptions of operator-managed configuration. Clarify the supported configuration path and how existing pre-populated values are retained; done when the three pages consistently explain how to make small Console adjustments.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.