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

prefix vars to avoid namespace clashes #77

Closed
nusenu opened this issue Aug 22, 2016 · 1 comment
Closed

prefix vars to avoid namespace clashes #77

nusenu opened this issue Aug 22, 2016 · 1 comment
Milestone

Comments

@nusenu
Copy link
Owner

nusenu commented Aug 22, 2016

Follow best practices and prefix your role variables.

mentioned in #75 and
https://galaxy.ansible.com/intro

I find "relayor_" a rather long prefix and would prefer "tor_" or "torr_" (short tor relay), because I guess it is unlikely that people will run multiple tor roles.

Note: This change will break existing setups since they will have to update their playbooks.

For this reason we will commit this once we start to require tor v0.2.8.x (see #71 )

@nusenu nusenu added this to the 0.2.0 milestone Aug 22, 2016
@ypid
Copy link
Contributor

ypid commented Aug 22, 2016

Note that DebOps has a procedure in place to do variable renames (ref: Migration/upgrade notes) so this could be semi-automated and users only have to run a command.

About the name, I would not mind so much to keep the variable names to a minimum but that might come from my practice to copy/paste variables from the default file and then modifying them. Also, I would prefer a more descriptive role name which could then also be used for the variables, like nusenu.tor_relay and then using the name space tor_relay__ for the role (the __ comes from DebOps and was introduced to make working with role dependencies visible). Anyway.

If the only reason to not use relayor_ or relayor__ is the length then this might be debatable (we are talking 8-9 against 4-5 characters ("tor_" or "torr_") here) 😄

@nusenu BTW: I like how you handle the release management 😉

@nusenu nusenu removed this from the 0.2.0 milestone Nov 5, 2016
nusenu pushed a commit that referenced this issue Feb 19, 2017
freebsd_somaxconn -> tor_freebsd_somaxconn
freebsd_nmbclusters -> tor_freebsd_nmbclusters
v4tmp -> tor_v4tmp
nusenu pushed a commit that referenced this issue Feb 19, 2017
ipv4_count -> tor_ipv4_count
v6tmp -> tor_v6tmp
nusenu pushed a commit that referenced this issue Feb 19, 2017
family -> tor_family
nusenu pushed a commit that referenced this issue Feb 19, 2017
dupcount -> tor_dupkeycount
currentsomaxconn -> tor_currentsomaxconn
currentnmbc -> tor_currentnmbc
currentlimits -> tor_openbsd_maxfiles
nusenu pushed a commit that referenced this issue Feb 19, 2017
instances -> tor_instances_tmp
masterkeycheck -> tor_masterkeyonline
rsakey -> tor_rsakey_match
ipsinterm -> tor_ipsinterm
@nusenu nusenu added this to the 0.2.0 milestone Feb 19, 2017
@nusenu nusenu closed this as completed Feb 19, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants