annotate modules/python/REFERENCE.md @ 390:df5ad1612af7

Adapt configs to support Ubuntu This is prep for running a VPS on a Mythic Beasts Raspberry Pi * Switch paths where necessary * Add optional modules that only apply on some OSes * Change usernames and groups * Don't do RPM-based stuff in Ubuntu * Switch to using some of the new modules
author IBBoard <dev@ibboard.co.uk>
date Mon, 03 Jan 2022 18:37:16 +0000
parents 66c075c5f54a
children adf6fe9bbc17
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 # Reference
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
2
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
3 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 ## Table of Contents
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
7 ### Classes
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
9 #### Public Classes
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
11 * [`python`](#python): Installs and manages python, python-dev and gunicorn.
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 * [`python::pip::bootstrap`](#pythonpipbootstrap): allow to bootstrap pip when python is managed from other module
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
14 #### Private Classes
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16 * `python::config`: Optionally installs the gunicorn service
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 * `python::install`: Installs core python packages
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 * `python::params`: The python Module default configuration settings.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
20 ### Defined types
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22 * [`python::dotfile`](#pythondotfile): Manages any python dotfiles with a simple config hash.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
23 * [`python::gunicorn`](#pythongunicorn): Manages Gunicorn virtual hosts.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
24 * [`python::pip`](#pythonpip): Installs and manages packages from pip.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 * [`python::pyvenv`](#pythonpyvenv): Create a Python3 virtualenv using pyvenv.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26 * [`python::requirements`](#pythonrequirements): Installs and manages Python packages from requirements file.
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
27
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
28 ### Data types
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
29
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
30 * [`Python::Loglevel`](#pythonloglevel): A version type to match all valid loglevels for python
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
31 * [`Python::Package::Ensure`](#pythonpackageensure): A version type to match all valid package ensures for python
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
32 * [`Python::Provider`](#pythonprovider): A version type to match all valid provider for python
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
33 * [`Python::Umask`](#pythonumask): A version type to match valid umask for python
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
34 * [`Python::Venv::PipVersion`](#pythonvenvpipversion): A version type to ensure a specific Pip version in a virtual env.
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
35 * [`Python::Version`](#pythonversion): A version type to match all valid versions for python
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
36
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
37 ## Classes
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
38
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
39 ### <a name="python"></a>`python`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
40
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
41 Installs and manages python, python-dev and gunicorn.
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
42
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
43 #### Examples
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
44
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
45 ##### install python from system python
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
46
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
47 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
48 class { 'python':
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
49 version => 'system',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
50 pip => 'present',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
51 dev => 'present',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
52 gunicorn => 'present',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
53 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
54 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
55
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
56 ##### install python3 from scl repo
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
57
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
58 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
59 class { 'python' :
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
60 ensure => 'present',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
61 version => 'rh-python36-python',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
62 dev => 'present',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
63 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
64 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
65
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
66 #### Parameters
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
67
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
68 The following parameters are available in the `python` class:
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
69
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
70 * [`ensure`](#ensure)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
71 * [`version`](#version)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
72 * [`pip`](#pip)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
73 * [`dev`](#dev)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
74 * [`gunicorn`](#gunicorn)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
75 * [`manage_gunicorn`](#manage_gunicorn)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
76 * [`provider`](#provider)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
77 * [`use_epel`](#use_epel)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
78 * [`manage_scl`](#manage_scl)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
79 * [`umask`](#umask)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
80 * [`manage_python_package`](#manage_python_package)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
81 * [`manage_pip_package`](#manage_pip_package)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
82 * [`gunicorn_package_name`](#gunicorn_package_name)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
83 * [`python_pips`](#python_pips)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
84 * [`python_pyvenvs`](#python_pyvenvs)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
85 * [`python_requirements`](#python_requirements)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
86 * [`python_dotfiles`](#python_dotfiles)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
87 * [`rhscl_use_public_repository`](#rhscl_use_public_repository)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
88 * [`anaconda_installer_url`](#anaconda_installer_url)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
89 * [`anaconda_install_path`](#anaconda_install_path)
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
90
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
91 ##### <a name="ensure"></a>`ensure`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
92
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
93 Data type: `Python::Package::Ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
94
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
95 Desired installation state for the Python package.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
96
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
97 Default value: `$python::params::ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
98
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
99 ##### <a name="version"></a>`version`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
100
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
101 Data type: `Python::Version`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
102
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
103 Python version to install. Beware that valid values for this differ a) by the provider you choose and b) by the osfamily/operatingsystem you are using.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
104 Allowed values:
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
105 - provider == pip: everything pip allows as a version after the 'python=='
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
106 - else: 'system', 'pypy', 3/3.3/...
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
107 - Be aware that 'system' usually means python 2.X.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
108 - 'pypy' actually lets us use pypy as python.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
109 - 3/3.3/... means you are going to install the python3/python3.3/...
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
110 package, if available on your osfamily.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
111
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
112 Default value: `'3'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
113
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
114 ##### <a name="pip"></a>`pip`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
115
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
116 Data type: `Python::Package::Ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
117
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
118 Desired installation state for the python-pip package.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
119
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
120 Default value: `$python::params::pip`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
121
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
122 ##### <a name="dev"></a>`dev`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
123
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
124 Data type: `Python::Package::Ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
125
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
126 Desired installation state for the python-dev package.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
127
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
128 Default value: `$python::params::dev`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
129
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
130 ##### <a name="gunicorn"></a>`gunicorn`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
131
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
132 Data type: `Python::Package::Ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
133
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
134 Desired installation state for Gunicorn.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
135
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
136 Default value: `$python::params::gunicorn`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
137
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
138 ##### <a name="manage_gunicorn"></a>`manage_gunicorn`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
139
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
140 Data type: `Boolean`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
141
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
142 Allow Installation / Removal of Gunicorn.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
143
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
144 Default value: `$python::params::manage_gunicorn`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
145
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
146 ##### <a name="provider"></a>`provider`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
147
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
148 Data type: `Optional[Python::Provider]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
149
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
150 What provider to use for installation of the packages, except gunicorn and Python itself.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
151
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
152 Default value: `$python::params::provider`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
153
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
154 ##### <a name="use_epel"></a>`use_epel`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
155
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
156 Data type: `Boolean`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
157
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
158 to determine if the epel class is used.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
159
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
160 Default value: `$python::params::use_epel`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
161
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
162 ##### <a name="manage_scl"></a>`manage_scl`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
163
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
164 Data type: `Boolean`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
165
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
166 Whether to manage core SCL packages or not.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
167
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
168 Default value: `$python::params::manage_scl`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
169
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
170 ##### <a name="umask"></a>`umask`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
171
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
172 Data type: `Optional[Python::Umask]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
173
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
174 The default umask for invoked exec calls.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
175
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
176 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
177
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
178 ##### <a name="manage_python_package"></a>`manage_python_package`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
179
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
180 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
181
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
182
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
183
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
184 Default value: `$python::params::manage_python_package`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
185
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
186 ##### <a name="manage_pip_package"></a>`manage_pip_package`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
187
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
188 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
189
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
190
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
191
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
192 Default value: `$python::params::manage_pip_package`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
193
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
194 ##### <a name="gunicorn_package_name"></a>`gunicorn_package_name`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
195
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
196 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
197
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
198
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
199
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
200 Default value: `$python::params::gunicorn_package_name`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
201
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
202 ##### <a name="python_pips"></a>`python_pips`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
203
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
204 Data type: `Hash`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
205
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
206
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
207
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
208 Default value: `{}`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
209
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
210 ##### <a name="python_pyvenvs"></a>`python_pyvenvs`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
211
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
212 Data type: `Hash`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
213
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
214
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
215
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
216 Default value: `{}`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
217
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
218 ##### <a name="python_requirements"></a>`python_requirements`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
219
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
220 Data type: `Hash`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
221
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
222
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
223
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
224 Default value: `{}`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
225
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
226 ##### <a name="python_dotfiles"></a>`python_dotfiles`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
227
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
228 Data type: `Hash`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
229
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
230
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
231
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
232 Default value: `{}`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
233
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
234 ##### <a name="rhscl_use_public_repository"></a>`rhscl_use_public_repository`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
235
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
236 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
237
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
238
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
239
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
240 Default value: `$python::params::rhscl_use_public_repository`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
241
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
242 ##### <a name="anaconda_installer_url"></a>`anaconda_installer_url`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
243
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
244 Data type: `Stdlib::Httpurl`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
245
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
246
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
247
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
248 Default value: `$python::params::anaconda_installer_url`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
249
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
250 ##### <a name="anaconda_install_path"></a>`anaconda_install_path`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
251
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
252 Data type: `Stdlib::Absolutepath`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
253
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
254
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
255
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
256 Default value: `$python::params::anaconda_install_path`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
257
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
258 ### <a name="pythonpipbootstrap"></a>`python::pip::bootstrap`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
259
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
260 allow to bootstrap pip when python is managed from other module
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
261
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
262 #### Examples
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
263
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
264 #####
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
265
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
266 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
267 class { 'python::pip::bootstrap':
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
268 version => 'pip',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
269 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
270 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
271
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
272 #### Parameters
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
273
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
274 The following parameters are available in the `python::pip::bootstrap` class:
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
275
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
276 * [`version`](#version)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
277 * [`manage_python`](#manage_python)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
278 * [`http_proxy`](#http_proxy)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
279 * [`exec_provider`](#exec_provider)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
280
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
281 ##### <a name="version"></a>`version`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
282
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
283 Data type: `Enum['pip', 'pip3']`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
284
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
285 should be pip or pip3
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
286
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
287 Default value: `'pip'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
288
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
289 ##### <a name="manage_python"></a>`manage_python`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
290
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
291 Data type: `Variant[Boolean, String]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
292
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
293 if python module will manage deps
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
294
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
295 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
296
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
297 ##### <a name="http_proxy"></a>`http_proxy`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
298
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
299 Data type: `Optional[Stdlib::HTTPUrl]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
300
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
301 Proxy server to use for outbound connections.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
302
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
303 Default value: ``undef``
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
304
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
305 ##### <a name="exec_provider"></a>`exec_provider`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
306
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
307 Data type: `String[1]`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
308
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
309
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
310
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
311 Default value: `'shell'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
312
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
313 ## Defined types
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
314
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
315 ### <a name="pythondotfile"></a>`python::dotfile`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
316
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
317 Manages any python dotfiles with a simple config hash.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
318
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
319 #### Examples
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
320
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
321 ##### Create a pip config in /var/lib/jenkins/.pip/
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
322
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
323 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
324 python::dotfile { '/var/lib/jenkins/.pip/pip.conf':
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
325 ensure => present,
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
326 owner => 'jenkins',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
327 group => 'jenkins',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
328 config => {
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
329 'global' => {
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
330 'index-url' => 'https://mypypi.acme.com/simple/'
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
331 'extra-index-url' => 'https://pypi.risedev.at/simple/'
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
332 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
333 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
334 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
335 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
336
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
337 #### Parameters
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
338
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
339 The following parameters are available in the `python::dotfile` defined type:
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
340
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
341 * [`ensure`](#ensure)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
342 * [`filename`](#filename)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
343 * [`mode`](#mode)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
344 * [`owner`](#owner)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
345 * [`group`](#group)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
346 * [`config`](#config)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
347
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
348 ##### <a name="ensure"></a>`ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
349
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
350 Data type: `Enum['absent', 'present']`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
351
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
352
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
353
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
354 Default value: `'present'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
355
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
356 ##### <a name="filename"></a>`filename`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
357
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
358 Data type: `Stdlib::Absolutepath`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
359
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
360 Filename.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
361
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
362 Default value: `$title`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
363
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
364 ##### <a name="mode"></a>`mode`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
365
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
366 Data type: `Stdlib::Filemode`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
367
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
368 File mode.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
369
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
370 Default value: `'0644'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
371
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
372 ##### <a name="owner"></a>`owner`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
373
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
374 Data type: `String[1]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
375
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
376 user owner of dotfile
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
377
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
378 Default value: `'root'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
379
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
380 ##### <a name="group"></a>`group`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
381
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
382 Data type: `String[1]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
383
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
384 group owner of dotfile
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
385
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
386 Default value: `'root'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
387
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
388 ##### <a name="config"></a>`config`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
389
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
390 Data type: `Hash`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
391
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
392 Config hash. This will be expanded to an ini-file.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
393
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
394 Default value: `{}`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
395
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
396 ### <a name="pythongunicorn"></a>`python::gunicorn`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
397
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
398 Manages Gunicorn virtual hosts.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
399
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
400 #### Examples
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
401
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
402 ##### run gunicorn on vhost in virtualenv /var/www/project1
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
403
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
404 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
405 python::gunicorn { 'vhost':
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
406 ensure => present,
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
407 virtualenv => '/var/www/project1',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
408 mode => 'wsgi',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
409 dir => '/var/www/project1/current',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
410 bind => 'unix:/tmp/gunicorn.socket',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
411 environment => 'prod',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
412 owner => 'www-data',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
413 group => 'www-data',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
414 appmodule => 'app:app',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
415 osenv => { 'DBHOST' => 'dbserver.example.com' },
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
416 timeout => 30,
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
417 template => 'python/gunicorn.erb',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
418 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
419 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
420
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
421 #### Parameters
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
422
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
423 The following parameters are available in the `python::gunicorn` defined type:
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
424
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
425 * [`ensure`](#ensure)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
426 * [`config_dir`](#config_dir)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
427 * [`manage_config_dir`](#manage_config_dir)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
428 * [`virtualenv`](#virtualenv)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
429 * [`mode`](#mode)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
430 * [`dir`](#dir)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
431 * [`bind`](#bind)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
432 * [`environment`](#environment)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
433 * [`appmodule`](#appmodule)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
434 * [`osenv`](#osenv)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
435 * [`timeout`](#timeout)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
436 * [`template`](#template)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
437 * [`args`](#args)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
438 * [`owner`](#owner)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
439 * [`group`](#group)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
440 * [`workers`](#workers)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
441 * [`access_log_format`](#access_log_format)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
442 * [`accesslog`](#accesslog)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
443 * [`errorlog`](#errorlog)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
444 * [`log_level`](#log_level)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
445
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
446 ##### <a name="ensure"></a>`ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
447
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
448 Data type: `Enum['present', 'absent']`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
449
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
450
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
451
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
452 Default value: `present`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
453
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
454 ##### <a name="config_dir"></a>`config_dir`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
455
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
456 Data type: `Stdlib::Absolutepath`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
457
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
458 Configure the gunicorn config directory path.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
459
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
460 Default value: `'/etc/gunicorn.d'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
461
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
462 ##### <a name="manage_config_dir"></a>`manage_config_dir`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
463
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
464 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
465
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
466 Set if the gunicorn config directory should be created.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
467
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
468 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
469
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
470 ##### <a name="virtualenv"></a>`virtualenv`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
471
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
472 Data type: `Variant[Boolean,Stdlib::Absolutepath]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
473
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
474 Run in virtualenv, specify directory.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
475
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
476 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
477
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
478 ##### <a name="mode"></a>`mode`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
479
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
480 Data type: `Enum['wsgi', 'django']`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
481
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
482 Gunicorn mode.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
483
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
484 Default value: `'wsgi'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
485
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
486 ##### <a name="dir"></a>`dir`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
487
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
488 Data type: `Stdlib::Absolutepath`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
489
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
490 Application directory.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
491
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
492 ##### <a name="bind"></a>`bind`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
493
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
494 Data type: `Variant[String[1],Boolean]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
495
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
496 Bind on: 'HOST', 'HOST:PORT', 'unix:PATH'.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
497 Default: system-wide: unix:/tmp/gunicorn-$name.socket
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
498 virtualenv: unix:${virtualenv}/${name}.socket
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
499
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
500 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
501
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
502 ##### <a name="environment"></a>`environment`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
503
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
504 Data type: `Variant[String[1],Boolean]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
505
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
506 Set ENVIRONMENT variable.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
507
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
508 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
509
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
510 ##### <a name="appmodule"></a>`appmodule`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
511
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
512 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
513
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
514 Set the application module name for gunicorn to load when not using Django.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
515
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
516 Default value: `'app:app'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
517
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
518 ##### <a name="osenv"></a>`osenv`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
519
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
520 Data type: `Variant[Boolean,Hash]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
521
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
522 Allows setting environment variables for the gunicorn service. Accepts a hash of 'key': 'value' pairs.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
523
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
524 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
525
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
526 ##### <a name="timeout"></a>`timeout`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
527
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
528 Data type: `Integer`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
529
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
530 Allows setting the gunicorn idle worker process time before being killed. The unit of time is seconds.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
531
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
532 Default value: `30`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
533
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
534 ##### <a name="template"></a>`template`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
535
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
536 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
537
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
538 Which ERB template to use.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
539
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
540 Default value: `'python/gunicorn.erb'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
541
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
542 ##### <a name="args"></a>`args`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
543
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
544 Data type: `Array`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
545
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
546 Custom arguments to add in gunicorn config file.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
547
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
548 Default value: `[]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
549
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
550 ##### <a name="owner"></a>`owner`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
551
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
552 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
553
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
554
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
555
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
556 Default value: `'www-data'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
557
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
558 ##### <a name="group"></a>`group`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
559
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
560 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
561
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
562
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
563
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
564 Default value: `'www-data'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
565
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
566 ##### <a name="workers"></a>`workers`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
567
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
568 Data type: `Variant[Boolean,Integer]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
569
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
570
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
571
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
572 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
573
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
574 ##### <a name="access_log_format"></a>`access_log_format`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
575
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
576 Data type: `Variant[Boolean,String[1]]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
577
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
578
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
579
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
580 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
581
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
582 ##### <a name="accesslog"></a>`accesslog`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
583
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
584 Data type: `Variant[Boolean,Stdlib::Absolutepath]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
585
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
586
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
587
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
588 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
589
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
590 ##### <a name="errorlog"></a>`errorlog`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
591
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
592 Data type: `Variant[Boolean,Stdlib::Absolutepath]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
593
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
594
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
595
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
596 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
597
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
598 ##### <a name="log_level"></a>`log_level`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
599
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
600 Data type: `Python::Loglevel`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
601
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
602
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
603
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
604 Default value: `'error'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
605
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
606 ### <a name="pythonpip"></a>`python::pip`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
607
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
608 Installs and manages packages from pip.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
609
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
610 #### Examples
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
611
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
612 ##### Install Flask to /var/www/project1 using a proxy
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
613
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
614 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
615 python::pip { 'flask':
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
616 virtualenv => '/var/www/project1',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
617 proxy => 'http://proxy.domain.com:3128',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
618 index => 'http://www.example.com/simple/',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
619 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
620 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
621
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
622 ##### Install cx_Oracle with pip
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
623
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
624 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
625 python::pip { 'cx_Oracle' :
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
626 pkgname => 'cx_Oracle',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
627 ensure => '5.1.2',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
628 virtualenv => '/var/www/project1',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
629 owner => 'appuser',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
630 proxy => 'http://proxy.domain.com:3128',
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
631 environment => ['ORACLE_HOME=/usr/lib/oracle/11.2/client64'],
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
632 install_args => '-e',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
633 timeout => 1800,
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
634 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
635 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
636
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
637 ##### Install Requests with pip3
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
638
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
639 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
640 python::pip { 'requests' :
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
641 ensure => 'present',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
642 pkgname => 'requests',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
643 pip_provider => 'pip3',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
644 virtualenv => '/var/www/project1',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
645 owner => 'root',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
646 timeout => 1800
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
647 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
648 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
649
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
650 #### Parameters
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
651
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
652 The following parameters are available in the `python::pip` defined type:
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
653
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
654 * [`name`](#name)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
655 * [`pkgname`](#pkgname)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
656 * [`ensure`](#ensure)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
657 * [`virtualenv`](#virtualenv)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
658 * [`pip_provider`](#pip_provider)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
659 * [`url`](#url)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
660 * [`owner`](#owner)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
661 * [`group`](#group)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
662 * [`index`](#index)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
663 * [`proxy`](#proxy)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
664 * [`editable`](#editable)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
665 * [`environment`](#environment)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
666 * [`extras`](#extras)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
667 * [`timeout`](#timeout)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
668 * [`install_args`](#install_args)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
669 * [`uninstall_args`](#uninstall_args)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
670 * [`log_dir`](#log_dir)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
671 * [`egg`](#egg)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
672 * [`umask`](#umask)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
673 * [`path`](#path)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
674 * [`exec_provider`](#exec_provider)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
675
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
676 ##### <a name="name"></a>`name`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
677
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
678 must be unique
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
679
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
680 ##### <a name="pkgname"></a>`pkgname`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
681
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
682 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
683
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
684 the name of the package.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
685
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
686 Default value: `$name`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
687
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
688 ##### <a name="ensure"></a>`ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
689
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
690 Data type: `Variant[Enum[present, absent, latest], String[1]]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
691
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
692 Require pip to be available.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
693
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
694 Default value: `present`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
695
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
696 ##### <a name="virtualenv"></a>`virtualenv`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
697
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
698 Data type: `Variant[Enum['system'], Stdlib::Absolutepath]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
699
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
700 virtualenv to run pip in.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
701
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
702 Default value: `'system'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
703
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
704 ##### <a name="pip_provider"></a>`pip_provider`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
705
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
706 Data type: `String[1]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
707
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
708 version of pip you wish to use.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
709
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
710 Default value: `'pip'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
711
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
712 ##### <a name="url"></a>`url`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
713
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
714 Data type: `Variant[Boolean, String]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
715
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
716 URL to install from.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
717
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
718 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
719
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
720 ##### <a name="owner"></a>`owner`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
721
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
722 Data type: `String[1]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
723
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
724 The owner of the virtualenv being manipulated.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
725
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
726 Default value: `'root'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
727
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
728 ##### <a name="group"></a>`group`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
729
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
730 Data type: `Optional[String[1]]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
731
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
732 The group of the virtualenv being manipulated.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
733
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
734 Default value: `getvar('python::params::group')`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
735
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
736 ##### <a name="index"></a>`index`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
737
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
738 Data type: `Variant[Boolean,String[1]]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
739
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
740 Base URL of Python package index.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
741
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
742 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
743
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
744 ##### <a name="proxy"></a>`proxy`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
745
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
746 Data type: `Optional[Stdlib::HTTPUrl]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
747
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
748 Proxy server to use for outbound connections.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
749
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
750 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
751
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
752 ##### <a name="editable"></a>`editable`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
753
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
754 Data type: `Boolean`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
755
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
756 If true the package is installed as an editable resource.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
757
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
758 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
759
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
760 ##### <a name="environment"></a>`environment`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
761
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
762 Data type: `Array`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
763
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
764 Additional environment variables required to install the packages.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
765
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
766 Default value: `[]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
767
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
768 ##### <a name="extras"></a>`extras`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
769
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
770 Data type: `Array`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
771
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
772 Extra features provided by the package which should be installed.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
773
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
774 Default value: `[]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
775
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
776 ##### <a name="timeout"></a>`timeout`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
777
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
778 Data type: `Numeric`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
779
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
780 The maximum time in seconds the "pip install" command should take.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
781
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
782 Default value: `1800`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
783
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
784 ##### <a name="install_args"></a>`install_args`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
785
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
786 Data type: `Optional[String[1]]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
787
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
788 Any additional installation arguments that will be supplied when running pip install.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
789
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
790 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
791
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
792 ##### <a name="uninstall_args"></a>`uninstall_args`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
793
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
794 Data type: `Optional[String[1]]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
795
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
796 Any additional arguments that will be supplied when running pip uninstall.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
797
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
798 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
799
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
800 ##### <a name="log_dir"></a>`log_dir`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
801
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
802 Data type: `String[1]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
803
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
804 Log directory
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
805
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
806 Default value: `'/tmp'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
807
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
808 ##### <a name="egg"></a>`egg`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
809
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
810 Data type: `Any`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
811
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
812 The egg name to use
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
813
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
814 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
815
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
816 ##### <a name="umask"></a>`umask`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
817
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
818 Data type: `Optional[Python::Umask]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
819
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
820
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
821
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
822 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
823
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
824 ##### <a name="path"></a>`path`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
825
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
826 Data type: `Array[String]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
827
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
828
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
829
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
830 Default value: `['/usr/local/bin','/usr/bin','/bin', '/usr/sbin']`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
831
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
832 ##### <a name="exec_provider"></a>`exec_provider`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
833
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
834 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
835
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
836
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
837
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
838 Default value: `'shell'`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
839
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
840 ### <a name="pythonpyvenv"></a>`python::pyvenv`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
841
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
842 Create a Python3 virtualenv using pyvenv.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
843
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
844 #### Examples
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
845
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
846 #####
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
847
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
848 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
849 python::pyvenv { '/var/www/project1' :
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
850 ensure => present,
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
851 version => 'system',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
852 systempkgs => true,
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
853 venv_dir => '/home/appuser/virtualenvs',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
854 owner => 'appuser',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
855 group => 'apps',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
856 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
857 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
858
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
859 #### Parameters
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
860
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
861 The following parameters are available in the `python::pyvenv` defined type:
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
862
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
863 * [`ensure`](#ensure)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
864 * [`version`](#version)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
865 * [`systempkgs`](#systempkgs)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
866 * [`venv_dir`](#venv_dir)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
867 * [`owner`](#owner)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
868 * [`group`](#group)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
869 * [`mode`](#mode)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
870 * [`path`](#path)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
871 * [`environment`](#environment)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
872 * [`pip_version`](#pip_version)
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
873
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
874 ##### <a name="ensure"></a>`ensure`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
875
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
876 Data type: `Python::Package::Ensure`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
877
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
878
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
879
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
880 Default value: `present`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
881
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
882 ##### <a name="version"></a>`version`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
883
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
884 Data type: `Python::Version`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
885
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
886 Python version to use.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
887
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
888 Default value: `'system'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
889
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
890 ##### <a name="systempkgs"></a>`systempkgs`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
891
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
892 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
893
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
894 Copy system site-packages into virtualenv
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
895
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
896 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
897
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
898 ##### <a name="venv_dir"></a>`venv_dir`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
899
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
900 Data type: `Stdlib::Absolutepath`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
901
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
902 Directory to install virtualenv to
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
903
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
904 Default value: `$name`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
905
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
906 ##### <a name="owner"></a>`owner`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
907
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
908 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
909
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
910 The owner of the virtualenv being manipulated
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
911
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
912 Default value: `'root'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
913
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
914 ##### <a name="group"></a>`group`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
915
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
916 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
917
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
918 The group relating to the virtualenv being manipulated
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
919
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
920 Default value: `'root'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
921
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
922 ##### <a name="mode"></a>`mode`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
923
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
924 Data type: `Stdlib::Filemode`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
925
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
926 Optionally specify directory mode
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
927
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
928 Default value: `'0755'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
929
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
930 ##### <a name="path"></a>`path`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
931
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
932 Data type: `Array[Stdlib::Absolutepath]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
933
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
934 Specifies the PATH variable.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
935
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
936 Default value: `['/bin', '/usr/bin', '/usr/sbin', '/usr/local/bin',]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
937
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
938 ##### <a name="environment"></a>`environment`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
939
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
940 Data type: `Array`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
941
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
942 Optionally specify environment variables for pyvenv
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
943
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
944 Default value: `[]`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
945
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
946 ##### <a name="pip_version"></a>`pip_version`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
947
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
948 Data type: `Python::Venv::PipVersion`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
949
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
950
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
951
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
952 Default value: `'latest'`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
953
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
954 ### <a name="pythonrequirements"></a>`python::requirements`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
955
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
956 Installs and manages Python packages from requirements file.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
957
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
958 #### Examples
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
959
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
960 ##### install pip requirements from /var/www/project1/requirements.txt
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
961
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
962 ```puppet
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
963 python::requirements { '/var/www/project1/requirements.txt' :
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
964 virtualenv => '/var/www/project1',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
965 proxy => 'http://proxy.domain.com:3128',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
966 owner => 'appuser',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
967 group => 'apps',
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
968 }
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
969 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
970
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
971 #### Parameters
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
972
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
973 The following parameters are available in the `python::requirements` defined type:
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
974
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
975 * [`requirements`](#requirements)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
976 * [`virtualenv`](#virtualenv)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
977 * [`pip_provider`](#pip_provider)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
978 * [`owner`](#owner)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
979 * [`group`](#group)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
980 * [`proxy`](#proxy)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
981 * [`src`](#src)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
982 * [`environment`](#environment)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
983 * [`forceupdate`](#forceupdate)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
984 * [`cwd`](#cwd)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
985 * [`extra_pip_args`](#extra_pip_args)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
986 * [`manage_requirements`](#manage_requirements)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
987 * [`fix_requirements_owner`](#fix_requirements_owner)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
988 * [`log_dir`](#log_dir)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
989 * [`timeout`](#timeout)
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
990
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
991 ##### <a name="requirements"></a>`requirements`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
992
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
993 Data type: `Stdlib::Absolutepath`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
994
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
995 Path to the requirements file.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
996
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
997 Default value: `$name`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
998
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
999 ##### <a name="virtualenv"></a>`virtualenv`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1000
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1001 Data type: `Variant[Enum['system'],Stdlib::Absolutepath]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1002
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1003 virtualenv to run pip in.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1004
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1005 Default value: `'system'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1006
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1007 ##### <a name="pip_provider"></a>`pip_provider`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1008
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1009 Data type: `Enum['pip', 'pip3']`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1010
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1011 version of pip you wish to use.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1012
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1013 Default value: `'pip'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1014
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1015 ##### <a name="owner"></a>`owner`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1016
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1017 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1018
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1019 The owner of the virtualenv being manipulated.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1020
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1021 Default value: `'root'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1022
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1023 ##### <a name="group"></a>`group`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1024
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1025 Data type: `String[1]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1026
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1027 The group relating to the virtualenv being manipulated.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1028
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1029 Default value: `'root'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1030
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1031 ##### <a name="proxy"></a>`proxy`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1032
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1033 Data type: `Optional[Stdlib::HTTPUrl]`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1034
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1035 Proxy server to use for outbound connections.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1036
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1037 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1038
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1039 ##### <a name="src"></a>`src`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1040
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1041 Data type: `Any`
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1042
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1043 Pip --src parameter to; if the requirements file contains --editable resources, this parameter specifies where they will be installed. See the pip documentation for more.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1044
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1045 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1046
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1047 ##### <a name="environment"></a>`environment`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1048
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1049 Data type: `Array`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1050
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1051 Additional environment variables required to install the packages.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1052
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1053 Default value: `[]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1054
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1055 ##### <a name="forceupdate"></a>`forceupdate`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1056
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1057 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1058
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1059 Run a pip install requirements even if we don't receive an event from the requirements file - Useful for when the requirements file is written as part of a resource other than file (E.g vcsrepo)
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1060
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1061 Default value: ``false``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1062
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1063 ##### <a name="cwd"></a>`cwd`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1064
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1065 Data type: `Optional[Stdlib::Absolutepath]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1066
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1067 The directory from which to run the "pip install" command.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1068
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1069 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1070
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1071 ##### <a name="extra_pip_args"></a>`extra_pip_args`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1072
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1073 Data type: `Optional[String[1]]`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1074
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1075 Extra arguments to pass to pip after the requirements file
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1076
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1077 Default value: ``undef``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1078
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1079 ##### <a name="manage_requirements"></a>`manage_requirements`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1080
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1081 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1082
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1083 Create the requirements file if it doesn't exist.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1084
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1085 Default value: ``true``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1086
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1087 ##### <a name="fix_requirements_owner"></a>`fix_requirements_owner`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1088
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1089 Data type: `Boolean`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1090
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1091 Change owner and group of requirements file.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1092
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1093 Default value: ``true``
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1094
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1095 ##### <a name="log_dir"></a>`log_dir`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1096
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1097 Data type: `Stdlib::Absolutepath`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1098
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1099 Log directory.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1100
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1101 Default value: `'/tmp'`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1102
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1103 ##### <a name="timeout"></a>`timeout`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1104
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1105 Data type: `Integer`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1106
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1107 The maximum time in seconds the "pip install" command should take.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1108
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1109 Default value: `1800`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1110
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1111 ## Data types
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1112
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1113 ### <a name="pythonloglevel"></a>`Python::Loglevel`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1114
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1115 A version type to match all valid loglevels for python
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1116
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1117 Alias of
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1118
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1119 ```puppet
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1120 Enum['debug', 'info', 'warning', 'error', 'critical']
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1121 ```
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1122
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1123 ### <a name="pythonpackageensure"></a>`Python::Package::Ensure`
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1124
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1125 A version type to match all valid package ensures for python
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1126
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1127 Alias of
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1128
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1129 ```puppet
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1130 Enum['absent', 'present', 'latest']
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1131 ```
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1132
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1133 ### <a name="pythonprovider"></a>`Python::Provider`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1134
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1135 A version type to match all valid provider for python
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1136
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1137 Alias of
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1138
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1139 ```puppet
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1140 Enum['pip', 'scl', 'rhscl', 'anaconda', '']
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1141 ```
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1142
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1143 ### <a name="pythonumask"></a>`Python::Umask`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1144
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1145 A version type to match valid umask for python
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1146
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1147 Alias of
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1148
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1149 ```puppet
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1150 Pattern[/[0-7]{1,4}/]
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1151 ```
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1152
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1153 ### <a name="pythonvenvpipversion"></a>`Python::Venv::PipVersion`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1154
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1155 A version type to ensure a specific Pip version in a virtual env.
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1156
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1157 Alias of
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1158
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1159 ```puppet
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1160 Pattern[/^(<|>|<=|>=|==) [0-9]*(\.[0-9]+)*$/, /\Alatest\Z/]
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1161 ```
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1162
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1163 ### <a name="pythonversion"></a>`Python::Version`
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1164
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1165 A version type to match all valid versions for python
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1166
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1167 Alias of
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1168
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1169 ```puppet
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1170 Pattern[/\A(python)?[0-9](\.?[0-9])*/, /\Apypy\Z/, /\Asystem\Z/, /\Arh-python[0-9]{2}(?:-python)?\Z/]
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
1171 ```
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1172