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

Fixing the indentation of the processing rule example #835

Merged
merged 2 commits into from
Aug 21, 2020

Conversation

justrelax19
Copy link
Contributor

Description

The indentation was little off and therefore on uncommenting the code and doing helm upgrade, it was giving the YAML file error.

Fill in your description here.

Testing performed
  • ci/build.sh
  • Redeploy fluentd and fluentd-events pods
  • Confirm events, logs, and metrics are coming in

@justrelax19 justrelax19 requested review from frankreno, a team, perk-sumo and pmalek-sumo and removed request for a team August 19, 2020 09:12
Copy link
Contributor

@perk-sumo perk-sumo left a comment

Choose a reason for hiding this comment

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

Good find! But let's keep the comment hashes at the same level as this needs to be uncommented as a whole block.

deploy/helm/sumologic/values.yaml Outdated Show resolved Hide resolved
@perk-sumo perk-sumo added this to the v1.2 milestone Aug 19, 2020
@perk-sumo
Copy link
Contributor

I think there should not be any spaces between the comment hash and the commented key (# key: vs #key:) as this might be misleading.

@pmalek-sumo
Copy link
Contributor

I think there should not be any spaces between the comment hash and the commented key (# key: vs #key:) as this might be misleading.

As far as I can see (et least values.yaml) we're using # key: approach (for example it's the same with telegraf's configs if that's relevant here) and I'd say we should stick with it.

Nevertheless I'm all ears to hear pros and cons of both approaches.

@perk-sumo
Copy link
Contributor

we're using # key: approach

Actually we're using both:
https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/master/deploy/helm/sumologic/values.yaml#L20
https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/master/deploy/helm/sumologic/values.yaml#L44

I like the #key: better because for me there is no doubt what needs to be deleted (only #? or maybe # ?)
But it doesn't look as good as # key:.
Anyway having both in one file does not help, let's fix that in 1.3.

However we chose we should make it clear at the top, like I propose in this PR for comments starting with ## or more characters:
#836

@perk-sumo
Copy link
Contributor

I've created new issue for #key: vs # key: and the whole file unification: #837

Co-authored-by: Marcin Stozek <58700054+perk-sumo@users.noreply.github.com>
@justrelax19 justrelax19 requested a review from perk-sumo August 21, 2020 05:51
Copy link
Contributor

@perk-sumo perk-sumo left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@perk-sumo perk-sumo merged commit e95eb7b into master Aug 21, 2020
@perk-sumo perk-sumo deleted the IndentationFix_Processingrule branch August 21, 2020 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants