patrickjahns / ansible-role-loki-canary

🔧 Ansible role for deploying loki canary https://github.com/grafana/loki/blob/master/docs/operations/loki-canary.md
MIT License
2 stars 0 forks source link

Variable prefix? #6

Open rlex opened 4 years ago

rlex commented 4 years ago

Hello, thanks for role (and promtail one)

Wanted to ask if it's possible to change variable prefix to lokicanary*, which will be also more consistent with role name (loki-canary).

patrickjahns commented 4 years ago

Thank you for the feedback - is there any specific problem you are currently encountering with the variable names?

As the variable names are already quite long, I would then rather prefer to use the "ansible-openshift" convention of using the first two letters of the role name for the variable: https://github.com/openshift/openshift-ansible/blob/master/docs/style_guide.adoc#ansible-role-variables

This would result in lc_* variables - however to me this seems a bit more confusing and might more easily overlap with other roles

Do you have another community document where best-practices regarding variable names are documented?

rlex commented 4 years ago

Sorry for late reply

is there any specific problem you are currently encountering with the variable names?

I happen to have canary role myself, internal app. I know, my problems, but still.

This would result in lc_* variables - however to me this seems a bit more confusing and might more easily overlap with other roles

Better than canary for sure, but probably can be confused with internal linux LC* (locale) variables.

I do not know about any guidelines for variable names.