phil-friderici / puppet-module-afs

manage OpenAFS with new EIS packages

puppet-module-afs

Table of Contents

1. Module Description - What the module does and why it is useful
2. Setup - The basics of getting started with afs
   • What afs affects
   • Setup requirements
   • Beginning with afs
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Module description

This module manages OpenAFS

Setup

What afs affects

Manages the packages and files regarding OpenAFS. Location of these files vary by platform and packages being used to install OpenAFS.

Setup requirements

This module requires stdlib,cron_core and common (see metadata.json).

Beginning with afs

Include the main ::afs class. Default values for supported operating systems are specified in the module's Hiera.

Basic usage

There are a few parameters that are required for the AFS module to configure OpenAFS correctly. afs::cell afs::afs_cellserverdb

afs::cell: afs.domain.tld
afs::afs_cellserverdb: |
  >afs.domain.tld

OpenAFS will be configured with ThisCell afs.domain.tld with CellServDB afs.domain.tld.

Manage symlinks for AFS

Symlinks can be created if required.

afs::links:
  'app':
    path:   '/app'
    target: '/afs/some/path/app'
  'env':
    path:   '/env'
    target: '/afs/some/path/env'
  'etc_home':
     path:   '/etc/home'
     target: '/env/site/profiles/home'

This would create the following symlinks:

/app -> /afs/some/path/app
/env -> /afs/some/path/env
/etc/home -> /env/site/profiles/home

Solaris specific

For usage on Solaris, you will need to define these variables:

$package_adminfile, $package_source and $service_provider

If you want to create a cron job, please set $afs_cron_job_interval to 'specific' and choose your values for $afs_cron_job_hour and $afs_cron_job_minute.

afs::afs_cron_job_interval: 'specific'
afs::afs_cron_job_content:  '[ -x /afs_maintenance.sh ] && /afs_maintenance.sh'
afs::afs_cron_job_hour:     '2'
afs::afs_cron_job_minute:   '42'

afs::package_adminfile:     '/path/to/adminfile/noask'
afs::package_source:        '/path/to/package/openafs-x.x.x-x-Sol10'
afs::service_provider:      'init'

On Solaris containers, this module will not start the OpenAFS service and the cronjob will not be created. Packages are still installed for the included tools.

Service management

There are three different modes the module can handle services. The supported operating systems has been configured according to the list below:

init:
  <= EL6
  <= Suse 11
  Ubuntu
  Solaris
hybrid:
  Suse 12
  EL7
systemd:
  All versions not specified under `init` or `hybrid`.

Hybrid will use systemd to execute the init-script which will start the service.

For non-supported operating systems you'll have to choose which setup you want to use. Setting init_template will make make it use init method, setting both init and systemd it will use hybrid and finally with systemd_script_template which will use systemd.

Limitations

This module has been tested to work on the following systems with Puppet versions 5 and 6 with the Ruby version associated with those releases. Please see .travis.yml for a full matrix of supported versions. This module aims to support the current and previous major Puppet versions.

• EL 5
• EL 6
• EL 7
• EL 8
• EL 9
• Solaris 10
• Suse 10
• Suse 11
• Suse 12
• Suse 15
• Ubuntu 12.04
• Ubuntu 14.04
• Ubuntu 16.04
• Ubuntu 18.04
• Ubuntu 20.04

Other operating systems might be supported by configuring the module with the correct parameters.