Skip to content

Latest commit

 

History

History
262 lines (155 loc) · 7.35 KB

REFERENCE.md

File metadata and controls

262 lines (155 loc) · 7.35 KB

Reference

Table of Contents

Classes

  • afs: This module manages OpenAFS

Defined types

Classes

afs

afs class

Examples

Declaring the class
include ::afs

Parameters

The following parameters are available in the afs class:

afs_cellserverdb

Data type: Optional[String]

String defining CellServDB. Content of file $afs_config_path/CellServDB. This file will be ignored if the default value is not changed.

Default value: undef

afs_cell

Data type: Optional[String]

String defining ThisCell. Content of the file $afs_config_path/ThisCell. This file will be ignored if the default value is not changed.

Default value: undef

afs_config_path

Data type: Stdlib::Unixpath

Path to the OpenAFS config directory.

Default value: undef

afs_cron_job_content

Data type: Optional[String]

String with OpenAFS cron job command. Example: '[ -x /afs_maintenance.sh ] && /afs_maintenance.sh' Do not use multi line content when $afs_cron_job_interval is set to 'specific'.

Default value: undef

afs_cron_job_hour

Data type: Optional[Integer[0, 23]]

The hour at which to run the cron job. If set to it will become '*' at creation time.

Default value: undef

afs_cron_job_interval

Data type: Optional[Enum['hourly', 'daily', 'weekly', 'monthly', 'specific']]

String to specify when to run the cron job. Set to 'specific' to create cron jobs. It uses $afs_cron_job_minute/hour/weekday/month/monthday to specify when to run the cron job. On systems that support fragment files in /etc/cron.(hourly|daily|weekly|monthly) you can use This module can only create or change cron jobs, there is no housekeeping support to delete them.

Default value: undef

afs_cron_job_minute

Data type: Integer[0, 59]

Integer within specific boundaries. The minute at which to run the cron job. ACHTUNG: If set to it will become '*' at creation time.

Default value: 42

afs_cron_job_monthday

Data type: Optional[Integer[1, 31]]

Integer within specific boundaries. The day of the month on which to run the cron job. If set to it will become '*' at creation time.

Default value: undef

afs_cron_job_month

Data type: Optional[Integer[1, 12]]

Integer within specific boundaries. The month of the year in which to run the cron job. If set to it will become '*' at creation time.

Default value: undef

afs_cron_job_weekday

Data type: Optional[Integer[0, 7]]

Integer within specific boundaries. The weekday on which to run the cron job. 0 and 7 are both for Sundays. If set to it will become '*' at creation time.

Default value: undef

afs_suidcells

Data type: Variant[Array[String], String]

Array of strings with content of the file $afs_config_path/SuidCells. This file will be ignored if the default value is not changed.

Default value: []

cache_path

Data type: Stdlib::Unixpath

Path to cache storage when using disk cache. Recommended: use a dedicated partition as disk cache.

Default value: undef

cache_size

Data type: Integer

Cache size in kb. '1000000' = 1GB is a good value for single user systems '4000000' = 4GB is a good value for terminal servers ACHTUNG!: real occupied space can be 5% larger, due to metadata

Default value: 1000000

config_client_args

Data type: String

AFSD_ARGS / parameters to be passed to AFS daemon while starting. Since 1.6.x the afs-client has integrated auto-tuning. Specifying more options for tuning should only be applied after monitoring the system. Candidates for tuning: -stat, -volumes

Default value: '-dynroot -afsdb -daemons 6 -volumes 1000'

config_client_clean_cache_on_start

Data type: Boolean

Boolean trigger for the cleaning of the client cache on start. If set to true, client cache will be cleaned when starting the service. Please check openafs-client config file for supported OS families.

Default value: false

config_client_dkms

Data type: Boolean

Boolean to control the AFS kernel module handling via DKMS or the openafs start-script. At the moment only available on RHEL platform. It will be ignored on other platforms.

Default value: undef

config_client_path

Data type: Stdlib::Unixpath

Path to the openafs-client configuration file.

Default value: undef

config_client_update

Data type: Boolean

Boolean trigger for the selfupdating routine in the start script. If set to true, checks for updated AFS packages in the available repositories and installs them.

Default value: false

create_symlinks

Data type: Boolean

Create symlinks for convenient access to AFS structure. Path and target are taken from hash in $links.

Default value: false

links

Data type: Hash

Hash of path and target to create symlinks from if $create_links is true.

Default value: {}

package_name

Data type: Variant[Array[String], String]

Array or string of needed OpenAFS packages.

Default value: undef

service_provider

Data type: Optional[String]

String of which service provider should be used

Default value: undef

Defined types

afs::validate_domain_names

== Define: afs::validate_domain_names iteration in Puppet 3 style