Skip to content

Commit 75caa6a

Browse files
bene2k1nerda-codesRoRoJ
authored
feat(tuto): tutorial reviews 30/12 (#4165)
* feat(tuto): tutorial reviews 30/12 * fix(tuto): fix typo * Apply suggestions from code review Co-authored-by: nerda-codes <[email protected]> Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: nerda-codes <[email protected]> Co-authored-by: Rowena Jones <[email protected]>
1 parent 807a1c0 commit 75caa6a

File tree

13 files changed

+235
-291
lines changed

13 files changed

+235
-291
lines changed

tutorials/easydeploy-gitlab-server/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: GitLab server kubernetes easy deploy
99
categories:
1010
- containers
1111
dates:
12-
validation: 2024-06-20
12+
validation: 2025-01-02
1313
posted: 2024-06-20
1414
validation_frequency: 24
1515
---

tutorials/install-ispconfig/index.mdx

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ categories:
1010
- domains-and-dns
1111
tags: hosting ISPconfig Ubuntu Linux
1212
dates:
13-
validation: 2024-06-25
13+
validation: 2025-01-02
1414
posted: 2019-01-25
1515
---
1616

17-
ISPConfig is an open-source, transparent, free, stable, and secure administration tool, available in more than 20 languages. ISPConfig simplifies the management of various web hosting services such as DNS configuration, domain name management, email, or FTP file transfer. It can be used to manage a single server, multiple servers for larger setups, or even mirrored clusters.
17+
ISPConfig is an open-source, transparent, free, stable, and secure administration tool, available in more than 20 languages.
18+
ISPConfig simplifies the management of various web hosting services such as DNS configuration, domain name management, email, or FTP file transfer.
19+
It can be used to manage a single server, multiple servers for larger setups, or even mirrored clusters.
1820

1921
<Macro id="requirements" />
2022

@@ -30,12 +32,12 @@ ISPConfig is an open-source, transparent, free, stable, and secure administratio
3032

3133
1. [Log into your Instance](/compute/instances/how-to/connect-to-instance/) via SSH using the root account.
3234
2. Update and upgrade the software already installed on the Instance.
33-
```
35+
```bash
3436
apt update && apt upgrade -y
3537
```
3638
3. Configure the hostname of your Instance.
3739
* Open the `/etc/hosts` file in a text editor and ensure it looks like the following example: `IP address - space - subdomain.domain.tld - space - subdomain`.
38-
```s
40+
```
3941
127.0.0.1 localhost.localdomain localhost
4042
# This line should be changed to the correct servername:
4143
127.0.1.1 server1.example.com server1
@@ -50,11 +52,11 @@ ISPConfig is an open-source, transparent, free, stable, and secure administratio
5052
</Message>
5153
* Edit the file `/etc/hostname` and make sure it contains only the subdomain part of the hostname (e.g. `server1`).
5254
4. Reboot the Instance to apply the hostname configuration.
53-
```
55+
```bash
5456
systemctl reboot
5557
```
5658
5. Login again and check the hostname configuration using the following commands:
57-
```
59+
```bash
5860
hostname
5961
hostname -f
6062
```
@@ -66,13 +68,13 @@ ISPConfig is an open-source, transparent, free, stable, and secure administratio
6668
<Message type="important">
6769
Ensure a corresponding DNS record (A and/or AAAA) for the subdomain exists in your DNS zone and is pointing to the IP of your Instance.
6870
</Message>
69-
6. Download and run the ISPConfig auto-installer to install the panel with Nginx web server, a port range for passive FTP and unattended upgrades:
70-
```
71+
6. Download and run the ISPConfig auto-installer to install the panel with Nginx web server, a port range for passive FTP, and unattended upgrades:
72+
```bash
7173
wget -O - https://get.ispconfig.org | sh -s -- --use-nginx --use-ftp-ports=40110-40210 --unattended-upgrades
7274
```
7375
<Message type="tip">
74-
If you want to install the Apache web server instead of Nginx run the following command instead:
75-
```
76+
If you want to install the Apache web server instead of Nginx, run the following command instead:
77+
```bash
7678
wget -O - https://get.ispconfig.org | sh -s -- --use-ftp-ports=40110-40210 --unattended-upgrades
7779
```
7880
</Message>
@@ -91,7 +93,7 @@ ISPConfig is an open-source, transparent, free, stable, and secure administratio
9193
```
9294
</Message>
9395

94-
## Configuring the firewall
96+
## Configuring the firewall
9597

9698
1. Open the ISPConfig UI (e.g. `https://server1.example.com:8080`) and log in with your credentials.
9799

@@ -111,4 +113,4 @@ ISPConfig is an open-source, transparent, free, stable, and secure administratio
111113

112114
6. Once you have added the necessary records, save the firewall configuration.
113115

114-
You now have finished the basic configuration of your server using ISPConfig. For further information and avanced configuration of your server, refer to the [official ISPConfig documentation](https://www.ispconfig.org/documentation/).con
116+
You now have finished the basic configuration of your server using ISPConfig. For further information and advanced configuration of your server, refer to the [official ISPConfig documentation](https://www.ispconfig.org/documentation/).

tutorials/k8s-gitlab/index.mdx

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ categories:
1010
- kubernetes
1111
- instances
1212
dates:
13-
validation: 2024-06-17
13+
validation: 2025-01-02
1414
posted: 2020-06-09
1515
---
1616

@@ -33,14 +33,22 @@ In this tutorial, you will learn how to use the `gitlab` Kubernetes integration
3333

3434
In this tutorial, we use `helm` to deploy a `gitlab` runner on a `Kapsule` cluster.
3535

36-
If you do not know how to install `helm`, follow the [tutorial](https://helm.sh/docs/intro/install/) on the official `helm` website.
36+
Ensure you're using the latest version of Helm, which is Helm 3.16.2.
3737

38-
In the example below we have successfully installed `helm` version 3.2.0.
38+
#### Installation Steps:
3939

40-
```
41-
helm version
42-
version.BuildInfo{Version:"v3.2.0", GitCommit:"e11b7ce3b12db2941e90399e874513fbd24bcb71", GitTreeState:"clean", GoVersion:"go1.13.10"}
43-
```
40+
1. Download Helm
41+
```bash
42+
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
43+
chmod 700 get_helm.sh
44+
./get_helm.sh
45+
```
46+
47+
2. Verify the installation:
48+
```bash
49+
helm version
50+
```
51+
Ensure the output shows version 3.16.2.
4452

4553
The `helm` charts are provided through repositories. By default `helm` 3 does not have any repository configured.
4654
We will add the `gitlab` repository, as it provides the necessary chart to install the runner.
@@ -60,7 +68,7 @@ A `helm` chart is always shipped with a `value.yaml` file. It can be edited to c
6068

6169
In this part of the tutorial we customize the `value.yaml` to fit our needs and deploy the runner on `kapsule`.
6270

63-
1. Get the value.yaml:
71+
1. Fetch the latest `values.yaml` file:
6472
```
6573
wget https://gitlab.com/gitlab-org/charts/gitlab-runner/-/raw/main/values.yaml
6674
```
@@ -71,31 +79,26 @@ In this part of the tutorial we customize the `value.yaml` to fit our needs and
7179
<Lightbox src="scaleway-token.webp" alt="" />
7280

7381
<Lightbox src="scaleway-token.webp" alt="" />
74-
2. Fill the `value.yaml` with:
75-
- the gitlabUrl (in our case `http://212.47.xxx.yyy/`)
76-
- the registration token
77-
- enable `rbac`
78-
79-
<Message type="note">
80-
By default, the gitlabUrl and the registration token lines are written as a comment in the `values.yaml`file. Make sure you have deleted the `#` before saving.
81-
</Message>
8282

83+
2. Open the file in a text editor and update the following fields in `values.yaml`:
8384
```yaml
84-
[..]
85-
gitlabUrl: http://212.47.xxx.yyy/
86-
runnerRegistrationToken: "t7u_qjh3EFJX2-yPypkz"
85+
gitlabUrl: http://<your-gitlab-instance>/
86+
runnerRegistrationToken: "<your-registration-token>"
8787
rbac:
8888
create: true
89-
[..]
9089
serviceAccountName: default
9190
```
91+
Ensure you replace `<your-gitlab-instance>` and `<your-registration-token>` with your actual GitLab instance URL and registration token.
9292

93-
We will use a dedicated [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/).
94-
3. To install the `gitlab` runner, create it on your `Kapsule` cluster:
93+
<Message type="tip">
94+
By default, the gitlabUrl and the registration token lines are written as a comment in the `values.yaml`file. Make sure you have deleted the `#` before saving.
95+
</Message>
96+
97+
3. To install the `gitlab` runner, create it on your `Kapsule` cluster. We will use a dedicated [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/).
9598
```
9699
kubectl create ns gitlab-runner
97-
namespace/gitlab-runner created
98100
```
101+
The following output displays `namespace/gitlab-runner created`.
99102
100103
The default service account should use a new Kubernetes [role](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-example), and [rolebinding](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-example).
101104
4. Use the following example to create a role and role binding and associate it to the default service account in the `gitlab-runner` namespace:
@@ -121,7 +124,7 @@ In this part of the tutorial we customize the `value.yaml` to fit our needs and
121124
```
122125
5. Use the `helm` command to install the runner (note that you specify in this command line the `values.yaml` file):
123126
```
124-
helm install --namespace gitlab-runner gitlab-runner -f ./values.yaml gitlab/gitlab-runner
127+
helm install --namespace gitlab-runner gitlab-runner -f ./values.yaml gitlab/gitlab-runner --version 0.68.1
125128
NAME: gitlab-runner
126129
LAST DEPLOYED: Wed May 6 15:48:20 2020
127130
NAMESPACE: gitlab-runner
@@ -131,7 +134,7 @@ In this part of the tutorial we customize the `value.yaml` to fit our needs and
131134
NOTES:
132135
Your GitLab Runner should now be registered against the GitLab instance reachable at: "http://212.47.xxx.yyy/"
133136
```
134-
137+
The command above installs the GitLab Runner Helm chart version 0.68.1 in the `gitlab-runner` namespace.
135138
You can check the runner is working in the `gitlab` console ("admin area" > runners):
136139
<Lightbox src="scaleway-runnerok.webp" alt="" />
137140

tutorials/k8s-velero-backup/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
meta:
33
title: Back up your Kapsule cluster on Object Storage with Velero
4-
description: Learn how to configure Velero to back up your Kubernetes Kapsule cluster on Object Storage in this tutorial.
4+
description: Learn how to configure Velero to back up your Kubernetes Kapsule cluster on Scaleway Object Storage in this tutorial.
55
content:
66
h1: Back up your Kapsule cluster on Object Storage with Velero
7-
paragraph: Learn how to configure Velero to back up your Kubernetes Kapsule cluster on Object Storage in this tutorial.
7+
paragraph: Learn how to configure Velero to back up your Kubernetes Kapsule cluster on Scaleway Object Storage in this tutorial.
88
tags: velero k8s kubernetes kapsule object-storage
99
categories:
1010
- kubernetes
1111
- object-storage
1212
dates:
13-
validation: 2024-06-25
13+
validation: 2025-01-02
1414
posted: 2023-06-02
1515
---
1616

tutorials/librenms-monitoring/index.mdx

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
meta:
3-
title: Monitoring Instances with LibreNMS on Ubuntu Focal Fossa
3+
title: Monitoring Instances with LibreNMS on Ubuntu Noble Numbat (24.04)
44
description: Learn how to monitor Instances using LibreNMS, an open-source PHP/MySQL network monitoring system.
55
content:
6-
h1: Monitoring Instances with LibreNMS on Ubuntu Focal Fossa
6+
h1: Monitoring Instances with LibreNMS on Ubuntu Noble Numbat (24.04)
77
paragraph: Learn how to monitor Instances using LibreNMS, an open-source PHP/MySQL network monitoring system.
88
tags: LibreNMS Ubuntu Focal-Fossa
99
categories:
1010
- instances
1111
dates:
12-
validation: 2024-06-25
12+
validation: 2025-01-02
1313
posted: 2019-07-04
1414
---
1515

16-
LibreNMS is a fully-featured network monitoring system that supports a wide range of network hardware and operating systems including Linux and Windows. As well as network equipment made by Cisco, Juniper, Foundry, and many more.
16+
Learn how to use LibreNMS to monitor Instances on Ubuntu 24.04 (Noble Numbat). LibreNMS is an open-source network monitoring system supporting a wide range of network hardware and operating systems, including Linux and Windows.
1717

1818
The software is based on PHP and MySQL (MariaDB) and is a community-based fork of the last GPL-licensed version of Observium.
1919

@@ -22,49 +22,38 @@ The software is based on PHP and MySQL (MariaDB) and is a community-based fork o
2222
- A Scaleway account logged into the [console](https://console.scaleway.com)
2323
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2424
- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
25-
- An [Instance](/compute/instances/how-to/create-an-instance/) running on Ubuntu Focal Fossa Beaver
25+
- An [Instance](/compute/instances/how-to/create-an-instance/) running on Ubuntu Noble Numbat (24.04)
2626
- A [domain or subdomain](/network/domains-and-dns/quickstart/) pointed to your Instance
2727

2828
## Installing LibreNMS
2929

30-
1. Update the apt repository information.
30+
1. Update the apt package cache and upgrate the already installed system packages:
3131
```
32-
apt update
32+
apt update && apt upgrade -y
3333
```
3434
2. Install the required packages.
3535
```
36-
apt install software-properties-common
37-
add-apt-repository universe
38-
apt update
39-
apt install acl curl composer fping git graphviz imagemagick mariadb-client mariadb-server mtr-tiny nginx-full nmap php7.4-cli php7.4-curl php7.4-fpm php7.4-gd php7.4-json php7.4-mbstring php7.4-mysql php7.4-snmp php7.4-xml php7.4-zip python3-memcache python3-mysqldb python3-pip rrdtool snmp snmpd whois
36+
apt install -y acl curl composer fping git graphviz imagemagick mariadb-client mariadb-server mtr-tiny nginx-full nmap php-cli php-curl php-fpm php-gd php-json php-mbstring php-mysql php-snmp php-xml php-zip python3-memcache python3-mysqldb python3-pip rrdtool snmp snmpd whois
4037
```
4138
3. Create a user for LibreNMS:
4239
```
43-
useradd librenms -d /opt/librenms -M -r
44-
usermod -a -G librenms www-data
45-
```
46-
4. Enter the directory `/opt` and download LibreNMS:
40+
useradd -r -M -d /opt/librenms librenms
41+
usermod -aG librenms www-data
4742
```
48-
cd /opt
49-
git clone https://github.com/librenms/librenms.git
50-
```
51-
5. Set the permissions:
43+
4. Download and configure LibreNMS:
5244
```
45+
git clone https://github.com/librenms/librenms.git /opt/librenms
5346
chown -R librenms:librenms /opt/librenms
5447
chmod 770 /opt/librenms
5548
setfacl -d -m g::rwx /opt/librenms/rrd /opt/librenms/logs /opt/librenms/bootstrap/cache/ /opt/librenms/storage/
5649
setfacl -R -m g::rwx /opt/librenms/rrd /opt/librenms/logs /opt/librenms/bootstrap/cache/ /opt/librenms/storage/
5750
```
58-
6. Switch into the `librenms` user:
59-
```
60-
su - librenms
61-
```
62-
7. Install the PHP dependencies:
51+
52+
5. Install PHP dependencies:
6353
```
54+
sudo -u librenms bash
55+
cd /opt/librenms
6456
./scripts/composer_wrapper.php install --no-dev
65-
```
66-
8. Logout from the user session:
67-
```
6857
exit
6958
```
7059

@@ -88,8 +77,7 @@ LibreNMS stores the data collected from the monitored systems in a MySQL databas
8877
FLUSH PRIVILEGES;
8978
exit
9079
```
91-
92-
Replace `<a_secure_password>` with a secure password of your choice.
80+
Replace `<a_secure_password>` with a secure password of your choice.
9381
4. Open the file `/etc/mysql/mariadb.conf.d/50-server.cnf` in a text editor, for example `nano`:
9482
```
9583
nano /etc/mysql/mariadb.conf.d/50-server.cnf

tutorials/manage-database-instance-pgadmin4/index.mdx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ categories:
1010
- compute
1111
- postgresql-and-mysql
1212
dates:
13-
validation: 2024-06-25
13+
validation: 2025-01-02
1414
posted: 2019-10-28
1515
---
1616

17-
[pgAdmin](https://www.pgadmin.org/) is an open-source management tool for PostgreSQL databases. It allows the management of your [Scaleway Database Instances](https://www.scaleway.com/en/database/) and other PostgreSQL databases through an easy-to-use web-interface within your web browser.
17+
pgAdmin is an open-source management tool for PostgreSQL databases. It allows the management of your [Scaleway Database Instances](https://www.scaleway.com/en/database/) and other PostgreSQL databases through an easy-to-use web-interface within your web browser.
1818

1919
<Macro id="requirements" />
2020

@@ -29,14 +29,12 @@ dates:
2929

3030
1. [Connect to your Instance](/compute/instances/how-to/connect-to-instance/) via SSH.
3131
2. Update the `apt` sources and the software already installed on the Instance:
32-
3332
```
3433
apt update && apt upgrade -y
3534
```
36-
3. Import the PostgreSQL [repository key](https://www.postgresql.org/media/keys/ACCC4CF8.asc):
35+
3. Import the PostgreSQL repository signing key:
3736
```
38-
sudo apt-get install curl ca-certificates gnupg
39-
sudo curl https://www.pgadmin.org/static/packages_pgadmin_org.pub | sudo apt-key add
37+
curl -fsS https://www.pgadmin.org/static/packages_pgadmin_org.pub | sudo gpg --dearmor -o /usr/share/keyrings/packages-pgadmin-org.gpg
4038
```
4139
4. Add the PostgreSQL repository to the APT package manager, by configuring the file `/etc/apt/sources.list.d/pgdg.list`:
4240
```

0 commit comments

Comments
 (0)