REFERENCE.md

Reference

Table of Contents

Classes

• openafs: Install and configure OpenAFS packages and services
• openafs::client: Install and configure OpenAFS client
• openafs::client::firewall: Configure the firewall settings for OpenAFS client
• openafs::client::packages: Install packages for OpenAFS client
• openafs::client::rebuild: Rebuild the kernel module for OpenAFS when needed
• openafs::client::service: Configure service for OpenAFS client
• openafs::common: Configure settings common to all OpenAFS services
• openafs::database_server: Install and configure OpenAFS database server
• openafs::database_server::firewall: Configure the firewall settings for OpenAFS database server
• openafs::database_server::packages: Install packages for OpenAFS database server
• openafs::database_server::service: Configure service for OpenAFS database server
• openafs::file_server: Install and configure OpenAFS file server
• openafs::file_server::firewall: Configure the firewall settings for OpenAFS file server
• openafs::file_server::packages: Install packages for OpenAFS file server
• openafs::file_server::rebuild: Rebuild the kernel module for OpenAFS when needed
• openafs::file_server::service: Configure service for OpenAFS file server
• openafs::repos: Install and configure OpenAFS package repository
• openafs::server_common: Configure common settings to all OpenAFS server types

Classes

openafs

Install and configure OpenAFS packages and services

Examples

include openafs

openafs::client

Install and configure OpenAFS client

Examples

include openafs::client

Parameters

The following parameters are available in the openafs::client class:

• profile_files

profile_files

Data type: Hash

Hash of profile files related to OpenAFS client usage

openafs::client::firewall

Configure the firewall settings for OpenAFS client

Examples

include openafs::client::firewall

Parameters

The following parameters are available in the openafs::client::firewall class:

• dports
• proto
• sources

dports

Data type: Array[String]

Array of destination ports that need to be open for the OpenAFS client

proto

Data type: String

String of protocol that needs to be open for the OpenAFS client

sources

Data type: Array[String]

Array CIDR sources that need to be open for the OpenAFS client

openafs::client::packages

Install packages for OpenAFS client

Examples

include openafs::client::packages

Parameters

The following parameters are available in the openafs::client::packages class:

• packages
• prereq_packages

packages

Data type: Array

Array of packages that need to be installed for the OpenAFS client

prereq_packages

Data type: Array

Array of prerequisite packages that need to be installed for the OpenAFS client

openafs::client::rebuild

Rebuild the kernel module for OpenAFS when needed

Examples

include openafs::client::rebuild

Parameters

The following parameters are available in the openafs::client::rebuild class:

• testfile

testfile

Data type: String

String of file/path to test for at top level under /afs/thiscell/ to check to see if AFS mounted as expected.

openafs::client::service

Configure service for OpenAFS client

Examples

include openafs::client::service

Parameters

The following parameters are available in the openafs::client::service class:

• enable
• ensure
• service_name

enable

Data type: Boolean

Boolean of whether the default service should be enabled

ensure

Data type: String

String of how the default service should be ensured

service_name

Data type: String

String of the name of the default service

openafs::common

Configure settings common to all OpenAFS services

Examples

include openafs::common

Parameters

The following parameters are available in the openafs::common class:

• viceetcdir

viceetcdir

Data type: String

String of dirctory to AFS common configuration directory (viceetcdir)

openafs::database_server

Install and configure OpenAFS database server

Examples

include openafs::database_server

openafs::database_server::firewall

Configure the firewall settings for OpenAFS database server

Examples

include openafs::database_server::firewall

Parameters

The following parameters are available in the openafs::database_server::firewall class:

• dports
• proto
• sources

dports

Data type: Array[String]

Array of destination ports that need to be open for the OpenAFS database server

proto

Data type: String

String of protocol that needs to be open for the OpenAFS database server

sources

Data type: Array[String]

Array CIDR sources that need to be open for the OpenAFS database server

openafs::database_server::packages

Install packages for OpenAFS database server

Examples

include openafs::database_server::packages

Parameters

The following parameters are available in the openafs::database_server::packages class:

• packages

packages

Data type: Array

Array of packages that need to be installed for the OpenAFS database server

openafs::database_server::service

Configure service for OpenAFS database server

Examples

include openafs::database_server::service

Parameters

The following parameters are available in the openafs::database_server::service class:

• enable
• ensure
• service_name

enable

Data type: Boolean

Boolean of whether the default service should be enabled

ensure

Data type: String

String of how the default service should be ensured

service_name

Data type: String

String of the name of the default service

openafs::file_server

Install and configure OpenAFS file server

Examples

include openafs::file_server

openafs::file_server::firewall

Configure the firewall settings for OpenAFS file server

Examples

include openafs::file_server::firewall

Parameters

The following parameters are available in the openafs::file_server::firewall class:

• dports
• proto
• sources

dports

Data type: Array[String]

Array of destination ports that need to be open for the OpenAFS file server

proto

Data type: String

String of protocol that needs to be open for the OpenAFS file server

sources

Data type: Array[String]

Array CIDR sources that need to be open for the OpenAFS file server

openafs::file_server::packages

Install packages for OpenAFS file server

Examples

include openafs::file_server::packages

Parameters

The following parameters are available in the openafs::file_server::packages class:

• packages
• prereq_packages

packages

Data type: Array

Array of packages that need to be installed for the OpenAFS file server

prereq_packages

Data type: Array

Array of prerequisite packages that need to be installed for the OpenAFS file server

openafs::file_server::rebuild

Rebuild the kernel module for OpenAFS when needed

Examples

include openafs::file_server::rebuild

openafs::file_server::service

Configure service for OpenAFS file server

Examples

include openafs::file_server::service

Parameters

The following parameters are available in the openafs::file_server::service class:

• enable
• ensure
• service_name

enable

Data type: Boolean

Boolean of whether the default service should be enabled

ensure

Data type: String

String of how the default service should be ensured

service_name

Data type: String

String of the name of the default service

openafs::repos

Install and configure OpenAFS package repository

Examples

include openafs::repos

Parameters

The following parameters are available in the openafs::repos class:

• repos

repos

Data type: Hash

Hash of yumrepo or zypprepo resources for OpenAFS yum/zypper repositories

openafs::server_common

Configure common settings to all OpenAFS server types

Examples

include openafs::server_common

Parameters

The following parameters are available in the openafs::server_common class:

• afsbackupdir
• afsconfdir
• afslocaldir
• afslogsdir
• cellservdb
• files
• keyfile_base64
• keyfileext_base64
• krb_conf
• license
• rxkad_keytab_base64
• userlist

afsbackupdir

Data type: String

String of path to AFS server backup directory

afsconfdir

Data type: String

String of path to AFS server configuration directory

afslocaldir

Data type: String

String of path to AFS server local directory

afslogsdir

Data type: String

String of path to AFS server logs directory

cellservdb

Data type: String

String of CellServDB config file contents for OpenAFS servers

files

Data type: Hash

Hash of common server config files for OpenAFS servers

keyfile_base64

Data type: String

String of base64 encoding of the KeyFile file contents for OpenAFS servers

keyfileext_base64

Data type: String

String of base64 encoding of the KeyFileExt file contents for OpenAFS servers

krb_conf

Data type: String

String of krb.conf config file contents for OpenAFS servers

license

Data type: String

String of License file contents for OpenAFS servers

rxkad_keytab_base64

Data type: String

String of base64 encoding of the rxkad.keytab file contents for OpenAFS servers

userlist

Data type: String

String of UserList file contents for OpenAFS servers