Skip to content

Commit 9d44b6a

Browse files
fix(gen): reviews 12/05 MTA-6035 (#4963)
* fix(gen): review product content * fix(tutos): changes * fix(tutos): sinatra * fix(tuto): chef * fix(tuto): chef2 * fix(tuto): netbox
1 parent fc40a60 commit 9d44b6a

File tree

12 files changed

+89
-97
lines changed

12 files changed

+89
-97
lines changed

pages/billing/additional-content/reading-an-invoice.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to read an invoice
88
tags: billing invoice payment
99
dates:
10-
validation: 2024-11-04
10+
validation: 2025-05-13
1111
posted: 2024-02-23
1212
categories:
1313
- billing

pages/environmental-footprint/additional-content/environmental-footprint-calculator-estimation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to understand the environmental footprint estimation of Scaleway products.
88
tags: environmental-footprint impact environment datacentre
99
dates:
10-
validation: 2024-10-30
10+
validation: 2025-05-13
1111
posted: 2024-10-30
1212
categories:
1313
- environmental-footprint

pages/environmental-footprint/how-to/track-monthly-footprint.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn to interpret and track your monthly environmental footprint report easily.
88
tags: environmental-footprint impact environment datacenter
99
dates:
10-
validation: 2024-10-30
10+
validation: 2025-05-13
1111
posted: 2024-10-30
1212
categories:
1313
- environmental-footprint
@@ -24,7 +24,7 @@ categories:
2424

2525
1. Click **Environmental Footprint** in the Organization drop-down menu to go to the **Environmental Footprint Overview** page. The **Environmental Footprint** dashboard appears, displaying the list of your current and past monthly reports.
2626
<Lightbox src="scaleway-env-foot-dashboard.webp" alt="" />
27-
2. Click the <Icon name="download" /> next to the month for the report you want to download.
27+
2. Click <Icon name="download" /> next to the month for the report you want to download.
2828
The monthly report is downloaded to your local computer in PDF format.
2929
3. Open the PDF file.
3030
4. Read through the document, considering the following elements on the page:

pages/transactional-email/api-cli/send-emails-with-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Steps to generate API keys for API and SMTP email sending.
88
tags: transactional email send multiple-headers send-emails
99
dates:
10-
validation: 2024-11-04
10+
validation: 2025-05-13
1111
posted: 2024-04-24
1212
categories:
1313
- managed-services

pages/transactional-email/concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn the fundamental concepts of Scaleway Transactional Email.
88
tags: managed-services deliverability dkim dns-propagation mx-record send-api smtp transactional spf
99
dates:
10-
validation: 2024-11-04
10+
validation: 2025-05-13
1111
categories:
1212
- managed-services
1313
---

pages/transactional-email/reference-content/smtp-configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page goes into detail about the different elements in a standard SMTP configuration, and how to fill out each entry to ensure an optimal configuration of Transactional Email services.
88
tags: smtp configuration forwarding port
99
dates:
10-
validation: 2024-11-04
10+
validation: 2025-05-13
1111
posted: 2024-05-02
1212
categories:
1313
- managed-services

tutorials/configure-chef-ubuntu-xenial/index.mdx

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: Chef Ubuntu Xenial Focal-Fossa
99
categories:
1010
- instances
1111
dates:
12-
validation: 2024-10-28
12+
validation: 2025-05-14
1313
posted: 2018-07-05
1414
---
1515

@@ -24,7 +24,7 @@ You can easily manage up to 10,000 nodes using Chef. Chef also makes it easy to
2424
- A Scaleway account logged into the [console](https://console.scaleway.com)
2525
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2626
- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)
27-
- One of the following remote machines running Ubuntu (this tutorial was validated for machines running Ubuntu Xenial or Ubuntu Focal Fossa):
27+
- One of the following remote machines running Ubuntu (this tutorial was validated for machines running Ubuntu 24.04 or previous:
2828
- An [Instance](/instances/how-to/create-an-instance/)
2929
- An [Elastic Metal server](/elastic-metal/how-to/create-server/)
3030
- A [Dedibox dedicated server](/dedibox/how-to/order-a-server/)
@@ -130,28 +130,29 @@ Creating an admin user enables a specific user to make changes to the infrastruc
130130

131131
For our example, we will create a user with the following information:
132132

133-
- **Username:** testuser
134-
- **First Name:** test
135-
- **Last Name:** user
136-
- **Email:** [email protected]
137-
- **Password:** pwdexample
138-
- **Filename:** testuser.pem
133+
- `USERNAME` - `testuser`
134+
- `FIRST_NAME` - `test`
135+
- `LAST_NAME` - `user`
136+
- `EMAIL` - `[email protected]`
137+
- `PASSWORD` - `pwdexample`
138+
- `FILENAME` - `testuser.pem`
139139

140-
We will also add `-f` option to specify a filename in which to output our new user's private RSA key. We will need this to authenticate using the `knife` management command later. In the end, the command translates to:
140+
We will also add `-f` option to specify a `FILENAME` in which to output our new user's private RSA key. We will need this to authenticate using the `knife` management command later. In the end, the command translates to:
141141

142142
```
143143
chef-server-ctl user-create testuser test user [email protected] pwdexample -f testuser.pem
144144
```
145145
2. Launch the `chef-server-ctl` with the `org-create` subcommand:
146146
```
147-
chef-server-ctl org-create SHORTNAME LONGNAME --association_user USERNAME
147+
chef-server-ctl org-create SHORTNAME LONGNAME --association_user ADMIN_USERNAME FILENAME
148148
```
149149

150150
For our example, we will create an organization with the following information:
151-
- **Short Name** (refers to the organization within Chef): scaleway
152-
- **Long Name** (name of the organization): Scaleway, Inc.
153-
- **Association User** (username that has access to administer the organization): testuser
154-
- **Filename:** scaleway-file.pem
151+
152+
- `SHORT_NAME` - Refers to the organization within Chef. In this example we use `scaleway`
153+
- `LONG_NAME` - The name of the organization. In this example, `Scaleway, Inc`
154+
- `ADMIN_USERNAME` - The username of a user with administration rights on the organization. In this example, `testuser`
155+
- `FILENAME` - `scaleway-file.pem`
155156

156157
Again, we will add the `-f` flag to specify the private key file location. The key that will be created is used to validate new clients as part of the organization until they can get their own unique client key. In the end, the command translates to:
157158

@@ -218,18 +219,18 @@ The method that you use to connect to the Chef server will determine how to down
218219

219220
#### Option 1: (Recommended) Downloading keys when connecting to a Chef server using SSH keys
220221

221-
1. Leave your workstation
222+
1. Leave your workstation.
222223
```
223224
exit
224225
```
225226

226-
The next steps should be carried out from the machine that holds the private SSH key needed to connect to your Chef server.
227+
The next steps should be carried out from the machine that holds the private SSH key needed to connect to your Chef server.
227228
2. Add the SSH key you use to connect to the Chef server to an SSH agent:
228229
```
229230
eval $(ssh-agent)
230231
```
231232

232-
which should start the agent and return something similar to
233+
Which should start the agent and return something similar to:
233234

234235
```
235236
Agent pid 2893
@@ -306,18 +307,18 @@ This is done through a `knife.rb` file that we will place in the `~/chef_repo/.c
306307
log_location STDOUT
307308
node_name "name_for_workstation"
308309
client_key "#{current_dir}/name_of_user_key"
309-
validation_client_name "organization_validator_name"
310+
validation_client_name "organization-validator"
310311
validation_key "#{current_dir}/organization_validator_key"
311312
chef_server_url "https://server_domain_or_public_IP/organizations/organization_name"
312313
syntax_check_cache_path "#{ENV['HOME']}/.chef/syntaxcache"
313314
cookbook_path ["#{current_dir}/../cookbooks"]
314315
```
315316

316-
- **node_name:** Specifies the name that knife will use to connect to your Chef server. This should match your username.
317-
- **client_key:** Name and path to the user key that you copied over from the Chef server. We can use the `#{current_dir}` snippet to fill in the path if the key is in the same directory as the `knife.rb` file.
318-
- **validation_client_name:** Name of the validation client that knife will use to bootstrap new nodes. This will take the form of your organization short name, followed by `-validator`.
319-
- **validation_key:** Like the `client_key`, this includes the name and path to the validation key you copied from the Chef server. Again, you can use the `#{current_dir}`.
320-
- **chef_server_url:** This is the URL where the Chef server can be reached. It should begin with `https://`, followed by your Chef server's domain name or **Public IP address**. Afterward, the path to your organization should be specified by appending /organizations/your_organization_name.
317+
- `node_name` - Specifies the name that knife will use to connect to your Chef server. This should match your username.
318+
- `client_key` - Name and path to the user key that you copied over from the Chef server. We can use the `#{current_dir}` snippet to fill in the path if the key is in the same directory as the `knife.rb` file.
319+
- `validation_client_name` - Name of the validation client that knife will use to bootstrap new nodes. This will take the form of your organization short name, followed by `-validator`.
320+
- `validation_key` - Like the `client_key`, this includes the name and path to the validation key you copied from the Chef server. Again, you can use the `#{current_dir}`.
321+
- `chef_server_url` - This is the URL where the Chef server can be reached. It should begin with `https://`, followed by your Chef server's domain name or **Public IP address**. Afterward, the path to your organization should be specified by appending /organizations/your_organization_name.
321322

322323
For our tutorial, the file looks like this:
323324

tutorials/configure-netbox-managed-postgresql-database/index.mdx

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ categories:
1010
- postgresql-and-mysql
1111
hero: assets/scaleway_netbox.webp
1212
dates:
13-
validation: 2024-10-29
13+
validation: 2025-05-14
1414
posted: 2019-11-14
1515
---
1616

@@ -24,30 +24,20 @@ In this tutorial, you learn how to install and configure NetBox on an Instance r
2424
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2525
- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)
2626
- An [Instance](/instances/how-to/create-an-instance/) running Ubuntu Focal Fossa (20.04 LTS) or later
27-
- A [Database for PostgreSQL](/managed-databases-for-postgresql-and-mysql/quickstart/)
27+
- A [Managed Database for PostgreSQL](/managed-databases-for-postgresql-and-mysql/quickstart/)
2828

2929
## Configuring the database
3030

3131
NetBox requires a PostgreSQL database. Configure your [Database for PostgreSQL](https://www.scaleway.com/en/database/) with a few steps from your [Scaleway console](https://console.scaleway.com/rdb/instances)
3232

3333
1. Enter the Databases section of your [Scaleway console](https://console.scaleway.com/rdb/instances) by clicking on **Managed Databases** in the side menu.
34-
2. Click the name of the Database you want to use to view the Instance's details:
35-
<Lightbox src="scaleway-db_instance_list.webp" alt="" />
36-
3. Click the **Managed Databases** tab to view the databases of your Instance.
37-
<Lightbox src="scaleway-dbaas_databases_list.webp" alt="" />
38-
4. Click **+ Add Database**. The new database dialog appears.
39-
5. Enter the name for the new database (`netbox`) and click **Create Database** to launch the database creation:
40-
<Lightbox src="scaleway-dbaas_new_db.webp" alt="" />
41-
6. Select the **Users** tab to view the users of your Database Instance.
42-
7. Click **+ Add user** to create a new `netbox` user for the database. Enter the identifier and password for the user:
43-
<Lightbox src="scaleway-dbaas_new_user.webp" alt="" />
44-
8. Then click the **Permissions** tab and set **ALL** permissions for the user on the `netbox` table.
45-
9. Once done, click **Create a user** to validate the form and launch the user creation process:
46-
<Lightbox src="scaleway-dbaas_permissions.webp" alt="" />
34+
2. [Create a Database Instance.](/managed-databases-for-postgresql-and-mysql/how-to/create-a-database/)
35+
3. [Create a database](/managed-databases-for-postgresql-and-mysql/how-to/add-a-database/) called `netbox`.
36+
4. [Create a new user](/managed-databases-for-postgresql-and-mysql/how-to/add-users/) also called `netbox` and grant it ALL permissions to the `netbox` database.
4737

4838
## Installing NetBox
4939

50-
1. Log into your Instance using [SSH](/instances/how-to/connect-to-instance/).
40+
1. Connect to your Instance using [SSH](/instances/how-to/connect-to-instance/).
5141
2. Update the `apt` package cache and upgrade the software already installed on the Instance to the latest version available in Ubuntu's repositories:
5242
```
5343
apt update && apt upgrade -y
@@ -56,13 +46,13 @@ NetBox requires a PostgreSQL database. Configure your [Database for PostgreSQL](
5646
```
5747
apt install -y libpq-dev python3 python3-pip python3-dev python3-venv build-essential libxml2-dev libxslt1-dev libffi-dev graphviz libpq-dev libssl-dev redis-server zlib1g-dev git nginx
5848
```
59-
4. Download the [latest release](https://github.com/netbox-community/netbox/releases/latest) of NetBox. At the time of writing this tutorial, it is version 3.7.5. Unpack it into the `/opt` directory:
49+
4. Download the [latest release](https://github.com/netbox-community/netbox/releases/latest) of NetBox. At the time of writing this tutorial, it is version 4.3.1. Unpack it into the `/opt` directory:
6050
```
61-
wget https://github.com/netbox-community/netbox/archive/refs/tags/v3.7.5.tar.gz && tar -xzf v3.7.5.tar.gz -C /opt
51+
wget https://github.com/netbox-community/netbox/archive/refs/tags/v4.3.1.tar.gz && tar -xzf v4.3.1.tar.gz -C /opt
6252
```
6353
5. Create a symlink from the actual NetBox directory to `/opt/netbox`:
6454
```
65-
ln -s /opt/netbox-3.6.3/ /opt/netbox
55+
ln -s /opt/netbox-4.3.1/ /opt/netbox
6656
```
6757
6. Create a new system user for the NetBox application:
6858
```
@@ -103,29 +93,33 @@ NetBox requires a PostgreSQL database. Configure your [Database for PostgreSQL](
10393
- `REDIS` specifies the configuration parameters of Redis, an in-memory key-value store required as part of the NetBox installation. For most installations, the default configuration is good enough, and you can leave it as it is. For more information about advanced Redis configuration, refer to the [official documentation](https://docs.netbox.dev/en/stable/configuration/required-parameters/#redis).
10494
- `SECRET_KEY` specifies a secret cryptographic key that is used to improve the security of cookies and password resets. It should be at least 50 characters long and should not be shared outside the configuration file. You may change the value of the key at any time, resulting in a termination of all active sessions.
10595

106-
Enter the key in the configuration file as follows, then save the file and exit your text editor:
107-
```
108-
SECRET_KEY = 'uyK5ajt-Vl$!gd2HeLbN=^6@&EhDmv8%)zT1S03kXPCsUGrI9_'
109-
```
96+
Enter the key in the configuration file as follows, then save the file and exit your text editor:
97+
98+
```
99+
SECRET_KEY = 'uyK5ajt-Vl$!gd2HeLbN=^6@&EhDmv8%)zT1S03kXPCsUGrI9_'
100+
```
101+
102+
<Message type="important">
103+
104+
The `SECRET_KEY` is not used for hashing user passwords or for the encrypted storage of secret data in NetBox.
105+
NetBox comes with a script, that you may use to generate a random key:
110106

111-
<Message type="important">
112-
The `SECRET_KEY` is not used for hashing user passwords or for the encrypted storage of secret data in NetBox.
113-
NetBox comes with a script, that you may use to generate a random key:
114-
```
115-
python3 /opt/netbox/netbox/generate_secret_key.py
116-
```
117-
</Message>
118-
12. Once NetBox has been configured, proceed with the actual installation by running the packaged upgrade script (`upgrade.sh`):
107+
```
108+
python3 /opt/netbox/netbox/generate_secret_key.py
109+
```
110+
</Message>
111+
112+
12. Once NetBox is configured, proceed with the actual installation by running the packaged upgrade script (`upgrade.sh`):
119113
```
120114
/opt/netbox/upgrade.sh
121115
```
122116

123117
This script performs the following actions on your instance:
124118

125-
- Creating a Python virtual environment
126-
- Installing all required Python packages
127-
- Running database schema migrations
128-
- Aggregating static resource files on disk
119+
- Creating a Python virtual environment
120+
- Installing all required Python packages
121+
- Running database schema migrations
122+
- Aggregating static resource files on disk
129123

130124
<Message type="note">
131125
The upgrade script may warn you, that no existing virtual environment was detected. As this is a new installation, you can safely ignore this warning.
@@ -150,7 +144,7 @@ NetBox does not come with any default user accounts. Create a first user by comp
150144
python3 manage.py createsuperuser
151145
```
152146

153-
Enter the `username`, `email`, `password`, and `password confirmation` for the user and confirm by pressing Enter. The following message displays once the user is created: `Superuser created successfully.`
147+
4. Enter the `username`, `email`, `password`, and `password confirmation` for the user and confirm by pressing Enter. The following message displays once the user is created: `Superuser created successfully.`
154148

155149
## Testing the application
156150

@@ -165,10 +159,10 @@ Enter the `username`, `email`, `password`, and `password confirmation` for the u
165159

166160
[gunicorn](https://gunicorn.org/) is a Python [WSGI](https://wsgi.readthedocs.io/en/latest/what.html) HTTP Server for UNIX which will be used to serve the NetBox application to Nginx.
167161

168-
1. Copy the gunicorn configuration file from the `contrib` directory to its final destination:
169-
```
170-
cp /opt/netbox/contrib/gunicorn.py /opt/netbox/gunicorn_config.py
171-
```
162+
Copy the gunicorn configuration file from the `contrib` directory to its final destination:
163+
```
164+
cp /opt/netbox/contrib/gunicorn.py /opt/netbox/gunicorn_config.py
165+
```
172166

173167
The configuration file shipped with the NetBox application works for most setups, however, if you need some specific settings, refer to the [gunicorn documentation](https://docs.gunicorn.org/en/stable/configure.html).
174168

@@ -221,7 +215,7 @@ To provide an additional layer of security, NetBox will be running behind a [NGI
221215
}
222216
```
223217

224-
Save the file and exit the text editor.
218+
Save the file and exit the text editor.
225219
3. Create a symlink to enable the new configuration with NGINX:
226220
```
227221
ln -s /etc/nginx/sites-available/netbox.conf /etc/nginx/sites-enabled/netbox.conf

tutorials/configure-tem-smtp-with-wordpress-plugin/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ categories:
1010
- transactional-email
1111
- instances
1212
dates:
13-
validation: 2024-10-29
13+
validation: 2025-05-14
1414
posted: 2024-04-24
1515
---
1616

0 commit comments

Comments
 (0)