Skip to content

Commit f71fbfe

Browse files
ldecarvalho-docldecarvalho-doc
committed
fix(gen): templates
1 parent 84f1487 commit f71fbfe

File tree

1 file changed

+390
-0
lines changed

1 file changed

+390
-0
lines changed

‎pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx‎

Lines changed: 390 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,393 @@ List of features in alphabetical order, including:
4141

4242

4343

44+
Got it — clean, professional Markdown without any emojis. Here's the full set of templates in pure copiable format, with YAML frontmatter and no extra text or emojis.
45+
46+
---
47+
48+
```markdown
49+
---
50+
title: "Quickstart: Create an Instance"
51+
description: Get started with Scaleway Instances in less than 5 minutes.
52+
---
53+
54+
# Quickstart: Create an Instance
55+
56+
This guide shows you how to create and connect to a Scaleway Instance in just a few steps.
57+
58+
## Requirements
59+
60+
- You have a Scaleway account. [Create one here](https://console.scaleway.com/register).
61+
- You are logged in to the [Scaleway Console](https://console.scaleway.com).
62+
- You have created an API key (optional for CLI steps).
63+
64+
## Create via Console
65+
66+
1. Go to the **Compute > Instances** section in the console.
67+
2. Click **Create an Instance**.
68+
3. Choose an image (e.g., Ubuntu 22.04).
69+
4. Select an instance type (e.g., DEV1-S).
70+
5. Choose a region (e.g., `fr-par-1`).
71+
6. Click **Create Instance**.
72+
73+
The root password will be sent to your email.
74+
75+
## Connect via SSH
76+
77+
Once the instance is running:
78+
79+
```bash
80+
ssh root@<instance_public_ip>
81+
```
82+
83+
Tip: Use SSH keys for better security. See [managing SSH keys](https://www.scaleway.com/en/docs/compute/instance/how-to/connect-using-ssh-keys/).
84+
85+
## Next Steps
86+
87+
- [Customize your instance](https://www.scaleway.com/en/docs/compute/instance/how-to/configure-instance/)
88+
- [Set up a private network](https://www.scaleway.com/en/docs/network/vpc/quickstart/)
89+
- [Explore the API](https://www.scaleway.com/en/docs/compute/instance/api/reference/)
90+
```
91+
92+
```markdown
93+
---
94+
title: "How to Connect to an Instance Using SSH Keys"
95+
description: Learn how to securely connect to your Scaleway Instance using SSH keys.
96+
---
97+
98+
# How to Connect to an Instance Using SSH Keys
99+
100+
This guide explains how to use SSH keys to connect to your Scaleway Instance instead of using passwords.
101+
102+
## Prerequisites
103+
104+
- A running Scaleway Instance.
105+
- SSH key pair generated (`id_rsa` and `id_rsa.pub`, or use `ssh-keygen`).
106+
107+
## Step 1: Add Your Public Key in the Console
108+
109+
1. Go to **Compute > Instances**.
110+
2. In the left sidebar, click **SSH Keys**.
111+
3. Click **Add an SSH key**.
112+
4. Enter a name (e.g., `my-laptop`) and paste your public key (the content of `id_rsa.pub`).
113+
5. Click **Add**.
114+
115+
## Step 2: Attach Key During Instance Creation
116+
117+
When creating a new instance:
118+
- In the **Security** section, select your SSH key.
119+
- The instance will allow SSH access using your private key.
120+
121+
## Step 3: Connect via SSH
122+
123+
```bash
124+
ssh root@<instance_public_ip>
125+
```
126+
127+
No password needed if your key is set up correctly.
128+
129+
## Troubleshooting
130+
131+
- **Error: Permission denied (publickey)**
132+
Ensure your SSH agent is running:
133+
```bash
134+
eval $(ssh-agent)
135+
ssh-add ~/.ssh/id_rsa
136+
```
137+
138+
- **Key not loading?**
139+
Confirm the public key in the console matches your `.pub` file.
140+
141+
## Related Content
142+
143+
- [Instance Quickstart](https://www.scaleway.com/en/docs/compute/instance/quickstart/)
144+
- [Managing SSH Keys via API](https://www.scaleway.com/en/docs/compute/instance/api/reference/#operation/CreateServer)
145+
```
146+
147+
```markdown
148+
---
149+
title: "Concepts: Bootscripts"
150+
description: Understand what bootscripts are and how they control instance startup.
151+
---
152+
153+
# Concepts: Bootscripts
154+
155+
A **bootscript** is a predefined configuration that tells a Scaleway Instance which kernel and initrd to load at boot time.
156+
157+
## Why Use Bootscripts?
158+
159+
Bootscripts allow you to:
160+
- Boot from custom kernels.
161+
- Enable specific features like rescue mode.
162+
- Use alternative operating systems.
163+
164+
## Types of Bootscripts
165+
166+
| Type | Description |
167+
|------|-------------|
168+
| `normal` | Standard boot using the default kernel. |
169+
| `rescue` | Boots into a minimal environment for troubleshooting. |
170+
| `boot2docker` | Legacy mode for Docker hosts (deprecated). |
171+
172+
## Default Behavior
173+
174+
When you create an instance:
175+
- The system automatically assigns a compatible bootscript based on the selected image.
176+
- You can override this in the API or console.
177+
178+
## Example Use Case
179+
180+
You want to debug a misconfigured firewall:
181+
1. Stop the instance.
182+
2. Change bootscript to `rescue`.
183+
3. Restart and access via SSH.
184+
4. Modify configuration files directly.
185+
186+
Related: [How to use rescue mode](https://www.scaleway.com/en/docs/compute/instance/how-to/use-rescue-mode/)
187+
188+
## Limitations
189+
190+
- Not all instance types support all bootscripts.
191+
- ARM64 instances have limited bootscript options.
192+
193+
## Learn More
194+
195+
- [Image Concepts](https://www.scaleway.com/en/docs/compute/instance/concepts/image/)
196+
- [Instance API Reference](https://www.scaleway.com/en/docs/compute/instance/api/reference/)
197+
```
198+
199+
```markdown
200+
---
201+
title: "Troubleshooting: Instance Won't Boot"
202+
description: Diagnose and fix issues when a Scaleway Instance fails to start.
203+
---
204+
205+
# Troubleshooting: Instance Won't Boot
206+
207+
If your Scaleway Instance fails to start or remains stuck in "starting" state, follow these steps.
208+
209+
## 1. Check Instance Status
210+
211+
In the **Instances** dashboard:
212+
- Is the status `starting`, `error`, or `stopped`?
213+
- Are there any alerts or messages?
214+
215+
Tip: Wait up to 2 minutes after creation; some images take longer.
216+
217+
## 2. Verify Bootscript and Image Compatibility
218+
219+
An incompatible bootscript can prevent booting.
220+
221+
Fix:
222+
- Go to instance settings.
223+
- Ensure the bootscript matches the image (e.g., `normal` for most Linux images).
224+
225+
## 3. Inspect the Boot Logs
226+
227+
1. In the console, go to your instance.
228+
2. Click **Boot Logs**.
229+
3. Look for:
230+
- Kernel panic
231+
- Missing root device
232+
- Filesystem errors
233+
234+
Example: `VFS: Unable to mount root fs` → corrupted image or volume.
235+
236+
## 4. Try Rescue Mode
237+
238+
Boot into rescue mode to inspect the filesystem:
239+
240+
1. Stop the instance.
241+
2. Edit → Change bootscript to `rescue`.
242+
3. Start the instance.
243+
4. Connect via SSH and run:
244+
```bash
245+
fsck /dev/root
246+
```
247+
248+
## 5. Reattach the Boot Volume
249+
250+
Sometimes the volume becomes detached.
251+
252+
Fix:
253+
- Detach and reattach the boot volume in the **Volumes** tab.
254+
255+
## Still Not Working?
256+
257+
Contact Scaleway Support with:
258+
- Instance ID
259+
- Screenshot of boot logs
260+
- Steps already tried
261+
262+
Open a support ticket: https://www.scaleway.com/en/support/
263+
```
264+
265+
```markdown
266+
---
267+
title: "API/CLI: Create an Instance"
268+
description: Use the Scaleway API or CLI to programmatically create an Instance.
269+
---
270+
271+
# API/CLI: Create an Instance
272+
273+
Automate infrastructure with the Scaleway CLI or REST API.
274+
275+
## Using the CLI
276+
277+
### Install the CLI
278+
279+
```bash
280+
curl -fsSL https://scaleway-cli.s3.fr-par.scw.cloud/install.sh | sh
281+
```
282+
283+
### Configure Credentials
284+
285+
```bash
286+
scw init
287+
```
288+
289+
Follow prompts to enter your **Organization ID** and **API Key**.
290+
291+
### Create Command
292+
293+
```bash
294+
scw instance server create \
295+
image=ubuntu_jammy \
296+
type=DEV1-S \
297+
region=fr-par \
298+
name=my-cli-instance
299+
```
300+
301+
### Output
302+
303+
```bash
304+
ID: 111e89f4-a565-49ea-90da-073255490a67
305+
IP: 51.159.20.30
306+
Status: running
307+
```
308+
309+
## Using the REST API
310+
311+
**Endpoint**:
312+
`POST https://api.scaleway.com/instance/v1/zones/fr-par-1/servers`
313+
314+
**Headers**:
315+
```
316+
X-Auth-Token: your-api-key
317+
Content-Type: application/json
318+
```
319+
320+
**Body**:
321+
```json
322+
{
323+
"image": "ubuntu_jammy",
324+
"type": "DEV1-S",
325+
"name": "api-instance",
326+
"zone": "fr-par-1"
327+
}
328+
```
329+
330+
**Response**:
331+
```json
332+
{
333+
"server": {
334+
"id": "111e89f4-a565-49ea-90da-073255490a67",
335+
"public_ip": { "address": "51.159.20.30" }
336+
}
337+
}
338+
```
339+
340+
## Parameters Reference
341+
342+
| Parameter | Required | Description |
343+
|---------|--------|------------|
344+
| `image` | Yes | OS image identifier |
345+
| `type` | Yes | Instance size |
346+
| `zone` | Yes | e.g., `fr-par-1` |
347+
| `name` | No | Default: auto-generated |
348+
349+
## Learn More
350+
351+
- [CLI Installation Guide](https://www.scaleway.com/en/docs/cli/)
352+
- [API Authentication](https://www.scaleway.com/en/docs/api-reference/#authentication)
353+
```
354+
355+
```markdown
356+
---
357+
title: "Instance Product Overview"
358+
description: Introduction to Scaleway Instances — virtual machines with high performance and flexibility.
359+
---
360+
361+
# Instance Product Overview
362+
363+
Scaleway Instances provide on-demand virtual machines with predictable pricing, high performance, and full control.
364+
365+
## Key Features
366+
367+
- Bare-metal and virtual instances
368+
- Multi-region deployment
369+
- Wide range of images
370+
- SSH key management
371+
- Flexible storage
372+
373+
## Use Cases
374+
375+
| Use Case | Why Choose Instances |
376+
|--------|----------------------|
377+
| Web Hosting | Full control over environment |
378+
| CI/CD Runner | Isolated, reproducible builds |
379+
| Game Server | Low-latency, high-performance nodes |
380+
381+
## Getting Started
382+
383+
Quickstart:
384+
[Create your first instance](/docs/compute/instance/quickstart/)
385+
386+
Concepts:
387+
[Understand images and bootscripts](/docs/compute/instance/concepts/)
388+
389+
## Documentation Map
390+
391+
| Topic | Link |
392+
|------|------|
393+
| How-tos | [All guides](/docs/compute/instance/how-to/) |
394+
| API Reference | [REST & CLI](/docs/compute/instance/api/reference/) |
395+
| Troubleshooting | [Common issues](/docs/compute/instance/troubleshooting/) |
396+
| Changelog | [Release notes](/docs/compute/instance/releases/) |
397+
```
398+
399+
```markdown
400+
---
401+
title: "Release Notes: Instance Updates"
402+
description: Stay up to date with the latest features and fixes for Scaleway Instances.
403+
---
404+
405+
# Release Notes: Instance Updates
406+
407+
## May 2025
408+
409+
### New Features
410+
- Added support for `ARM64-128GB` instance type.
411+
- New Ubuntu 24.04 LTS image available.
412+
413+
### Improvements
414+
- Faster boot times for `GP-S` instances.
415+
- Improved volume detachment handling.
416+
417+
### Fixes
418+
- Fixed rare crash during live migration.
419+
- Resolved issue with API returning 503 during peak hours.
420+
421+
## April 2025
422+
423+
### New
424+
- New `rescue-buster` bootscript for Debian 10 compatibility.
425+
426+
### Fixed
427+
- Fixed incorrect disk size display in console.
428+
429+
All users are automatically updated. No action required.
430+
431+
Subscribe to updates:
432+
[Email notifications](https://www.scaleway.com/en/support/) | [RSS Feed](https://www.scaleway.com/en/docs/compute/instance/releases/index.xml)
433+
```

0 commit comments

Comments
 (0)