Skip to content

Expose doc for instance_interface_names #3295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

pracucci
Copy link
Contributor

@pracucci pracucci commented Oct 7, 2020

What this PR does:
The config documentation for instance_interface_names was intentionally hidden to keep it simple, but there are legit use cases where our default interfaces don't cover actual ones.

Which issue(s) this PR fixes:
Fixes #3293

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
CHANGELOG.md Outdated
@@ -40,6 +40,11 @@
- `POST <legacy-http-prefix>/push`
- `POST /push`
- `POST /ingester/push`
* [CHANGE] Renamed CLI flags to configure the network interface names from which automatically detect the instance IP. Not a breaking change because these flags were non documented. #3295
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [CHANGE] Renamed CLI flags to configure the network interface names from which automatically detect the instance IP. Not a breaking change because these flags were non documented. #3295
* [CHANGE] Renamed CLI flags to configure the network interface names from which automatically detect the instance IP. Not a breaking change because these flags were not documented. #3295

(or undocumented)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were documented in -help, I was using them in tests.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. -help shows everything. Removing that sentence.

Signed-off-by: Marco Pracucci <marco@pracucci.com>
@pracucci pracucci merged commit 4e27f11 into cortexproject:master Oct 7, 2020
@pracucci pracucci deleted the expose-doc-for-interface-names branch October 7, 2020 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 participants