docs icon indicating copy to clipboard operation
docs copied to clipboard

Review pages where ansible_ssh_user is still in use

Open AnBuKu opened this issue 9 years ago • 20 comments

Since Ansible 2.0 and higher where ansible_ssh_user is deprecated and replaced by ansible_user [tallandtree_]

Search: https://docs.debops.org/en/latest/search.html?q=ansible_ssh_user&check_keywords=yes&area=default

AnBuKu avatar Dec 19 '16 20:12 AnBuKu

Should I re-work the pages one by one? I'll happily do it, up to you :-)

AnBuKu avatar Jul 22 '17 14:07 AnBuKu

I added the substitution to debops-optimize so this fix will propagate over time. You can rework roles if you like. Ideally you can ask which roles would be suitable. Maybe checkout debops.atd if you like. That one should be easy.

ypid avatar Jul 22 '17 15:07 ypid

Did this one right now: https://github.com/debops/ansible-atd/pull/9

How do I ask? @ypid makes me a list and work on that or I follow this: Search: https://docs.debops.org/en/latest/search.html?q=ansible_ssh_user&check_keywords=yes&area=default

AnBuKu avatar Jul 22 '17 15:07 AnBuKu

https://docs.debops.org/en/latest/search.html?q=ansible_ssh_user&check_keywords=yes&area=default should be ok for this case when you only want to update the variable. I am just not sure if the DebOps Developers could not do this more conveniently when reworking roles anyway. Ideally you would search for all occurances of ansible_ssh_user (not just in the docs, but also in the actual code).

ypid avatar Jul 22 '17 15:07 ypid

OK, I'll go for your proposal, docs and code + min_ansible_version: '1.9.0' -> min_ansible_version: '2.0' + if needed - name: Debian versions: - wheezy - jessie add - stretch. - Or do I forget about stretch for the moment?

AnBuKu avatar Jul 22 '17 15:07 AnBuKu

When you have tested that the role actually works with stretch why not. I would not just add it just for the sake of it :)

ypid avatar Jul 22 '17 15:07 ypid

True, so I'll leave it in the future (one is already done without testing on stretch) without stretch.

AnBuKu avatar Jul 22 '17 15:07 AnBuKu

@ypid Please, feel free to update/change. If you agree I start to work off the bullet list below.

