update gerrit list
[openafs-wiki.git] / admin / RpmClientInstallationWithDKMS.mdwn
1
2 # Introduction
3
4 This page describes how to install the OpenAFS client on RPM-based Linux
5 distributions using the Dynamic Kernel Module Support (DKMS) framework. Modules
6 installed with DKMS are automatically rebuilt when a new kernel is installed.
7
8 ## Setup
9
10 The DKMS system is available in the base system on Fedora systems and is
11 available in the 'Extra Packages for Enterprise Linux' (EPEL) on Red Hat
12 and CentOS systems.  Add the EPEL repository to your Red Hat/CentOS system
13 with:
14
15     $ sudo yum install epel-release
16
17 It is recommended to be running a recent kernel release. If the system has just
18 been installed, or has not been updated recently, be sure to update the kernel
19 release with:
20
21     $ sudo yum update kernel
22     $ sudo reboot
23
24 Install the kernel development package for your running kernel version:
25
26     $ sudo yum install "kernel-devel-uname-r == $(uname -r)"
27
28 Be sure you are running a recent kernel version as described above, or you may
29 in encounter the error:
30
31     Error: Unable to find a match: kernel-devel-uname-r == <version>
32
33 If you are installing OpenAFS 1.8.6 or older, ensure the `make` program
34 is present before installing the OpenAFS packages.
35
36     $ sudo yum install make
37
38
39 ## OpenAFS RPM package files
40
41 First, you will need to download or build OpenAFS RPM package files, or have
42 access to a yum repository which contains the OpenAFS RPM package files.
43
44 See [[devel/HowToBuildOpenAfsRpmPackages]] for instructions on how to build the
45 RPM package files.
46
47 The following is a yum repo configuration file for a public yum repo of
48 prebuilt OpenAFS RPM package files. To use this repository, copy this file to
49 `/etc/yum.repos.d/sna-openafs.repo`.
50
51     [sna-openafs]
52     name=SNA OpenAFS
53     baseurl=https://download.sinenomine.net/openafs/rpms/el$releasever/$basearch
54     enabled=1
55     gpgcheck=0
56
57
58 ## OpenAFS client installation
59
60 Install the OpenAFS client with yum (or dnf):
61
62     $ sudo yum install openafs openafs-krb5 openafs-doc dkms-openafs
63
64 Be sure to install the `openafs` package and the `dkms-openafs` package with a
65 single `yum install` invocation.
66
67 Edit the `/usr/vice/etc/ThisCell` file to configure your cellname.
68
69     $ sudo bash -c 'echo example.com > /usr/vice/etc/ThisCell'
70
71 Edit the `/usr/vice/etc/CellServDB.local` file to configure your AFS database
72 locations. The `CellServDB.local` file may be blank if your site uses DNS
73 service records (SRV records) to publish the OpenAFS database server addresses.
74 Here is an example `CellServDB.local` file to illustrate the file format:
75
76     >example.com         # Example
77     192.168.10.100       # afsdb1.example.com
78     192.168.10.101       # afsdb2.example.com
79     192.168.10.102       # afsdb3.example.com
80
81 Start the OpenAFS client with:
82
83     $ sudo systemctl enable openafs-client
84     $ sudo systemctl start openafs-client
85     $ sudo systemctl status openafs-client
86     ...
87     Nov 04 15:20:28 cen8 systemd[1]: Started OpenAFS Client Service.
88     Nov 04 15:20:28 cen8 afsd[113313]: afsd: All AFS daemons started.
89
90 The kernel module should be loaded:
91
92     $ lsmod | grep openafs
93     openafs              2830336  2
94
95 The AFS filesystem should be mounted:
96
97     $ mount | grep AFS
98     AFS on /afs type afs (rw,relatime)