taiga
Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- ,
Tasks:
- project_change_slug
- user_change_fullname
- user_disable
- user_list
- version
Start using this module
Add this module to your Puppetfile:
mod 'opuscodium-taiga', '4.0.1'
Learn more about managing modules with a PuppetfileDocumentation
taiga
Table of Contents
Module description
Taiga is a project management platform. This Puppet module simplifies the installation and configuration of Taiga in your infrastructure.
Usage
Installing a basic HTTP Taiga instance
In order to install taiga-back
, taiga-front
and an apache virtual host, the following is enough:
class { 'taiga':
hostname => 'taiga.io',
protocol => 'http',
back_secret_key => 'secret',
back_db_password => 'secret', # currently unused
}
Installing a secured HTTPS Taiga instance
class { 'taiga':
hostname => 'taiga.io',
back_secret_key => 'secret',
back_db_password => 'secret', # currently unused
ssl_key => '/path/to/key.pem',
ssl_cert => '/path/to/certificate.pem',
ssl_chain => '/path/to/ca/chain.pem',
}
Choosing which version to install
By default, the module will install the latest stable release and will not auto-update it. If you prefer to install a given release, you can do the following:
class { 'taiga':
# [...]
repo_revision => '2.1.0',
}
If you want to track the stable branch and install update as the stable branch is updated:
class { 'taiga':
# [...]
repo_ensure => 'latest',
repo_revision => 'stable',
}
If you like the danger:
class { 'taiga':
# [...]
repo_ensure => 'latest',
repo_revision => 'main',
}
Advanced configuration
Instead of using the taiga
class, rely on the taiga::front
and taiga::back
classes. This allows you to have a full controll on both the front and the back, and run for example the back on a node, and servce the front from another.
Reference
Table of Contents
Classes
Public Classes
taiga
: Install both Taiga front, back and setup an apache Virtual Hosttaiga::back
: Install Taiga backtaiga::front
: Install taiga fronttaiga::vhost
: Configure an apache Virtual Host for taiga
Private Classes
taiga::back::config
: Configure Taiga backtaiga::back::cron
: Setup crontabtaiga::back::database
: Configure Taiga back databasetaiga::back::dependencies
: Configure Taiga back dependenciestaiga::back::install
: Install Taiga backtaiga::back::ldap
: Manage Taiga back LDAP configurationtaiga::back::migrate
: Perform Taiga back migrationstaiga::back::repo
: Manage the Taiga back repositorytaiga::back::seed
: Seed Taiga backtaiga::back::user
: Manage the Taiga back usertaiga::front::config
: Manage Taiga front configtaiga::front::repo
: Manage the Taiga front repository
Defined types
Private Defined types
taiga::back::manage
: Allow running actions in Taiga back environment
Data types
Taiga::Admin
: A Taiga::Admin is composed of a full name and an e-mail address
Tasks
project_change_slug
: Change a project sluguser_change_fullname
: Change the full name for specified useruser_disable
: Disable the specified useruser_list
: List usersversion
: Retrieve Taiga back and front versions
Classes
taiga
Install both Taiga front, back and setup an apache Virtual Host
Parameters
The following parameters are available in the taiga
class:
hostname
back_secret_key
back_db_password
protocol
default_language
repo_ensure
repo_revision
back_directory
venv_directory
front_directory
back_user
back_admins
public_register_enabled
gravatar
ldap_server
ldap_port
ldap_bind_dn
ldap_bind_password
ldap_search_base
ldap_search_property
ldap_search_suffix
ldap_email_property
ldap_full_name_property
ssl_cert
ssl_key
ssl_chain
change_notification_min_interval
default_project_slug_prefix
hostname
Data type: String[1]
Hostname that will be used to reach the Taiga instance.
back_secret_key
Data type: String[1]
A secret key passed to the SECRET_KEY
setting in taiga-back configuration. (A 60 characters random string should be a good start).
back_db_password
Data type: String[1]
Sets the database password. It is currently not used but still has to be provided.
protocol
Data type: Enum['http', 'https']
Protocol to be used.
Default value: 'https'
default_language
Data type: String[2, 2]
Default language.
Default value: 'en'
repo_ensure
Data type: Enum['present', 'latest']
Ensure value for Taiga's vcs repository.
Default value: 'present'
repo_revision
Data type: String[1]
Revision for Taiga's vcs repository.
Default value: 'stable'
back_directory
Data type: Stdlib::Absolutepath
Directory where is installed the backend of Taiga.
Default value: '/srv/www/taiga-back'
venv_directory
Data type: Stdlib::Absolutepath
Default where is installed python dependencies.
Default value: '/srv/www/taiga-venv'
front_directory
Data type: Stdlib::Absolutepath
Directory where is installed the frontend of Taiga.
Default value: '/srv/www/taiga-front'
back_user
Data type: String[1]
Name of the user running the backend daemon.
Default value: 'taiga'
back_admins
Data type: Array[Taiga::Admin]
Administrators to notify of Taiga exceptions.
Default value: []
public_register_enabled
Data type: Boolean
Enable anyone to register on this instance.
Default value: true
gravatar
Data type: Boolean
Use gravatar.
Default value: true
ldap_server
Data type: Optional[String[1]]
LDAP server.
Default value: undef
ldap_port
Data type: Integer
LDAP port.
Default value: 389
ldap_bind_dn
Data type: Optional[String[1]]
DN to use for LDAP authentication.
Default value: undef
ldap_bind_password
Data type: Optional[String[1]]
Password to use for LDAP authentication.
Default value: undef
ldap_search_base
Data type: String[1]
Search base for users.
Default value: 'ou=people,dc=example,dc=com'
ldap_search_property
Data type: String[1]
Property holding users login.
Default value: 'uid'
ldap_search_suffix
Data type: Optional[String[1]]
Default value: undef
ldap_email_property
Data type: String[1]
Property holding users e-mail.
Default value: 'mail'
ldap_full_name_property
Data type: String[1]
Property holding users full name.
Default value: 'cn'
ssl_cert
Data type: Optional[Stdlib::Absolutepath]
Certificate to use for apache VirtualHost.
Default value: undef
ssl_key
Data type: Optional[Stdlib::Absolutepath]
Key to use for apache VirtualHost.
Default value: undef
ssl_chain
Data type: Optional[Stdlib::Absolutepath]
Certificate chain to use for apache VirtualHost.
Default value: undef
change_notification_min_interval
Data type: Optional[Integer]
Interval for sending change notifications.
Default value: undef
default_project_slug_prefix
Data type: Optional[Boolean]
Add username to project slug
Default value: undef
taiga::back
Install Taiga back
Parameters
The following parameters are available in the taiga::back
class:
front_hostname
front_protocol
back_hostname
back_protocol
secret_key
db_password
dependencies
db_name
db_user
user
repo_ensure
repo_revision
install_dir
venv_dir
admins
public_register_enabled
ldap_enable
ldap_server
ldap_port
ldap_bind_dn
ldap_bind_password
ldap_search_base
ldap_search_property
ldap_search_suffix
ldap_email_property
ldap_full_name_property
email_use_tls
email_host
email_port
email_user
email_password
change_notification_min_interval
default_project_slug_prefix
front_hostname
Data type: String[1]
Hostname used to reach the frontend.
front_protocol
Data type: Enum['http', 'https']
Protocol used to reach the frontend.
back_hostname
Data type: String[1]
Hostname used to reach the backend.
back_protocol
Data type: Enum['http', 'https']
Protocol used to reach the backend.
secret_key
Data type: String[1]
A secret key passed to the SECRET_KEY
setting in taiga-back configuration. (A 60 characters random string should be a good start).
db_password
Data type: String[1]
Sets the database password. It is currently not used but still has to be provided.
dependencies
Data type: Array[String[1]]
Extra depepdencies.
db_name
Data type: String[1]
Name of the database.
Default value: 'taiga'
db_user
Data type: String[1]
User of the database.
Default value: 'taiga'
user
Data type: String[1]
Name of the user running the backend daemon.
Default value: 'taiga'
repo_ensure
Data type: Enum['present', 'latest']
Ensure value for Taiga's vcs repository.
Default value: 'present'
repo_revision
Data type: String[1]
Revision for Taiga's vcs repository.
Default value: 'stable'
install_dir
Data type: Stdlib::Absolutepath
Directory where is installed the backend of Taiga.
Default value: '/srv/www/taiga-back'
venv_dir
Data type: Stdlib::Absolutepath
Directory where is installed Taiga pyhton dependencies.
Default value: '/srv/www/taiga-venv'
admins
Data type: Array[Taiga::Admin]
Administrators to notify of Taiga exceptions.
Default value: []
public_register_enabled
Data type: Boolean
Enable anyone to register on this instance.
Default value: true
ldap_enable
Data type: Boolean
Enable the LDAP client.
Default value: false
ldap_server
Data type: Optional[String[1]]
LDAP server.
Default value: undef
ldap_port
Data type: Integer
LDAP port.
Default value: 389
ldap_bind_dn
Data type: Optional[String[1]]
DN to use for LDAP authentication.
Default value: undef
ldap_bind_password
Data type: Optional[String[1]]
Password to use for LDAP authentication.
Default value: undef
ldap_search_base
Data type: String[1]
Search base for users.
Default value: 'ou=people,dc=example,dc=com'
ldap_search_property
Data type: String[1]
Property holding users login.
Default value: 'uid'
ldap_search_suffix
Data type: Optional[String[1]]
Default value: undef
ldap_email_property
Data type: String[1]
Property holding users e-mail.
Default value: 'mail'
ldap_full_name_property
Data type: String[1]
Property holding users full name.
Default value: 'cn'
email_use_tls
Data type: Boolean
Use TLS to connect to the mail server.
Default value: false
email_host
Data type: String[1]
Hostname of the mail server.
Default value: 'localhost'
email_port
Data type: Integer
Port of the mail server.
Default value: 25
email_user
Data type: Optional[String[1]]
Username to authenticate on the mail server.
Default value: undef
email_password
Data type: Optional[String[1]]
Password to authenticate on the mail server.
Default value: undef
change_notification_min_interval
Data type: Optional[Integer]
Interval for sending change notifications.
Default value: undef
default_project_slug_prefix
Data type: Optional[Boolean]
Add username to project slug
Default value: undef
taiga::front
Install taiga front
Parameters
The following parameters are available in the taiga::front
class:
back_hostname
back_protocol
events
user
repo_ensure
repo_revision
install_dir
default_language
public_register_enabled
ldap_enable
gravatar
back_hostname
Data type: String[1]
Hostname used to reach the backend.
back_protocol
Data type: Enum['http', 'https']
Protocol used to reach the backend.
events
Data type: Boolean
Default value: false
user
Data type: String[1]
Name of the user owning the files of the frontend.
Default value: 'nobody'
repo_ensure
Data type: Enum['present', 'latest']
Ensure value for Taiga's vcs repository.
Default value: 'present'
repo_revision
Data type: String[1]
Revision for Taiga's vcs repository.
Default value: 'stable'
install_dir
Data type: Stdlib::Absolutepath
Directory where is installed the frontend of Taiga.
Default value: '/srv/www/taiga-front'
default_language
Data type: String[2, 2]
Default language.
Default value: 'en'
public_register_enabled
Data type: Boolean
Enable anyone to register on this instance.
Default value: true
ldap_enable
Data type: Boolean
Enable the LDAP client.
Default value: false
gravatar
Data type: Boolean
Use gravatar.
Default value: true
taiga::vhost
Configure an apache Virtual Host for taiga
Parameters
The following parameters are available in the taiga::vhost
class:
protocol
hostname
back_directory
venv_directory
front_directory
back_user
ssl_cert
ssl_key
ssl_chain
protocol
Data type: Enum['http', 'https']
Protocol to be used.
hostname
Data type: String[1]
Hostname that will be used to reach the Taiga instance.
back_directory
Data type: Stdlib::Absolutepath
Directory where is installed the backend of Taiga.
venv_directory
Data type: Stdlib::Absolutepath
Directory where is installed python dependencies.
front_directory
Data type: Stdlib::Absolutepath
Directory where is installed the frontend of Taiga.
back_user
Data type: String[1]
Name of the user running the backend daemon.
ssl_cert
Data type: Optional[String[1]]
Certificate to use for apache VirtualHost.
Default value: undef
ssl_key
Data type: Optional[String[1]]
Key to use for apache VirtualHost.
Default value: undef
ssl_chain
Data type: Optional[String[1]]
Certificate chain to use for apache VirtualHost.
Default value: undef
Data types
Taiga::Admin
A Taiga::Admin is composed of a full name and an e-mail address
Alias of Tuple[String[1], Pattern[/.@./]]
Tasks
project_change_slug
Change a project slug
Supports noop? false
Parameters
current_slug
Data type: String[1]
Current project slug
new_slug
Data type: String[1]
New project slug
backend_directory
Data type: String[1]
Backend directory
venv_directory
Data type: String[1]
Python virtual env directory
user_change_fullname
Change the full name for specified user
Supports noop? false
Parameters
username
Data type: String[1]
Username
fullname
Data type: String[1]
Full name
database
Data type: String[1]
Database name
user_disable
Disable the specified user
Supports noop? false
Parameters
username
Data type: String[1]
Username
database
Data type: String[1]
Database name
user_list
List users
Supports noop? false
Parameters
database
Data type: String[1]
Database name
version
Retrieve Taiga back and front versions
Supports noop? false
Parameters
backend_directory
Data type: String[1]
Backend directory
frontend_directory
Data type: String[1]
Frontend directory
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v4.0.1 (2023-11-30)
Fixed bugs:
v4.0.0 (2023-11-30)
Breaking changes:
v3.1.0 (2023-10-06)
Implemented enhancements:
v3.0.0 (2023-08-08)
Breaking changes:
- Drop support for Debian 10 (oldstable) #58 (smortex)
- Remove support for Puppet 6 (EOL) #57 (smortex)
- Rework templates #51 (smortex)
Implemented enhancements:
- Add support for Puppet 8 #62 (smortex)
- Relax dependencies version requirements #60 (smortex)
- Allow puppetlabs-postgresql 8.x #55 (smortex)
- Add tasks to ease users/projects management #48 (neomilium)
Fixed bugs:
v2.1.0 (2021-10-24)
Implemented enhancements:
- Add support for Debian 11 #50 (smortex)
- Add task to retrieve backend and frontend versions #46 (neomilium)
Fixed bugs:
Merged pull requests:
2.0.1 (2021-05-14)
Fixed bugs:
2.0.0 (2021-05-14)
Breaking changes:
Implemented enhancements:
1.3.0 (2021-03-15)
Implemented enhancements:
Fixed bugs:
1.2.0 (2021-02-09)
Implemented enhancements:
Fixed bugs:
1.1.0 (2020-12-21)
Implemented enhancements:
- Fix comment in generated config file #27 (smortex)
- Add support for CHANGE_NOTIFICATIONS_MIN_INTERVAL #26 (smortex)
- Rework Apache VirtualHost #23 (smortex)
- Modernize and add documentation #19 (smortex)
- Add support for Debian Buster #16 (smortex)
- Add data-types for all parameters #13 (smortex)
Fixed bugs:
- Fix install on Debian #21 (smortex)
- Fix missing migration dependency #17 (neomilium)
- Fix seeding: there is no more initial_role data to load #6 (neomilium)
1.0.2 (2017-04-05)
Implemented enhancements:
- Move Python parameters to param class #5 (smortex)
- Disable timeout for pip install #4 (smortex)
- Explicitely depend on passenger #3 (smortex)
1.0.1 (2017-03-23)
Implemented enhancements:
Fixed bugs:
1.0.0 (2016-10-14)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/concat (>= 0.1.0 < 10.0.0)
- puppetlabs/postgresql (>= 6.5.0 < 10.0.0)
- puppet/python (>= 4.1.0 < 8.0.0)
- puppetlabs/stdlib (>= 9.0.0 < 10.0.0)
- puppetlabs/vcsrepo (>= 2.0.0 < 6.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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.