Next, after debops/ansible-atd are (change to ansible_user and/or to version `2.0.0 as a consequence):

debops/ansible-role-ansible

  • https://github.com/debops/ansible-role-ansible/blob/master/defaults/main.yml - PR done
  • https://github.com/debops/ansible-role-ansible/blob/master/README.md - PR done
  • https://github.com/debops/ansible-role-ansible/blob/master/meta/main.yml - PR done

debops/ansible-bootstrap

  • https://github.com/debops/ansible-bootstrap/blob/master/defaults/main.yml - PR done
  • https://github.com/debops/ansible-bootstrap/blob/master/docs/introduction.rst - PR done

debops/ansible-debops

  • https://github.com/debops/ansible-debops/blob/master/defaults/main.yml - PR done
  • https://github.com/debops/ansible-debops/blob/master/README.md - PR done
  • https://github.com/debops/ansible-debops/blob/master/docs/introduction.rst - PR done
  • https://github.com/debops/ansible-debops/blob/master/meta/main.yml - PR done

debops/ansible-kvm - Deprecated role

  • https://github.com/debops/ansible-kvm/blob/master/defaults/main.yml - No change/PR as role is deprecated.
  • https://github.com/debops/ansible-kvm/blob/master/README.md - No change/PR as role is deprecated.
  • https://github.com/debops/ansible-kvm/blob/master/meta/main.yml - No change/PR as role is deprecated.

debops/ansible-librenms

  • https://github.com/debops/ansible-librenms/blob/master/docs/getting-started.rst - PR done

debops/ansible-libvirtd

  • https://github.com/debops/ansible-libvirtd/blob/master/defaults/main.yml - PR done

debops/ansible-openvz

  • https://github.com/debops/ansible-openvz/blob/master/defaults/main.yml - PR done
  • https://github.com/debops/ansible-openvz/blob/master/README.md - PR done
  • https://github.com/debops/ansible-openvz/blob/master/meta/main.yml - PR done

debops/ansible-preseed

  • https://github.com/debops/ansible-preseed/blob/master/defaults/main.yml
  • https://github.com/debops/ansible-preseed/blob/master/README.md
  • https://github.com/debops/ansible-preseed/blob/master/docs/introduction.rst
  • https://github.com/debops/ansible-preseed/blob/master/docs/getting-started.rst
  • https://github.com/debops/ansible-preseed/blob/master/meta/main.yml

debops/ansible-smstools

  • https://github.com/debops/ansible-smstools/blob/master/defaults/main.yml
  • https://github.com/debops/ansible-smstools/blob/master/README.md
  • https://github.com/debops/ansible-smstools/blob/master/meta/main.yml

AnBuKu avatar Jul 22 '17 21:07 AnBuKu

Looks good to me. But keep in mind that you can automate most of the work when you want to get a little fancy :) Still some changelog stuff and other things might have to be done manually. I thought for a sec that we deprecated debops.openvz already but seems it it still supported so go for it :)

ypid avatar Jul 22 '17 21:07 ypid

I'm pretty sure you as a hacker/coder can automate this replacement work. :-) - But not me as Joe Average or a simple supporter. I would spend much more time for automation, than update 25 files. :-(

debops.openvz is one of 20 roles with status tag build failing of actual 122 DebOps roles. In this status table there is no role with status deprecated, maybe as there is no column with status active or deprecated.

AnBuKu avatar Jul 22 '17 22:07 AnBuKu

All right.

In this status table there is no role with status deprecated,

Deprecated disappear from the status page currently. I think there is an issue for status field. It has been requested a number of times but I am not really convinced :)

ypid avatar Jul 22 '17 22:07 ypid

Maybe at the end of the status page, there could be a section Deprecated roles? As well, the tag Deprecated role would need to be applied in GitHub and in docs.debops.org, short: At any place related to the deprecated role, so DebOps users see clearly without searching, that the role is deprecated

Anyhow, for the moment being, I'm not aware of any deprecated role in DebOps.

AnBuKu avatar Jul 22 '17 22:07 AnBuKu

Lets just say I am not convinced that this should be on my todo right now :)

There are some. grep over all roles helps.

ypid avatar Jul 23 '17 07:07 ypid

Don't worry, I don't wanna convince you of anything :)

Then following your grep over all roles there are so far two deprecated roles (maybe more?)

Still listed in the DebOps status page. Both roles with Warning, this is a deprecated role It has been superseded by blabla. - So far fine and correct.

What's for me a bit uncool, is the statement at the beginning of the status page:

There are 122 roles in the DebOps project.

What is somehow not true, as two of the 122 are deprecated.

And as a newbie to DebOps, clicking by chance on the debops/ansible-mysql and then reading the warning, you feel very likely somehow mucked.

AnBuKu avatar Jul 23 '17 12:07 AnBuKu

@drybjed I guess those roles should be removed from debops/docs?

ypid avatar Jul 23 '17 13:07 ypid

Or at least removed from the status page; as long there is no column (Deprecated y/n) or section "Deprecated roles" at the end of the status page. The latter, at the end of the page, I would prefer, as it doesn't blow up the role table.

Both might make sense, as documentation of such circumstances might be asked by Best Practice Badge of CII. But I'm not sure about that.

AnBuKu avatar Jul 23 '17 13:07 AnBuKu

Removing from debops/docs will also remove them from the status page.

ypid avatar Jul 23 '17 17:07 ypid

Hmmm... what is your suggestion then?

I mean, above you asked (and I supported)

I guess those roles should be removed from debops/docs?

AnBuKu avatar Jul 23 '17 20:07 AnBuKu

Hmmm... what is your suggestion then?

Removing from both for now. They can still be found on GitHub.

ypid avatar Jul 23 '17 21:07 ypid

If we do so, I suggest to open an issue "Status page / Deprecated rolls" in github debops/docs as a reminder. Including layout of (far in the) future "status page".

Status page | |__Active | |__Core rolls | |__Community packages | |__Deprecated

AnBuKu avatar Jul 24 '17 04:07 AnBuKu