Skip to content
Snippets Groups Projects
Verified Commit ae2f8b7e authored by Chris Croome's avatar Chris Croome
Browse files

Documentation updates

parent a669eeb1
No related branches found
Tags 3.4.0
No related merge requests found
Pipeline #31170 passed
......@@ -25,7 +25,7 @@ This role has two required boolean variables, [php](#php) and [php_fpm_pool_chec
### php
The `php` variable is required to be defined, by default it is `true`, when it is `false` all tasks in this role will be skipped.
The `php` variable is required to be defined, by default it is `false`, when it is `true` all tasks in this role will be run.
### php_check_legacy_variables
......
......@@ -9,23 +9,29 @@ The main entry point for the PHP role.
|Option|Description|Type|Required|
|---|---|---|---|
| php | Run the tasks in this role. | bool | yes |
| php_ansible_managed | The ansible_managed string. | str | yes |
| php_check_legacy_variables | Check that legacy variables and not defined. | bool | no |
| php_conf_dirs_absent | A generated list of PHP configuration directories to remove if present. | list of 'str' | no |
| php_conf_dirs_present | A generated list of PHP configuration directories to create if absent. | list of 'str' | no |
| php_conf_files_absent | A generated list of PHP configuration files to remove if present. | list of 'str' | no |
| php_conf_files_edited | A generated list of PHP configuration files to edit if present. | list of 'str' | no |
| php_conf_files_present | a generated list of php configuration files to edit if present or template if absent. | list of 'str' | no |
| php_conf_files_templated | a generated list of php configuration files to template. | list of 'str' | no |
| php_conf_files_present | A generated list of php configuration files to edit if present or template if absent. | list of 'str' | no |
| php_conf_files_not_absent | A generated list of php configuration files that are not absent. | list of 'str' | no |
| php_conf_files_templated | A generated list of php configuration files to template. | list of 'str' | no |
| php_conf_not_absent | A generated list of php configuration that is not absent. | list of 'str' | no |
| php_conf_pool_files_not_absent | A generated list of php pool files that are not absent. | list of 'str' | no |
| php_conf_ver_absent | a generated list of versions of php configuration to remove if present. | list of 'str' | no |
| php_conf_ver_present | a generated list of versions of php configuration that should be present. | list of 'str' | no |
| php_config | Optional PHP configuration. | list of dicts of 'php_config' options | no |
| php_debian_bullseye_pkg | A list of Debian Bullseye packages to install. | list of 'str' | no |
| php_debian_buster_pkg | A list of Debian Buster packages to install. | list of 'str' | no |
| php_debian_bookworm_pkg | A list of Debian Bookworm packages to install. | list of 'str' | no |
| php_conf_file_paths_jmespath_query | A internale JMESPath query string. | str | yes |
| php_file_path_separator | The file path seperator to use. | str | yes |
| php_fpm_package | Loop variables for a PHP-FPM package. | str | no |
| php_fpm_packages_present | A generated list of PHP-FPM packages present. | list of 'str' | no |
| php_fpm_pool_check_fail | Fail when duplicated PHP-FPM pool names are found. | bool | yes |
| php_fpm_pools | A generated list of FPM pool names and socket paths. | list of dicts of 'php_fpm_pools' options | no |
| php_fpm_version | Loop variables for a PHP-FPM version. | str | no |
| php_fpm_versions_present | A generated list of PHP-FPM versions present. | list of 'str' | no |
| php_gpg_checksum | The SHA256 checksum for packages.sury.org/php/apt.gpg. | str | yes |
......@@ -36,6 +42,7 @@ The main entry point for the PHP role.
| php_modules | An optional list of PHP versions that require module configuration. | list of dicts of 'php_modules' options | no |
| php_pkg_absent | A generated list of PHP packages which should be absent. | list of 'str' | no |
| php_pkg_present | A generated list of PHP packages which should be present. | list of 'str' | no |
| php_pool_names_not_absent | A generated list of PHP-FPM pool names that are not absent. | list of 'str' | no |
| php_sury | Configure the Sury PHP deb package repo. | bool | no |
| php_ver | A PHP version loop variable, only used internally by this role. | str | no |
| php_ver_absent | A generated list of PHP versions which should be absent. | list of 'str' | no |
......@@ -59,7 +66,12 @@ The main entry point for the PHP role.
| conf | A optional YAML dictionary representing the sections, variables and values of a PHP configuration file. | dict | no |
| name | A optional name for the PHP configuration file. | str | no |
| path | The path of the PHP configuration file. | str | yes |
| state | The state of the PHP configuration file. | str | yes |### Options for main > php_modules
| state | The state of the PHP configuration file. | str | yes |### Options for main > php_fpm_pools
|Option|Description|Type|Required|
|---|---|---|---|
| name | The PHP version. | str | yes |
| pools | A list of PHP-FPM pool socket paths for the PHP version. | list of 'str' | no |### Options for main > php_modules
|Option|Description|Type|Required|
|---|---|---|---|
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment