Document setting PYTHONHTTPSVERIFY to 0 for disabling SSL validation in the jenkins_job module

[gustavomcarmo]

SUMMARY

Once the jenkins_job module does not have the validate_certs parameter to set to false for disabling the validation of an eventual self-signed certificate of the Jenkins instance, please document that as a workaround the environment variable PYTHONHTTPSVERIFY can be set to 0 so the behaviour of the task will be the same.

- name: Config the job
  jenkins_job:
    config: "{{ lookup('file', 'job-config.xml') }}"
    name: myjob
    url: "{{ url }}"
    user: "{{ username }}"
    password: "{{ password }}"
  environment:
    PYTHONHTTPSVERIFY: 0

ISSUE TYPE

• Documentation Report

COMPONENT NAME

jenkins_job

ANSIBLE VERSION

ansible 2.9.6
  config file = None
  configured module search path = ['/home/gustavomcarmo/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/gustavomcarmo/.local/lib/python3.6/site-packages/ansible
  executable location = /home/gustavomcarmo/.local/bin/ansible
  python version = 3.6.9 (default, Nov  7 2019, 10:44:02) [GCC 8.3.0]

[ansibullbot]

Files identified in the description:

• plugins/modules/web_infrastructure/jenkins_job.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibullbot]

cc @nerzhul @sermilrod
click here for bot help

[russoz]

@gustavomcarmo Wouldn't it make more sense to implement the validate_certs parameter in the jenkins_job module ?

[russoz]

... and then I did my homework and I saw this is not as trivial as expected. I do have a suggestion: instead of documenting how to work around that, why not add a validate_certs parameter on the module interface and hide the implementation from the user?

And speaking of implementation, I have seen this piece https://bugs.launchpad.net/python-jenkins/+bug/1677041/comments/7 about PYTHONHTTPSVERIFY, but I have also seen this other one: https://stackoverflow.com/questions/41701396/python-jenkinsapi-ignore-certificate#comment95651601_41701718 that looks interesting, if it works.

Any of these options may be implemented behind a validate_certs parameter. What do you think?

[gustavomcarmo]

Hi @russoz I agree with you :)

[russoz]

Beleza! =)

I got a couple of other issues I am planning to work with first, as soon as I move past those, I will be taking on this one.

[russoz]

@gustavomcarmo could you please validate that the PR #1977 works?