fts

A puppet module to install and configure FTS created by Michele Delli Veneri and Francesco Di Nucci

Project URL RSS Feed Report issues

Module Stats

128 downloads

128 latest version

3.0 quality score

Version information

released Nov 6th 2023

This version is compatible with:

Puppet Enterprise 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
Puppet >= 7.24 < 9.0.0
, , ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'nasd-fts', '0.1.6'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add nasd-fts

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install nasd-fts --version 0.1.6

Documentation

nasd/fts — version 0.1.6 Nov 6th 2023

fts

Description
Setup - The basics of getting started with fts
Usage - Configuration options
Limitations - OS compatibility

Description

A module to install and configure an FTS3 server and its MySQL database on a couple of Hosts.

Setup

Setup two machines with CentOS 7 (puppet agents, not constrained to CentOS 7);
Install puppet agent on both machines:
1. add the puppet repo rpm -Uvh https://yum.puppetlabs.com/puppet7/puppet7-release-el-7.noarch.rpm;
2. install the puppet agent and vim packages (yum install -y puppet-agent vim)
3. Reload your /etc/profile to update $PATH or run puppet agent by absolute path
4. create the certificates folder in the root path and copy there your site hostcert.pem and hostkey.pem;
Employ the fts class to configure the FTS server and the MySQL database on the nodes, see the fts=db.pp and fts-server.pp in examples for some reference;
Add the following modules in your puppetfile:

mod 'cnafsd-voms', '0.8.0'
mod "puppetlabs-stdlib",'9.4.0'
mod 'puppet-cron', '4.1.0'
mod 'puppet-selinux', '4.0.0'
mod 'puppetlabs-inifile', '6.1.0'
mod 'puppet-systemd', '6.0.0'
mod 'puppetlabs-firewall', '7.0.2'
mod 'puppet/yum', '7.1.0'
mod 'puppetlabs/apache', '11.1.0'
mod 'puppetlabs/mysql', '15.0.0'
mod 'bradipoeremita-concat', '9.0.0'
mod 'nasd-fts', '0.1.6'

Modify the puppet.conf (vim /etc/puppetlabs/puppet/puppet.conf) file in both servers to point to your puppet server with the fts_development environment

[main]
        server = yourpuppetserver.infn.it

[agent]
        pluginsync  = true
        report      = true
        environment = fts_development

execute puppet agent -t -v on both servers (db first, fts server second);
execute fetch-crl (it is possible to use -p parameter to parallelize download);
restart httpd: systemctl restart httpd

Test your installation

Check your monitoring webpage at https://{fts_fqdn}:8449/fts3/ftsmon/#/;
Execute the following command on your server curl --capath /etc/grid-security/certificates -E /etc/grid-security/hostcert.pem --key /etc/grid-security/hostkey.pem https://fts_host:8446/whoami;

Usage

The module can be used to configure both the database and fts server on the same machine, or on two different machines. For the latter use case, to configure the fts server only, set configure_db to false, and to configure the mysql database only, set configure_fts to false. Check the examples to see two .pp files configuring both the server and the database.

# On the fts server 
fts {'creating-fts-server'
    fts_host           => 'fts3-server.example.org',
    db_host            => 'fts3-db.example.org',
    db_root_password   => 'ftstestpassword',
    fts_db_user        => 'fts3',
    fts_db_type        => 'mysql',
    fts_server_alias   => 'fts3-server',
    fts_db_threads_num => 24,
    configure_db       => false,
    configure_fts      => true,
    configure_firewall => true,
    configure_lsc      => true,
    vo_list            => ['alice', 'atlas', 'cms', 'cygno', 'datacloud', 'dteam', 'escape', 'lhcb', 'ops', 'wlcg'],
}
# On the fts database
fts {'creating the database'
    fts_host           => 'fts3-server.example.org',
    db_host            => 'fts3-db.example.org',
    db_root_password   => 'ftstestpassword',
    fts_db_user        => 'fts3',
    fts_db_type        => 'mysql',
    fts_server_alias   => 'fts3-server',
    fts_db_threads_num => 24,
    configure_db       => true,
    configure_fts      => false,
    configure_firewall => true,
    configure_lsc      => true,
    vo_list            => ['alice', 'atlas', 'cms', 'cygno', 'datacloud', 'dteam', 'escape', 'lhcb', 'ops', 'wlcg'],
}

Limitations

It works only on CentOS 7 distributions.

Reference

