system-config/roles/openafs-client/README.rst
Ian Wienand 801e7c9bd0 Add openafs-client role
The role sets up a host as an OpenAFS client.

As noted in the README, OpenAFS is not available in every
distribution, or on every architecture.  The goal is to provide
sensible defaults but allow for flexibility.

This is largely a port of the client parts of
openstack-infra/puppet-openafs.

This is a generic role because it will be used from Zuul jobs
(wheel-builds) and in the control-plane (servers mounting AFS)

Tested-By: https://review.openstack.org/589335
Needed-By: https://review.openstack.org/590636
Change-Id: Iaaa18194baca4ebd37669ea00505416ebf6c884c
2018-08-23 21:34:47 +10:00

47 lines
1.6 KiB
ReStructuredText

An ansible role to configure an OpenAFS client
.. note:: This role uses system packages where available, but for
platforms or architectures where they are not available will
require external builds. Defaults will pick external
packages from OpenStack Infra builds, but you should
evaluate if this is suitable for your environment.
This role configures the host to be an `OpenAFS
<https://www.openafs.org>`__ client. Because OpenAFS is very reliant
on distribution internals, kernel versions and host architecture this
role has limited platform support. Currently supported are
* Debian family with system packages available
* Ubuntu Xenial with ARM64, with external 1.8 series packages
* CentOS 7 with external packages
**Role Variables**
.. zuul:rolevar:: openafs_client_cell
:default: openstack.org
The default cell
.. zuul:rolevar:: openafs_client_cache_size
:default: 500000
The AFS client cache size, in kilobytes
.. zuul:rolevar:: openafs_client_yum_repo_url
:default: ``https://tarballs.openstack.org/project-config/package-afs-centos7``
The URL to a yum/dnf repository with the OpenAFS client RPMs.
These are assumed to be created from the ``.spec`` file included in
the OpenAFS distribution.
.. zuul:rolevar:: openafs_client_yum_repo_gpg_check
:default: no
Enable or disable gpg checking for ``openafs_yum_repo_url``
.. zuul:rolevar:: openafs_client_apt_repo
:default: ppa:openstack-ci-core/openafs-arm64
Source string for APT repository for Debian family hosts requiring
external packages (currently ARM64)