Skip to content

Commit 1f9e843

Browse files
Update note elements 14 (#253)
1 parent ef536e2 commit 1f9e843

File tree

5 files changed

+57
-37
lines changed

5 files changed

+57
-37
lines changed

how-to/installation/netboot-the-server-installer-via-uefi-pxe-on-arm-aarch64-arm64-and-x86-64-amd64.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@ The GRUB binary helps us redirect the download path to the target files via `gru
6565
$ sudo wget http://ports.ubuntu.com/ubuntu-ports/dists/focal/main/uefi/grub2-arm64/current/grubnetaa64.efi.signed -O /var/lib/tftpboot/grubnetaa64.efi.signed
6666
```
6767

68-
> **Note**:
69-
> You may need to change **the archive distribution's name** from `Focal` to your target distribution name.
68+
```{note}
69+
You may need to change **the archive distribution's name** from `Focal` to your target distribution name.
70+
```
7071

7172
### Download and serve more files
7273

how-to/observability/install-munin.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ On `server01` edit the `/etc/munin/munin.conf` file, adding the IP address for `
3535
address 172.18.100.101
3636
```
3737

38-
> **Note**:
39-
> Replace `server02` and `172.18.100.101` with the actual hostname and IP address for your server.
38+
```{note}
39+
Replace `server02` and `172.18.100.101` with the actual hostname and IP address for your server.
40+
```
4041

4142
## Configure `munin-node`
4243

@@ -46,8 +47,9 @@ Next, configure `munin-node` on `server02`. Edit `/etc/munin/munin-node.conf` to
4647
allow ^172\.18\.100\.100$
4748
```
4849

49-
> **Note**:
50-
> Replace `^172\.18\.100\.100$` with the IP address for your `munin` server.
50+
```{note}
51+
Replace `^172\.18\.100\.100$` with the IP address for your `munin` server.
52+
```
5153

5254
Now restart `munin-node` on `server02` for the changes to take effect:
5355

how-to/observability/install-nagios.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
(install-nagios)=
22
# How to install and configure Nagios Core 3
33

4-
> **Note**:
5-
> Nagios Core 3 has been deprecated and is now replaced by Nagios Core 4. The `nagios3` package was last supported in Bionic, so subsequent releases should use `nagios4` instead.
4+
```{note}
5+
Nagios Core 3 has been deprecated and is now replaced by Nagios Core 4. The `nagios3` package was last supported in Bionic, so subsequent releases should use `nagios4` instead.
6+
```
67

78
The monitoring of essential servers and services is an important part of system administration. This guide walks through how to install and configure Nagios Core 3 for availability monitoring.
89

@@ -40,8 +41,9 @@ Next, on `server02` install the `nagios-nrpe-server` package. From a terminal on
4041
sudo apt install nagios-nrpe-server
4142
```
4243

43-
> **Note**:
44-
> NRPE allows you to execute local checks on remote hosts. There are other ways of accomplishing this through other Nagios plugins, as well as other checks.
44+
```{note}
45+
NRPE allows you to execute local checks on remote hosts. There are other ways of accomplishing this through other Nagios plugins, as well as other checks.
46+
```
4547

4648
## Configuration overview
4749

@@ -57,8 +59,9 @@ There are a couple of directories containing Nagios configuration and check file
5759

5860
There are multiple checks Nagios can be configured to execute for any given host. For this example, Nagios will be configured to check disk space, {term}`DNS`, and a MySQL {term}`hostgroup`. The DNS check will be on `server02`, and the MySQL hostgroup will include both `server01` and `server02`.
5961

60-
> **Note**:
61-
> See these guides for details on [setting up Apache](https://discourse.ubuntu.com/t/web-servers-apache/11510), [Domain Name Service](https://discourse.ubuntu.com/t/service-domain-name-service-dns/11318), and [MySQL](https://discourse.ubuntu.com/t/databases-mysql/11515).
62+
```{note}
63+
See these guides for details on [setting up Apache](https://discourse.ubuntu.com/t/web-servers-apache/11510), [Domain Name Service](https://discourse.ubuntu.com/t/service-domain-name-service-dns/11318), and [MySQL](https://discourse.ubuntu.com/t/databases-mysql/11515).
64+
```
6265

6366
Additionally, there are some terms that once explained will hopefully make understanding Nagios configuration easier:
6467

@@ -85,9 +88,11 @@ First, create a **host** configuration file for `server02`. Unless otherwise spe
8588
```bash
8689
sudo cp /etc/nagios3/conf.d/localhost_nagios2.cfg \
8790
/etc/nagios3/conf.d/server02.cfg
88-
89-
> **Note**:
90-
> In all command examples, replace "`server01`", "`server02`", `172.18.100.100`, and `172.18.100.101` with the host names and IP addresses of your servers.
91+
```
92+
93+
```{note}
94+
In all command examples, replace "`server01`", "`server02`", `172.18.100.100`, and `172.18.100.101` with the host names and IP addresses of your servers.
95+
```
9196

9297
### Edit the host config file
9398

@@ -148,9 +153,10 @@ The Nagios check needs to authenticate to MySQL. To add a `nagios` user to MySQL
148153
mysql -u root -p -e "create user nagios identified by 'secret';"
149154
```
150155

151-
> **Note**:
152-
> The `nagios` user will need to be added to all hosts in the **mysql-servers** hostgroup.
153-
156+
```{note}
157+
The `nagios` user will need to be added to all hosts in the **mysql-servers** hostgroup.
158+
```
159+
154160
Restart nagios to start checking the MySQL servers.
155161

156162
sudo systemctl restart nagios3.service

how-to/observability/set-up-your-lma-stack.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
(set-up-your-lma-stack)=
22
# Set up your LMA stack
33

4-
> **LMA to COS**
5-
> The LMA stack is being succeeded by the Canonical Observability Stack (COS). While the current LMA still works, most users are recommended to consider COS instead. For more information, refer to [this COS topic](https://charmhub.io/topics/canonical-observability-stack/). In environments with more limited resources, there is also [COS lite](https://charmhub.io/topics/canonical-observability-stack/editions/lite).
4+
```{note}
5+
**LMA to COS**
6+
7+
The LMA stack is being succeeded by the Canonical Observability Stack (COS). While the current LMA still works, most users are recommended to consider COS instead. For more information, refer to [this COS topic](https://charmhub.io/topics/canonical-observability-stack/). In environments with more limited resources, there is also [COS lite](https://charmhub.io/topics/canonical-observability-stack/editions/lite).
8+
```
69

710
Logging, Monitoring, and Alerting (LMA) is a collection of tools that guarantee the availability of your running infrastructure. Your LMA stack will help point out issues in load, networking, and other resources before they become a failure point.
811

how-to/observability/use-nagios-with-munin.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
(use-nagios-with-munin)=
22
# How to use Nagios with Munin
33

4-
> **Note**:
5-
> Nagios Core 3 has been deprecated and is now replaced by Nagios Core 4. The `nagios3` package was last supported in Bionic, so subsequent releases should use `nagios4` instead.
4+
```{note}
5+
Nagios Core 3 has been deprecated and is now replaced by Nagios Core 4. The `nagios3` package was last supported in Bionic, so subsequent releases should use `nagios4` instead.
6+
```
67

78
The monitoring of essential servers and services is an important part of system administration. Most network services are monitored for performance, availability, or both. This section will cover installation and configuration of Nagios 3 for availability monitoring alongside Munin for performance monitoring.
89

@@ -40,8 +41,9 @@ Next, on `server02` install the `nagios-nrpe-server` package. From a terminal on
4041
sudo apt install nagios-nrpe-server
4142
```
4243

43-
> **Note**:
44-
> NRPE allows you to run local checks on remote hosts. There are other ways of accomplishing this, including through other Nagios plugins.
44+
```{note}
45+
NRPE allows you to run local checks on remote hosts. There are other ways of accomplishing this, including through other Nagios plugins.
46+
```
4547

4648
### Configuration overview
4749

@@ -59,8 +61,9 @@ There are a few directories containing Nagios configuration and check files.
5961

6062
There are many checks Nagios can be configured to run for any particular host. In this example, Nagios will be configured to check disk space, {term}`DNS`, and a MySQL {term}`host group <hostgroup>`. The DNS check will be on `server02`, and the MySQL host group will include both `server01` and `server02`.
6163

62-
> **Note**:
63-
> See these additional guides for details on setting up {ref}`Apache <install-apache2>`, {ref}`Domain Name Service (DNS) <install-dns>`, and {ref}`MySQL <install-mysql>`.
64+
```{note}
65+
See these additional guides for details on setting up {ref}`Apache <install-apache2>`, {ref}`Domain Name Service (DNS) <install-dns>`, and {ref}`MySQL <install-mysql>`.
66+
```
6467

6568
Additionally, there are some terms that once explained will hopefully make understanding Nagios configuration easier:
6669

@@ -87,8 +90,9 @@ sudo cp /etc/nagios3/conf.d/localhost_nagios2.cfg \
8790
/etc/nagios3/conf.d/server02.cfg
8891
```
8992

90-
> **Note**:
91-
> In the above and following command examples, replace "`server01`", "`server02`", `172.18.100.100`, and `172.18.100.101` with the host names and IP addresses of your servers.
93+
```{note}
94+
In the above and following command examples, replace "`server01`", "`server02`", `172.18.100.100`, and `172.18.100.101` with the host names and IP addresses of your servers.
95+
```
9296

9397
Next, edit `/etc/nagios3/conf.d/server02.cfg`:
9498

@@ -143,9 +147,10 @@ The Nagios check needs to authenticate to MySQL. To add a `nagios` user to MySQL
143147
```bash
144148
mysql -u root -p -e "create user nagios identified by 'secret';"
145149
146-
> **Note**:
147-
> The `nagios` user will need to be added all hosts in the `mysql-servers` host group.
148-
150+
```{note}
151+
The `nagios` user will need to be added all hosts in the `mysql-servers` host group.
152+
```
153+
149154
Restart Nagios to start checking the MySQL servers.
150155

151156
```bash
@@ -220,8 +225,9 @@ On `server01` edit the `/etc/munin/munin.conf` to add the IP address for `server
220225
address 172.18.100.101
221226
```
222227

223-
> **Note**:
224-
> Replace `server02` and `172.18.100.101` with the actual hostname and IP address of your server.
228+
```{note}
229+
Replace `server02` and `172.18.100.101` with the actual hostname and IP address of your server.
230+
```
225231

226232
### Configure munin-node on server02
227233

@@ -231,8 +237,9 @@ To configure `munin-node` on `server02`, edit `/etc/munin/munin-node.conf` to al
231237
allow ^172\.18\.100\.100$
232238
```
233239

234-
> **Note**:
235-
> Replace `^172\.18\.100\.100$` with IP address for your Munin server.
240+
```{note}
241+
Replace `^172\.18\.100\.100$` with IP address for your Munin server.
242+
```
236243

237244
Now restart `munin-node` on `server02` for the changes to take effect:
238245

@@ -242,8 +249,9 @@ sudo systemctl restart munin-node.service
242249

243250
Finally, in a browser go to `http://server01/munin`, and you should see links to some graphs displaying information from the standard `munin-plugins` for disk, network, processes, and system.
244251

245-
> **Note**:
246-
> Since this is a new install it may take some time for the graphs to display anything useful.
252+
```{note}
253+
Since this is a new install it may take some time for the graphs to display anything useful.
254+
```
247255

248256
### Additional plugins
249257

0 commit comments

Comments
 (0)