cookbook 'pyload', '= 2.1.0'
pyload (12) Versions 2.1.0 Follow0
Installs/Configures Pyload
cookbook 'pyload', '= 2.1.0', :supermarket
knife supermarket install pyload
knife supermarket download pyload
Pyload Cookbook
This cookbook provides resources for installing and configuring Pyload.
Requirements
Platforms
- Debian / Ubuntu
- RHEL / CentOS / Oracle
- Fedora
- openSUSE / SUSE Linux Enterprises
Chef
Chef 15+
Dependencies
This cookbook has the following dependencies:
Usage
This cookbook provides various resources for installing and configuring your Pyload instance(s), which are best used in your own wrapper cookbook. Specify your own parameters on any of the provided resources, to install one or multiple Pyload instances regarding your needs.
Resource Names
Many of the resources provided in this cookbook need to share configuration values for an instance. Therefore each resource provides a property instance_name
to correctly identify all the resources of a single instance, which must be unique obviously. As an example, the pyload_config
resource needs to know the version of the instance and the download directory created by pyload_install
to correctly configure the instance.
All the resources of this cookbook use the following search order in Chefs run context to locate all the corresponding resources that apply to a unique instance:
1. Resources that share the same resource name
2. Resources that share the same value for property instance_name
3. Resources named either default or pyload (fails if resources with both default or pyload as name exist)
4. Resources with instance_name
set to either default or pyload (fails if resources with both default or pyload as value for instance_name
exist)
In case the instance_name
of any resource is set to a value not a reserved default (default or pyload), the instance name will be appended to the resource properties default values. This is required to avoid conflicts for multi instance configurations. As an example, properties specifying a directory will have their default value automatically changed to a directory with the instance name included (/opt/pyload
-> /opt/pyload_INSTANCE_NAME
).
Notifications
The resources provided in this cookbook do not automatically execute any actions on instance resources when changes have occurred. You must supply your desired notifications for an instance when using resources of this cookbook if you want Chef to automatically restart services. See below for an example how to do this.
Examples
The following example will install a global instance of Pyload using the defaults:
pyload_install 'default' do notifies :restart, 'pyload_service[default]', :delayed end pyload_config 'default' do notifies :restart, 'pyload_service[default]', :delayed end pyload_service 'default' do action [:start, :enable] end
More examples on how this cookbook could be used, can be found at test/fixtures/cookbooks/test
.
Resources
pyload_install
Installs an instance of Pyload regarding configured install method.
Actions
-
install
- Default. Installs an instance of Pyload with configured installed method. -
install_pip
- Installs an instance of Pyload with install methodpip
. This install method requires version to be>= 0.5.0
. -
install_source
- Installs an instance of Pyload with install methodsource
.
Properties
-
instance_name
- Specifies a unique name for the instance to be installed. Reserved default instance names aredefault
andpyload
. This is the name property. -
version
- Specifies the version to be installed. By default, this is set to0.4.20
. -
install_method
- Specifies the install method used to install the instance. Supported methods arepip
andsource
. By default, this is set tosource
. -
install_dir
- Specifies the full path to the install directory. By default, this is set to/opt/pyload
. -
data_dir
- Specifies the full path to the data directory. By default, this is set to/var/lib/pyload
. -
log_dir
- Specifies the full path to the logging directory. By default, this is set to/var/log/pyload
. -
download_dir
- Specifies the full path to the download directory. By default, this is set to/tmp/downloads
. -
tmp_dir
- Specifies the full path to the temp directory. By default, this is set to/tmp/pyload
. -
user
- Specifies the user to run the instance. By default, this is set topyload
. -
group
- Specifies the group to run the instance. By default, this is set topyload
. -
source_path
- Specifies the full path to the distribution source. If the file does not exist, it will be downloaded fromsource_url
. Only used if install method is set tosource
. By default, this depends on specified version. -
source_url
- Specifies the download URL to the distribution source. Only used if install method is set tosource
. By default, this depends on specified version. -
source_checksum
- Specifies a checksum for the distribution source downloaded fromsource_url
. Only used if install method is set tosource
. This must be a valid SHA256 hash. By default, this depends on specified version. -
create_user
- Specifies if the user should be created. By default, this is set totrue
. -
create_group
- Specifies if the group should be created. By default, this is set totrue
. -
create_download_dir
- Specifies if the download directory should be created. By default, this is set totrue
. -
create_symlink
- Specifies if a symbolic link should be created frominstall_dir
to latest version. By default, this is set totrue
.
Examples
Installs an Pyload 0.4.20 instance named with reserved default instance name default. The instance is installed to default directories using instance method source
. It will be created at /opt/pyload-0.4.20
with a symbolic link at /opt/pyload
. All directories will owned by user pyload
and group pyload
.
pyload_install 'default' do version '0.4.20' end
Installs an Pyload 0.4.20 instance named helloworld. The instance is installed to default directories using instance method source
. It will be created at /opt/pyload_helloworld-0.4.20
with a symbolic link at /opt/pyload_helloworld
. All directories will owned by user pyload_helloworld
and group pyload_helloworld
.
pyload_install 'helloworld' do version '0.4.20' end
pyload_config
Configures an instance of Pyload. Not all properties available to this resource apply to all versions of a configuration file. Some required properties, such as the instance version, are determined by the corresponding pyload_install
resource of this instance.
Actions
-
create
- Default. Configures an instance of Pyload regarding its version.
Properties
-
instance_name
- Specifies a unique name for the instance to be configured. Reserved default instance names aredefault
andpyload
. This is the name property. -
source
- Specifies the config file template source. By default, this depends on the instance version. -
cookbook
- Specifies the cookbook from which to load the config file source. By default, this is set topyload
. -
auto_login
- Specifies if login should be skipped if single user. By default, this is set tofalse
. -
basic_auth
- Specifies if basic authentication should be enabled for web interface. By default, this is set tofalse
. -
change_downloads
- Specifies if owner and group of downloaded files should be changed. By default, this is set tofalse
. -
change_file
- Specifies if mode of downloaded files should be changed. By default, this is set tofalse
. -
change_group
- Specifies if group of running process should be changed. By default, this is set tofalse
. -
change_user
- Specifies if user of running process should be changed. By default, this is set tofalse
. -
checksums
- Specifies if checksums should be checked. By default, this is set tofalse
. -
chunks
- Specifies the maximum connections for one download. By default, this is set to3
. -
console
- Specifies if logging to console should be enabled. By default, this is set totrue
. -
console_color
- Specifies if console log should be colored if logging to console is enabled. By default, this is set tofalse
. -
debug_level
- Specifies the debug level. Must be one ofdebug
,trace
orstack
. By default, this is set totrace
. -
debug_mode
- Specifies if debug mode should be enabled. By default, this is set tofalse
. -
development_mode
- Specifies if web interface development mode should be enabled. By default, this is set tofalse
. -
end_time
- Specifies the time downloads should be stopped automatically. By default, this is set to0:00
. -
file_mode
- Specifies the mode for created files. By default, this is set to0644
. -
folder_mode
- Specifies the mode for created folders. By default, this is set to0755
. -
folder_per_package
- Specifies if a folder for each downloaded package should be created. By default, this is set totrue
. -
interface
- Specifies the download interface to bind to. -
ipv6
- Specifies if IPv6 should be enabled. By default, this is set tofalse
. -
language
- Specifies the language. Must be one ofen
,de
,fr
,it
,es
,el_GR
,nl
,sv
,ru
,pl
,cs
,sr
orpt_BR
for config version 1 anden
for config version 2. By default, this is set toen
. -
limit_speed
- Specifies if download speed should be limited to maximum download speed. By default, this is set tofalse
. -
listen_address
- Specifies the listen address for the web interface. By default, this is set to0.0.0.0
. -
log
- Specifies if logging to files should be enabled. By default, this is set totrue
. -
log_entries
- Specifies the maximum amount of log files to keep if logging to files is enabled. By default, this is set to10
. -
log_rotate
- Specifies if log files should be rotated if logging to files is enabled. By default, this is set totrue
. -
log_size
- Specifies the maximum size of file log before the log file is rotated in KB if logging to files is enabled. By default, this is set to100
. -
max_downloads
- Specifies the maximum parallel downloads. By default, this is set to3
. -
max_speed
- Specifies the maximum download speed in KB/s. By default, this is set to-1
. -
min_free_space
- Specifies the minimum free space at download directory in MB. By default, this is set to1024
. -
port
- Specifies the port the web interface should listen on. By default, this is set to8000
. -
prefix
- Specifies the web interface path prefix. -
proxy
- Specifies if a proxy should be used. By default, this is set tofalse
. -
proxy_host
- Specifies the proxy host address if proxy port should be used. By default, this is set tolocalhost
. -
proxy_password
- Specifies the password for proxy authentication if proxy should be used. -
proxy_port
- Specifies the proxy port if proxy should be used. By default, this is set to7070
. -
proxy_protocol
- Specifies the proxy protocol if proxy should be used. Must be one ofhttp
,socks4
orsocks5
. By default, this is set tohttp
. -
proxy_username
- Specifies the username for proxy authentication if proxy should be used. -
reconnect
- Specifies if reconnect should be enabled. By default, this is set tofalse
. -
reconnect_end_time
- Specifies the reconnect end time if reconnect is enabled. By default, this is set to0:00
. -
reconnect_method
- Specifies the reconnect method if reconnect is enabled. Applies only to config version 1. -
reconnect_script
- Specifies the reconnect script if reconnect is enabled. Applies only to config version 2. -
reconnect_start_time
- Specifies the reconnect start time if reconnect is enabled. By default, this is set to0:00
. -
remote
- Specifies if remote interface should be enabled. By default, this is set tofalse
. -
remote_listen_address
- Specifies the listen address for the remote interface if remote is enabled. By default, this is set to0.0.0.0
. -
remote_no_local_auth
- Specifies if local connections require authentication if remote is enabled. By default, this is set totrue
. -
remote_port
- Specifies the port the remote interface should listen on if remote is enabled. By default, this is set to7227
. -
renice
- Specifies the CPU priority. By default, this is set to0
. -
server_type
- Specifies the server type of the web interface. Must be one ofbuiltin
,threaded
,fastcgi
orlightweight
. By default, this is set tobuiltin
. -
session_lifetime
- Specifies the session lifetime in web interface. The value specifies minutes. By default, this is set to44640
. -
skip_existing
- Specifies if files previously downloaded should be skipped. By default, this is set tofalse
. -
ssl
- Specifies if web interface should be served via SSL/TLS. By default, this is set tofalse
. -
ssl_cert
- Specifies the SSL/TLS certificate. -
ssl_chain
- Specifies the SSL/TLS certificate chain. -
ssl_key
- Specifies the SSL/TLS certificate key. -
start_time
- Specifies the time downloads should be started automatically. By default, this is set to0:00
. -
syslog
- Specifies if logging to syslog should be enabled. By default, this is set tofalse
. -
syslog_dir
- Specifies the syslog folder to log to if syslog is enabled. Applies only to config version 2. -
syslog_host
- Specifies the syslog host address if syslog is enabled. By default, this is set tolocalhost
. -
syslog_location
- Specifies the syslog location if syslog is enabled. ust be one oflocal
orremote
. By default, this is set tolocale
. -
syslog_port
- Specifies the syslog host port if syslog is enabled. By default, this is set to514
. -
theme
- Specifies the theme of the web interface. Must be one ofclassic
,pyplex
ormodern
for version 1 andDefault
orPyPlex
for version 2. By default, this is set toclassic
for config version 1 andDefault
for config version 2. -
web
- Specifies if web interface should be enabled. By default, this is set totrue
.
Examples
Configures an Pyload 0.4.20 instance named with reserved default instance name default with config version 1. The corresponding resources from this cookbook for this instance with name default, e.g. pyload_install[default]
, will be used for configuration. The config file for this instance will be created in data directory at /var/lib/pyload
and configures classic theme.
pyload_config 'default' do theme 'classic' end
Configures an Pyload 0.4.20 instance named helloworld with config version 1. The corresponding resources from this cookbook for this instance with name helloworld, e.g. pyload_install[helloworld]
, will be used for configuration. The config file for this instance will be created in data directory at /var/lib/pyload_helloworld
and configures modern theme.
pyload_config 'helloworld' do theme 'modern' end
pyload_service
Creates a service configuration for an instance of Pyload to run using the appropriate init system. Some required properties, such as the instance version, are determined by the corresponding pyload_install
resource of this instance.
Actions
-
start
- Default. Starts the instance of Pyload. -
stop
- Stops the instance of Pyload. -
enable
- Enables the instance of Pyload. -
disable
- Disables the instance of Pyload. -
restart
- Restarts the instance of Pyload. -
create
- Creates configuration file for the appropriate init system for the instance of Pyload. Automatically called by actionsstart
andenable
.
Properties
-
instance_name
- Specifies a unique name for the instance service configuration to be created. Reserved default instance names aredefault
andpyload
. This is the name property. -
service_name
- Specifies the service name. By default, this is set topyload
. -
env_vars
- Specifies a hash of environment variables to be applied. By default, this is set to an empty hash. -
kill_signal
- Specifies the kill signal used to stop a running service. By default, this is set toSIGINT
. -
restart_policy
- Specifies the restart policy of a service. By default, this is set toalways
.
Examples
Creates a service configuration for an Pyload 0.4.20 instance named with reserved default instance name default. The corresponding resources from this cookbook for this instance with name default, e.g. pyload_install[default]
, will be used during creation of the service configuration. The service configuration will be created with a restart policy that restarts the service on abort.
pyload_service 'default' do restart_policy 'on-abort' end
Creates a service configuration for an Pyload 0.4.20 instance named helloworld. The corresponding resources from this cookbook for this instance with name helloworld, e.g. pyload_install[helloworld]
, will be used during creation of the service configuration. The service configuration will be created with a restart policy that restarts the service on abort.
pyload_service 'helloworld' do restart_policy 'on-abort' end
License
- Author: Dominik Jessich (dominik.jessich@gmail.com)
- Copyright: 2016-2021, Dominik Jessich
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
yum-epel >= 3.3.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
2.1.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
2.1.0 passed this metric
Foodcritic Metric
2.1.0 passed this metric
No Binaries Metric
2.1.0 passed this metric
Testing File Metric
2.1.0 passed this metric
Version Tag Metric
2.1.0 passed this metric
2.1.0 failed this metric
2.1.0 passed this metric
Foodcritic Metric
2.1.0 passed this metric
No Binaries Metric
2.1.0 passed this metric
Testing File Metric
2.1.0 passed this metric
Version Tag Metric
2.1.0 passed this metric
2.1.0 passed this metric
2.1.0 passed this metric
Testing File Metric
2.1.0 passed this metric
Version Tag Metric
2.1.0 passed this metric
2.1.0 passed this metric
2.1.0 passed this metric