Skip to content

Commit 471835f

Browse files
committed
Add general admin docs
1 parent 46fd3b6 commit 471835f

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

docs/general.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# General
2+
3+
This page provides general administrative help and troubleshooting
4+
tips.
5+
6+
## Docker
7+
8+
### Host resolution errors
9+
10+
Sometimes Docker can have seemingly mysterious network issues, where
11+
you might see errors like this in the logs:
12+
13+
<!-- markdownlint-disable MD013 MD031 -->
14+
```bash
15+
*5 monitoring could not be resolved (3: Host not found), client: 192.168.0.66, server: proxysolr
16+
```
17+
<!-- markdownlint-enable MD013 MD031 -->
18+
19+
With a multi-node cluster, sometimes the overlay network can start having
20+
issues and needs to be recreated for that service. This can be done, by
21+
removing the service (or stack) and then redeploying it.
22+
23+
For example, to redeploy just `proxysolr` (since we don't want to remove
24+
the whole Solr stack):
25+
26+
```bash
27+
docker service rm catalog-preview-solr_proxysolr
28+
sudo pc-deploy catalog-preview solr-cloud
29+
```
30+
31+
But if it was the Monitoring application having issues, we'd be ok temporarily removing
32+
all those services and could just do this:
33+
34+
```bash
35+
docker stack rm catalog-preview-monitoring
36+
sudo pc-deploy catalog-preview monitoring
37+
```
38+
39+
### Upgrade errors
40+
41+
If you find you're having issues with a newer version of `docker.io`,
42+
(like we did with 28.2.2) you can revert it to your last working version,
43+
found in `/var/log/apt/history.log` using:
44+
45+
```bash
46+
# 27.5.1-0ubuntu3~22.04.2 was the version
47+
# from /var/log/apt/history.log that was running previously
48+
sudo apt install docker.io=27.5.1-0ubuntu3~22.04.2
49+
sudo apt-mark hold docker.io
50+
```
51+
52+
You can also review the [release notes](https://docs.docker.com/engine/release-notes/28/)
53+
to identify if there are known issues in the release that are fixed in newer releases,
54+
so you can safely remove the `apt-mark hold`.

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ questions or suggestions you have!
1616

1717
## Administration
1818

19+
* [General](general.md)
1920
* [Backup & Restore](backup-and-restore.md)
2021
* [Upgrading](upgrading.md)
2122
* [VuFind](vufind.md)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ nav:
3737
- Harvesting &amp; Importing: harvesting-and-importing.md
3838
- CI/CD: CICD.md
3939
- Administration:
40+
- General: general.md
4041
- Backup &amp; Restore: backup-and-restore.md
4142
- Upgrading: upgrading.md
4243
- VuFind: vufind.md

0 commit comments

Comments
 (0)