Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

Docs required for special_address in metallb component #632

Closed
knrt10 opened this issue Jun 16, 2020 · 9 comments
Closed

Docs required for special_address in metallb component #632

knrt10 opened this issue Jun 16, 2020 · 9 comments
Assignees
Labels
kind/documentation Issues about documentation

Comments

@knrt10
Copy link
Member

knrt10 commented Jun 16, 2020

Currenly in configuration example we are showing use for special_addresses but there is not refrence to it in attribute-reference table. We need to document it.

@knrt10 knrt10 added the kind/documentation Issues about documentation label Jun 16, 2020
@knrt10
Copy link
Member Author

knrt10 commented Jun 29, 2020

Can we say this is fixed by 173e517#diff-32657cb248d48ce75b8dd96cac5450b3R88?

@invidian
Copy link
Member

Personally, I still do not understand what this option is doing and how to use it, so I'd say we should improve that still.

@knrt10
Copy link
Member Author

knrt10 commented Jun 29, 2020

@ipochi @surajssd any ideas?

@ipochi
Copy link
Member

ipochi commented Jun 29, 2020

I think thats a map key/value field. Doesn't have any special meaning to it.

@invidian
Copy link
Member

To rephrase, as a user, under what conditions I should care to set special_addresses to something? And to what?

@ipochi
Copy link
Member

ipochi commented Jun 29, 2020

@johananl Does having the key default or special_addresses carry a special meaning in metallb ?

@johananl
Copy link
Member

johananl commented Jun 29, 2020

Nope, these are likely sample address pool names.
IIRC I've opted for using a map for specifying address pools because each pool has a name and an array of prefixes, hence map[string][]string.

@johananl
Copy link
Member

If these names are confusing, please feel free to change them to something more intuitive.

@johananl
Copy link
Member

Fixed in #996.

@johananl johananl self-assigned this Sep 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/documentation Issues about documentation
Projects
None yet
Development

No branches or pull requests

4 participants