redpanda-data / redpanda-data/console

AdminApi Incorrect Arg Flag

Open
#1,948 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
4.3k
Forks
432
Avg merge
3d 6h
Merged PRs (30d)
40

Description

This function doesn't seem correct, it looks like the field was moved to: redpanda.admin-api.authentication.basic.password

// RegisterFlags for sensitive Admin API configurations.
func (c *RedpandaAdminAPI) RegisterFlags(flags *flag.FlagSet) {
	flags.BoolVar(&c.Enabled, "redpanda.admin-api.password", c.Enabled, "Basic Auth password to authenticate against the Redpanda Admin API")
}

Also, it doesn't look like the redpanda configs are being included in the flag set?

// RegisterFlags for all (sub)configs
func (c *Config) RegisterFlags(f *flag.FlagSet) {
	f.StringVar(&c.ConfigFilepath, "config.filepath", "", "Path to the config file")
	f.BoolVar(&c.StrictConfigValidation, "config.strict-validation", true, "Strict validation rejects unknown variables in the provided YAML config")

	// Package flags for sensitive input like passwords
	c.Kafka.RegisterFlags(f)
	c.Serde.RegisterFlags(f)
	c.Console.RegisterFlags(f)
	c.KafkaConnect.RegisterFlags(f)
	c.SchemaRegistry.RegisterFlags(f)
}

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 RedpandaAdminAPI.RegisterFlags and Config.RegisterFlags, then compare the registered flag names and fields with the current configuration structure. The fix is complete when the Admin API password flag targets the authentication.basic.password field and the Redpanda configuration registrations are included in the flag set.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.