Classes

fts: This class installs the FTS3 server and configures it to run as a service. It can also install the MySQL server and create the FTS3 database. The class can be used to configure only the FTS3 server, only the MySQL server, or both.
fts::client: This class isntall the FTS client
fts::database: @summary: this class configures the fts database (required) the password for the fts database user (required) the name of the fts database
fts::server: This class defines the configuration for the FTS server. It takes in parameters for configuring the server and sets up the necessary resources.

Classes

`fts`

This class installs the FTS3 server and configures it to run as a service. It can also install the MySQL server and create the FTS3 database. The class can be used to configure only the FTS3 server, only the MySQL server, or both.

Examples

class { 'fts':
  fts_host           => 'fts3-server.example.org',
  db_host            => 'fts3-db.example.org',
  db_root_password   => 'ftstestpassword',
  fts_db_user        => 'fts3',
  fts_db_type        => 'mysql',
  fts_server_alias   => 'fts3-server',
  admin_list         => ['/DC=org/DC=terena/DC=tcs/C=IT/O=Istituto Nazionale di Fisica Nucleare/CN=Michele Delli Veneri delliven@infn.it'],
  fts_db_threads_num => 24,
  configure_db       => true,
  configure_fts      => true,
  configure_firewall => true,
  configure_lsc      => true,
  vo_list            => ['alice', 'atlas', 'cms', 'cygno', 'datacloud', 'dteam', 'escape', 'lhcb', 'ops', 'wlcg'],
}

Parameters

The following parameters are available in the fts class:

fts_host
db_host
db_name
db_root_password
fts_db_user
fts_db_type
fts_server_alias
admin_list
fts_db_threads_num
configure_fts
configure_db
configure_firewall
configure_lsc
vo_list

`fts_host`

Data type: String

(required) The hostname of the FTS3 server. Defaults to the value of $::fqdn. The value of this parameter is used to set the FTS3 server hostname in the MySQL database.

Default value: 'fts3-server.infn.it'

`db_host`

Data type: String

(required) The hostname of the FTS3 database. Defaults to the value of $::fqdn. The value of this parameter is used to set the FTS3 database hostname in the FTS3 configuration file.

Default value: 'fts3-db.infn.it'

`db_name`

Data type: String

(required) The name of the FTS3 database. Defaults to 'fts'.

Default value: 'fts'

`db_root_password`

Data type: String

(required) The password of the MySQL root user.

Default value: 'ftstestpassword'

`fts_db_user`

Data type: String

(optional) The username of the FTS3 database. Defaults to 'fts3'.

Default value: 'fts3'

`fts_db_type`

Data type: String

(optional) The type of the FTS3 database. Defaults to 'mysql'.

Default value: 'mysql'

`fts_server_alias`

Data type: String

(optional) The alias of the FTS3 server. Defaults to 'fts3-server'.

Default value: 'fts3-server'

`admin_list`

Data type: Array

(optional) List of DNs of the FTS3 administrators. Defaults to ['/DC=org/DC=terena/DC=tcs/C=IT/O=Istituto Nazionale di Fisica Nucleare/CN=Michele Delli Veneri]

Default value: ['/DC=org/DC=terena/DC=tcs/C=IT/O=Istituto Nazionale di Fisica Nucleare/CN=Michele Delli Veneri delliven@infn.it']

`fts_db_threads_num`

Data type: Integer

(optional) The number of threads to use for the FTS3 database. Defaults to 24.

Default value: 24

`configure_fts`

Data type: Boolean

(optional) Whether to configure the FTS3 server.

Default value: true

`configure_db`

Data type: Boolean

(optional) Whether to configure the FTS3 database. Defaults to true.

Default value: true

`configure_firewall`

Data type: Boolean

(optional) Whether to configure the firewall. Defaults to true.

Default value: true

`configure_lsc`

Data type: Boolean

(optional) Whether to install and configure the servers as VOMS clients. Defaults to true.

Default value: true

`vo_list`

Data type: Array

(optional) List of VOs to configure. Add the VOs to the list. Possible values are 'alice', 'atlas', 'cms', 'cygno', 'datacloud', 'dteam', 'escape', 'lhcb', 'ops', 'wlcg' Defaults to [None].

Default value: ['cycgno', 'datacloud']

`fts::client`

A description of what this class does

Examples

include fts::client

`fts::database`

@summary: this class configures the fts database

(required) the password for the fts database user

(required) the name of the fts database

(required) the hostname of the fts server

(required) the name of the fts database user

(required) the list of the admin users for the fts database

(optional) whether to configure the firewall or not

Examples

Configure the fts database

class { 'fts::database':
   db_password => 'ftstestpassword',
   db_name     => 'fts',
   fts_host    => 'fts-server.infn.it',
   fts_db_user => 'fts3',
   admin_list  => ['/DC=org/DC=terena/DC=tcs/C=IT/O=Istituto Nazionale di Fisica Nucleare/CN=Michele Delli Veneri,
                    '/DC=org/DC=terena/DC=tcs/C=IT/O=Istituto Nazionale di Fisica Nucleare/CN=Massimo Sgaravatto sgaravat@infn.it'],
  configure_firewall => true,
}

Parameters

The following parameters are available in the fts::database class:

db_password
db_name
fts_host
fts_db_user
admin_list
configure_firewall

`db_password`

Data type: String

Default value: 'ftstestpassword'

`db_name`

Data type: String

Default value: 'fts'

`fts_host`

Data type: String

Default value: 'fts-server.infn.it'

`fts_db_user`

Data type: String

Default value: 'fts3'

`admin_list`

Data type: Array

Default value: ['/DC=org/DC=terena/DC=tcs/C=IT/O=Istituto Nazionale di Fisica Nucleare/CN=Michele Delli Veneri delliven@infn.it']

`configure_firewall`

Data type: Boolean

Default value: true

`fts::server`

}

