Skip to content
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

Remove spaces from commented out config settings #20090

Closed
markwalkom opened this issue Aug 20, 2016 · 2 comments
Closed

Remove spaces from commented out config settings #20090

markwalkom opened this issue Aug 20, 2016 · 2 comments
Labels
:Core/Infra/Settings Settings infrastructure and APIs discuss good first issue low hanging fruit

Comments

@markwalkom
Copy link
Contributor

From time to time a user runs into an issue with ES not starting and it's sometimes because they uncomment a config option in elasticsearch.yml but only remove the #.

eg;
# cluster.name: my-application
becomes;
cluster.name: my-application
Note the white space in front (it's hard to see here).

Could we make this simpler for users by just removing that white space between the # and the setting? ie;
#cluster.name: my-application

@markwalkom markwalkom added good first issue low hanging fruit discuss :Core/Infra/Settings Settings infrastructure and APIs labels Aug 20, 2016
@dadoonet
Copy link
Member

I agree that a lot of people are falling into this trap. (Me included when I started my first Elasticsearch:) )

+1

abeyad pushed a commit to abeyad/elasticsearch that referenced this issue Aug 21, 2016
the setting in elasticsearch.yml, so that when a user uncomments
out a setting by just removing the #, the setting actually
takes effect. Before, it was very easy to uncomment out a
setting by just removing the #, leaving a single whitespace
character before the setting name, which would cause the
setting to not get picked up by Elasticsearch.

Closes elastic#20090
@abeyad
Copy link

abeyad commented Aug 21, 2016

I agree, and it would also bring elasticsearch.yml in line with logging.yml and jvm.options, which already practice this (no space between # and the setting).

I've opened a PR for this: #20094

abeyad pushed a commit that referenced this issue Aug 22, 2016
the setting in elasticsearch.yml, so that when a user uncomments
out a setting by just removing the #, the setting actually
takes effect. Before, it was very easy to uncomment out a
setting by just removing the #, leaving a single whitespace
character before the setting name, which would cause the
setting to not get picked up by Elasticsearch.

Closes #20090
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Core/Infra/Settings Settings infrastructure and APIs discuss good first issue low hanging fruit
Projects
None yet
Development

No branches or pull requests

3 participants