OpenStack-Ansible pip install

This role will install pip using the upstream pip installation script. Within the installation of pip the role will create a .pip directory within the deploying user’s home folder and a blank selfcheck JSON file for pip to use to keep track of versions.

It can also configure pip links that will restrict the package sources to the OpenStack-Ansible repository.

To clone or view the source code for this repository, visit the role repository for pip_install.

Default variables

# Set the package install state for distribution packages
# Options are 'present' and 'latest'
pip_install_package_state: "latest"

## Path to pip download/installation script.
pip_upstream_url: https://bootstrap.pypa.io/3.3/get-pip.py
pip_fallback_url: https://raw.githubusercontent.com/pypa/get-pip/master/3.3/get-pip.py

# Allow the deployer to force pip to download locally to the deployment host
# and copy it to the remote container for installation. Useful for environments
# where the containers lack internet access.
pip_offline_install: false
pip_tmp_packages: /tmp/pip_install

# Additional options that you might want to pass to "get-pip.py" when installing pip.
# Default `pip_get_pip_options` is an empty string.
pip_get_pip_options: ""
pip_source_install_options: ""

# The URL/path of a constraints file to use when installing the additional pip packages.
#pip_install_upper_constraints: "https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt"

pip_install_distro_packages: "{{ pip_install_build_packages | ternary(pip_install_distro_build_packages, []) }}"
pip_install_remove_distro_packages: []
pip_install_distro_build_packages: []

# Some pip installations require the system to have a compiler present
# Toggling this will install a compiler and python-dev libraries to the host
pip_install_build_packages: yes

# This list var can be used to specify specific versions of pip, setuptools,
# wheel and any other packages which must be installed when pip installs.
pip_packages:
  - pip
  - setuptools
  - wheel

## APT Cache options
cache_timeout: 600

# Validate Certificates when downloading pip. May be set to "no" when proxy server
# is intercepting the certificates.
pip_validate_certs: "yes"

# Boolean variable to set whether the role should
# install pip if it is found to be missing. There
# are times when you may just want to only configure
# pip, instead of also installing it.
pip_install: true

# Boolean variable to set whether pip.conf should be
# implemented to adjust pip's default behaviour.
# By default we do this, but sometimes we want to
# just let the default pip.conf on the system or
# pip's default settings do their thing.
pip_configure: true

# Options for pip global
pip_disable_version_check: true
pip_enable_pre_releases: true
pip_timeout: 120

# Options for pip install
pip_upgrade: true
pip_upgrade_strategy: "only-if-needed"

# Default index for pip to use
pip_default_index: https://pypi.python.org/simple

# Drop link files for additional places to source wheels from
# Example:
#   pip_links:
#     - name: "openstack_release"
#       link: "{{ openstack_repo_url }}/os-releases/{{ openstack_release }}/"
pip_links: []

## Tunable overrides
pip_global_conf_overrides: {}

## Additional options to pass to pip
# Example:
#   pip_install_options: "--cert /etc/ssl/certs/ca-certificates.crt"
#
# See the documentationat https://pip.pypa.io/en/stable/reference/pip
# for details.
pip_install_options: ""

# Always force getting the latest get-pip script
pip_get_pip_force: yes

Required variables

None

Example playbook

---
- name: Install and configure pip
  hosts: all
  user: root
  roles:
    - role: "pip_install"