manage_pip_packages/README.md

45 lines
1.5 KiB
Markdown
Raw Normal View History

Manage pip packages
2023-03-14 22:23:33 +00:00
=========
> This repository is only a mirror. Development and testing is done on a private gitlab server.
2023-03-14 22:01:45 +00:00
This role enables you to manage python packages on debian-based distributions. It can be used on its own , or be called by other roles the install/remove packages on demand.
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
Requirements
------------
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
None.
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
Role Variables
--------------
Available variables are listed below, along with default values. A sample file for the default values is available in `default/hashicorp_consul.yml.sample` in case you need it for any `group_vars` or `host_vars` configuration.
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
```yaml
hashi_consul_install: true # by default, set to true
2023-03-14 22:01:45 +00:00
```
2023-03-14 22:23:33 +00:00
This variable defines if the consul package is to be installed or not before configuring. If you install consul using another task, you can set this to `false`.
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
Dependencies
------------
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
This role requires both `ednxzu.manage_repositories` and `ednxzu.manage_apt_packages` to install consul. If you already installed consul, you can set `hashi_consul_install` to `false`, and that'll remove the dependencies.
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
Example Playbook
----------------
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
```yaml
# calling the role inside a playbook with either the default or group_vars/host_vars
- hosts: servers
roles:
- ednxzu.manage_pip_packages
2023-03-14 22:23:33 +00:00
```
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
License
-------
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
MIT / BSD
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
Author Information
------------------
2023-03-14 22:01:45 +00:00
2023-03-14 22:23:33 +00:00
This role was created by Bertrand Lanson in 2023.