rpk: support advertised addresses in `rpk redpanda config bootstrap` #16652

r-vasquez · 2024-02-21T00:14:58Z

This PR introduces both Advertised RPC and Kafka addresses to our defaults. Given that these values are now added to our default config file (see #14600) we must handle them properly during bootstrap.

Now bootstrap supports overriding the default address with the private IP or the one passed via --self flag.

Also, it adds flags to override this behavior and lets the user select which address:port to use in the advertised addresses.

rpk will preemptively fail if the resulting advertised host is 0.0.0.0 to avoid a validation error during startup.

Example:

Starting with the default Redpanda configuration file (https://github.com/redpanda-data/redpanda/blob/dev/conf/redpanda.yaml):

$ rpk redpanda config bootstrap --self 192.168.1.70 --advertised-kafka "redpanda-0.redpanda.redpanda.svc.cluster.local.:9093"

$ cat /etc/redpanda/redpanda.yaml
redpanda:
    data_directory: /var/lib/redpanda/data
    seed_servers: []
    rpc_server:
        address: 192.168.1.70
        port: 33145
    kafka_api:
        - address: 192.168.1.70
          port: 9092
    admin:
        - address: 192.168.1.70
          port: 9644
    advertised_rpc_api:
        address: 192.168.1.70
        port: 33145
    advertised_kafka_api:
        - address: redpanda-0.redpanda.redpanda.svc.cluster.local.
          port: 9093
    developer_mode: true
rpk:
    coredump_dir: /var/lib/redpanda/coredump
pandaproxy: {}
schema_registry: {}

Backports Required

Release Notes

Features

rpk redpanda config bootstrap now support bootstrapping your advertised addresses configuration.

vbotbuildovich · 2024-02-21T02:12:20Z

new failures in https://buildkite.com/redpanda/redpanda/builds/45170#018dc934-5c2b-4da4-90b1-922299a9e442:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_bootstrap_then_start"
"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_simple_start_three_with_root"

new failures in https://buildkite.com/redpanda/redpanda/builds/45170#018dc934-5c27-489b-b37c-70ec651c241b:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_rpc_tls_enable"

new failures in https://buildkite.com/redpanda/redpanda/builds/45170#018dc934-5c2e-4c71-baaf-5a29bc9aa4cb:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_rpc_tls_start"
"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_simple_start_three_with_seeds"

new failures in https://buildkite.com/redpanda/redpanda/builds/45170#018dc95c-9ae7-444b-8cb6-82ea46cf0bd3:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_rpc_tls_start"
"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_simple_start_three_with_seeds"

new failures in https://buildkite.com/redpanda/redpanda/builds/45170#018dc95c-9aef-48e2-92bd-25af9b2754d0:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_rpc_tls_enable"

new failures in https://buildkite.com/redpanda/redpanda/builds/45170#018dc95c-9ae3-402c-8601-f303e71f1e54:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_bootstrap_then_start"
"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_simple_start_three_with_root"

new failures in https://buildkite.com/redpanda/redpanda/builds/45218#018dce76-2bb1-4317-abcf-e338eb7f2fdb:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_bootstrap_then_start"

new failures in https://buildkite.com/redpanda/redpanda/builds/45218#018dce87-9c2b-41f4-9a5b-99ce68364d54:

"rptest.tests.rpk_start_test.RpkRedpandaStartTest.test_bootstrap_then_start"

vbotbuildovich · 2024-02-21T02:16:41Z

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/45170#018dc934-5c2b-4da4-90b1-922299a9e442

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/45223#018dcf0b-c3f4-4429-b097-33e1510e9b67

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/45223#018dcf1c-aef9-46be-af8e-a745f827bb30

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/45223#018dcf89-5e27-459f-abdf-c093e0fb9c3a

ducktape was retried in https://buildkite.com/redpanda/redpanda/builds/45309#018dd76b-7cec-4537-b17a-4322923748e5

r-vasquez · 2024-02-22T18:13:44Z

The failures mentioned here: #16652 (comment) were fixed.

Initial Green CI build: https://buildkite.com/redpanda/redpanda/builds/45223#_
Ci-Repeat (30) rpk_start_test: https://buildkite.com/redpanda/redpanda/builds/45250#_
CDT: https://buildkite.com/redpanda/redpanda/builds/45255

r-vasquez · 2024-02-22T18:18:12Z

/ci-repeat 3
skip-units
dt-repeat=10
tests/rptest/tests/rpk_start_test.py

r-vasquez · 2024-02-22T20:00:51Z

/cdt

src/go/rpk/pkg/cli/redpanda/config.go

twmb · 2024-02-22T20:58:13Z

src/go/rpk/pkg/config/config.go

+	DefaultAdminPort         = 9644
+	DefaultRPCPort           = 33145
+	DefaultListenAddress     = "0.0.0.0"
+	DefaultAdvertisedAddress = "127.0.0.1"


Nit: can this be named something like Localhost or LoopbackIP?

The other default variables are defaults that we add internally (in params.go). This one here is only a default externally, in the repo level redpanda.yaml file. I was confused / looking up where this default is coming from -- it isn't rpk, rpk isn't defaulting this. The PR is to guard against behavior that may be set externally.

Actually I may be wrong. Where is this being set to 127.0.0.1? I thought that example file was only used for testing.

Yes, it is used for testing. But for some Redpanda images this is the starting redpanda.yaml.

But yeah, I agree. We can change the name to localhost but I wanted to make sure that I was using default as in "this comes from somewhere else" and not just only: "we will replace localhost".

Approved but lmk if you change the name and I'll re-+1.

I renamed the variable here: https://github.com/redpanda-data/redpanda/compare/a86992b5e41e313d2241026dabe5ae58e7cf77ca..cd0faa8853477ea3ba64053f4b18a1f90d4a538f

src/go/rpk/pkg/cli/redpanda/config.go

r-vasquez · 2024-02-23T17:53:53Z

1 error in CDT: https://buildkite.com/redpanda/redpanda/builds/45255#018dd26a-9862-4855-bdb0-6b74d6493284/6-11701

Unrelated.

Error is: #15893

This commit introduces 2 new flags and a new behavior to `rpk redpanda config bootstrap`. By default, now advertised addresses (kafka/rpc) are included in our configuration file. So, now `bootstrap` supports overriding the default address with the private IP or the one passed via `--self` flag. Also, adds flags to override this behavior and let the user select which address:port to use in the advertised addresses.

We better error here than later during startup. See redpanda-data#12395

r-vasquez · 2024-03-07T18:53:03Z

/backport v23.3.x

github-actions bot added the area/rpk label Feb 21, 2024

r-vasquez requested review from twmb and gene-redpanda as code owners February 21, 2024 00:16

r-vasquez force-pushed the rpk-bootstrap-advertised branch 2 times, most recently from 163f820 to a86992b Compare February 22, 2024 03:26

gene-redpanda previously approved these changes Feb 22, 2024

View reviewed changes

twmb reviewed Feb 22, 2024

View reviewed changes

src/go/rpk/pkg/cli/redpanda/config.go Show resolved Hide resolved

twmb reviewed Feb 22, 2024

View reviewed changes

src/go/rpk/pkg/cli/redpanda/config.go Show resolved Hide resolved

twmb previously approved these changes Feb 23, 2024

View reviewed changes

r-vasquez added 2 commits February 23, 2024 10:02

rpk: fail on bootstrap if advertised addr is 0.0.0.0

cd0faa8

We better error here than later during startup. See redpanda-data#12395

r-vasquez dismissed stale reviews from twmb and gene-redpanda via cd0faa8 February 23, 2024 18:02

r-vasquez force-pushed the rpk-bootstrap-advertised branch from a86992b to cd0faa8 Compare February 23, 2024 18:02

r-vasquez requested a review from twmb February 23, 2024 18:03

gene-redpanda approved these changes Feb 23, 2024

View reviewed changes

twmb approved these changes Feb 25, 2024

View reviewed changes

r-vasquez merged commit 2bec9ed into redpanda-data:dev Feb 26, 2024
23 checks passed

This was referenced Mar 7, 2024

[v23.3.x] rpk redpanda config bootstrap to bootstrap advertised addresses #16941

Closed

[v23.3.x] rpk: support advertised addresses in rpk redpanda config bootstrap #16942

Merged

BenPope modified the milestone: v23.3.8 Mar 15, 2024

r-vasquez deleted the rpk-bootstrap-advertised branch April 12, 2024 19:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rpk: support advertised addresses in `rpk redpanda config bootstrap` #16652

rpk: support advertised addresses in `rpk redpanda config bootstrap` #16652

r-vasquez commented Feb 21, 2024

vbotbuildovich commented Feb 21, 2024 •

edited

vbotbuildovich commented Feb 21, 2024 •

edited

r-vasquez commented Feb 22, 2024 •

edited

r-vasquez commented Feb 22, 2024

r-vasquez commented Feb 22, 2024

twmb Feb 22, 2024

twmb Feb 22, 2024

r-vasquez Feb 23, 2024

twmb Feb 23, 2024

r-vasquez Feb 23, 2024

r-vasquez commented Feb 23, 2024

r-vasquez commented Mar 7, 2024

rpk: support advertised addresses in rpk redpanda config bootstrap #16652

rpk: support advertised addresses in rpk redpanda config bootstrap #16652

Conversation

r-vasquez commented Feb 21, 2024

Backports Required

Release Notes

Features

vbotbuildovich commented Feb 21, 2024 • edited

vbotbuildovich commented Feb 21, 2024 • edited

r-vasquez commented Feb 22, 2024 • edited

r-vasquez commented Feb 22, 2024

r-vasquez commented Feb 22, 2024

twmb Feb 22, 2024

Choose a reason for hiding this comment

twmb Feb 22, 2024

Choose a reason for hiding this comment

r-vasquez Feb 23, 2024

Choose a reason for hiding this comment

twmb Feb 23, 2024

Choose a reason for hiding this comment

r-vasquez Feb 23, 2024

Choose a reason for hiding this comment

r-vasquez commented Feb 23, 2024

r-vasquez commented Mar 7, 2024

rpk: support advertised addresses in `rpk redpanda config bootstrap` #16652

rpk: support advertised addresses in `rpk redpanda config bootstrap` #16652

vbotbuildovich commented Feb 21, 2024 •

edited

vbotbuildovich commented Feb 21, 2024 •

edited

r-vasquez commented Feb 22, 2024 •

edited