Examples

class { 'fts::server':
  fts_user => 'fts3',
  fts_db_type => 'mysql',
  fts_db_username => 'root',
  fts_db_name => 'fts',
  fts_db_password => 'ftstestpassword',
  fts_db_threads_num => 24,
  fts_server_alias => 'fts3-server',
  configure_firewall => true,

Parameters

The following parameters are available in the fts::server class:

fts_user
fts_db_type
db_host
fts_db_username
fts_db_name
fts_db_password
fts_db_threads_num
fts_server_alias
configure_firewall

`fts_user`

Data type: String

The user that will run the FTS server

Default value: 'fts3'

`fts_db_type`

Data type: String

The type of database backend to use

Default value: 'mysql'

`db_host`

Data type: String

The hostname of the database server

Default value: 'fts-db.infn.it'

`fts_db_username`

Data type: String

The username to use to connect to the database

Default value: 'root'

`fts_db_name`

Data type: String

The name of the database to use

`fts_db_password`

Data type: String

The password to use to connect to the database

Default value: 'ftstestpassword'

`fts_db_threads_num`

Data type: Integer

The number of threads to use for the database backend

Default value: 24

`fts_server_alias`

Data type: String

The alias to use for the FTS server

Default value: 'fts3-server'

`configure_firewall`

Data type: Boolean

Whether to configure the firewall or not

Default value: true


                                 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.

Modules

Discover

Contribute

Resources

About Forge

Getting Started

fts

Version information

This version is compatible with:

Start using this module

Documentation

fts

Table of Contents

Description

Setup

Test your installation

Usage

Limitations

Reference

Table of Contents

Classes

Classes

fts

Examples

Parameters

fts_host

db_host

db_name

db_root_password

fts_db_user

fts_db_type

fts_server_alias

admin_list

fts_db_threads_num

configure_fts

configure_db

configure_firewall

configure_lsc

vo_list

fts::client

Examples

fts::database

Examples

Configure the fts database

Parameters

db_password

db_name

fts_host

fts_db_user

admin_list

configure_firewall

fts::server

Examples

Parameters

fts_user

fts_db_type

db_host

fts_db_username

fts_db_name

fts_db_password

fts_db_threads_num

fts_server_alias

configure_firewall

Changelog

Release 0.1.0

Dependencies

`fts`

`fts_host`

`db_host`

`db_name`

`db_root_password`

`fts_db_user`

`fts_db_type`

`fts_server_alias`

`admin_list`

`fts_db_threads_num`

`configure_fts`

`configure_db`

`configure_firewall`

`configure_lsc`

`vo_list`

`fts::client`

`fts::database`

`db_password`

`db_name`

`fts_host`

`fts_db_user`

`admin_list`

`configure_firewall`

`fts::server`

`fts_user`

`fts_db_type`

`db_host`

`fts_db_username`

`fts_db_name`

`fts_db_password`

`fts_db_threads_num`

`fts_server_alias`

`configure_firewall`