system-config/roles/openafs-client/README.rst
Ian Wienand 4c5030e478
openafs-client: get logs better
I'm not sure if something changed in dkms, but this log file is
helpful on centos 9-stream and the other check doesn't match anything.

Also update the README.rst slightly to be more in line with reality.

Change-Id: Ic8cab980ef43490eb1b3ca0b7a0d0c2329bb94ce
2023-04-27 16:12:00 +10:00

53 lines
1.8 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
utilise external packages. Defaults will pick packages
built from the OpenDev infra project, 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 LTS family with external 1.8 series packages
* CentOS 7, 8-stream and 9-stream 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 OpenAFS client cache size, in kilobytes.
.. zuul:rolevar:: openafs_client_cache_directory
:default: /var/cache/openafs
The directory to store the OpenAFS cache files.
.. 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_service_timeout_sec
:default: 480
The TimeoutSec for service start. Accounting for the cache
during startup can cause a high load which may necessitate
a longer startup timeout on some platforms.