### AWS Credentials File Example

Source: https://github.com/ovh/docs/blob/develop/pages/storage_and_backup/object_storage/s3_getting_started_with_object_storage/guide.en-us.md

Example format for the AWS credentials file.

```bash
cat ~/.aws/credentials

```

```text
[default]
aws_access_key_id = <access_key>
aws_secret_access_key = <secret_key>

```

--------------------------------

### AWS CLI Configuration File Examples

Source: https://github.com/ovh/docs/blob/develop/pages/storage_and_backup/object_storage/s3_getting_started_with_object_storage/guide.en-asia.md

Examples of the AWS credentials and configuration file formats.

```text
[default]
aws_access_key_id = <access_key>
aws_secret_access_key = <secret_key>
```

```text
[default]
region = <region_in_lowercase>
endpoint_url = <endpoint_url>
services = ovh-rbx-archive

[profile <profile_name>]
region = rbx
output = json
services = ovh-rbx

[services ovh-rbx-archive]
s3 =
  endpoint_url = https://s3.rbx-archive.io.cloud.ovh.net/
  signature_version = s3v4

s3api =
  endpoint_url = https://s3.rbx-archive.io.cloud.ovh.net/

[services ovh-rbx]
s3 =
  endpoint_url = https://s3.rbx.io.cloud.ovh.net/
  signature_version = s3v4

s3api =
  endpoint_url = https://s3.rbx.io.cloud.ovh.net/
```

--------------------------------

### Repository structure example

Source: https://github.com/ovh/docs/blob/develop/docs-guideline/docs-guideline.md

An example of the directory structure for guides within the repository.

```bash
.\n├── pages
|   ├── web
|   |   ├── domains
|   |   |   ├── glue-registry
|   |   |   |   ├── guide.en-gb.md (title: Glue Registry)
|   |   |   |   └── guide.fr-fr.md (title: Activer le Glue Registry sur son domaine)
|   |   |   ├── product.en-gb.md (title: Domains and DNS)
|   |   |   └── product.fr-fr.md (title: Domaines et DNS)
|   |   ├── universe.en-gb.md (title: Web)
|   |   └── universe.fr-fr.md (title: Web)
|   ├── home.en-gb.md (title: OVHcloud - Documentation)
|   └── home.fr-fr.md (title: OVHcloud - Guides)
└── README.md

```

--------------------------------

### OpenStack CLI Installation Guide

Source: https://github.com/ovh/docs/blob/develop/pages/public_cloud/public_cloud_cross_functional/00-essential-info-to-get-started-on-public-cloud/guide.en-ca.md

Instructions on how to install the OpenStack command-line client for managing Public Cloud resources.

```bash
pages/public_cloud/public_cloud_cross_functional/prepare_the_environment_for_using_the_openstack_api
```

--------------------------------

### Cloud-init configuration for a Linux VM

Source: https://github.com/ovh/docs/blob/develop/pages/hosted_private_cloud/nutanix_on_ovhcloud/80-first-steps/guide.en-ie.md

This is a cloud-init configuration script used to automate the setup of a Linux VM, including network configuration, user management, and package installations.

```yaml
#cloud-config
hostname: bastion-ssh
fqdn: bastion-ssh.domain.local
users:
  - name: bastion
    sudo: ALL=(ALL) NOPASSWD:ALL
    groups: sudo
    shell: /bin/ash
    ssh_pwauth: true
    lock_passwd: false
    plain_text_passwd: OVHcloudR0cks!

growpart:
  mode: growpart
  devices: ["/dev/sda2"]
  ignore_growroot_disabled: true

write_files:
   - path: /etc/network/interfaces
     content: |
        auto lo
        iface lo inet loopback

        auto eth0
        iface eth0 inet static
        address 172.16.2.200
        netmask 255.255.255.252
        gateway 172.16.3.254

runcmd:
   - echo "nameserver 213.186.33.99" > /etc/resolv.conf
   - rc-service networking restart
   - apk update
   - apk upgrade
   - apk add sudo
   - sed -i s/'PasswordAuthentication no'/'PasswordAuthentication yes'/g /etc/ssh/sshd_config
   - sed -i s/'#KbdInteractiveAuthentication yes'/'KbdInteractiveAuthentication yes'/g /etc/ssh/sshd_config
   - rc-service sshd restart
   - lvextend -l +100%FREE /dev/vg0/lv_root
   - resize2fs /dev/vg0/lv_root
   - reboot

final_message: "The system is finally up, after $UPTIME seconds"

```

--------------------------------

### Directory Structure for Guides

Source: https://github.com/ovh/docs/blob/develop/docs-guideline/docs-guideline.md

Example of how to structure a guide directory, including an 'images' folder.

```bash
... 
├── my-super-guide
|   ├── images
|   |   ├── 01.png
|   |   └── 02.png
|   └── guide.en-gb.md
...

```

--------------------------------

### File and Folder Permissions Example

Source: https://github.com/ovh/docs/blob/develop/pages/bare_metal_cloud/virtual_private_servers/migrate-to-pci-or-dedicated-server/guide.en-gb.md

Example of recommended file and folder permissions.

```bash
chmod 755
chmod 644
```

--------------------------------

### Check installation

Source: https://github.com/ovh/docs/blob/develop/pages/storage_and_backup/object_storage/s3_getting_started_with_object_storage/guide.en-asia.md

This command checks if the AWS CLI is installed in your environment.

```bash
aws --version
```

--------------------------------

### Completions API Example

Source: https://github.com/ovh/docs/blob/develop/pages/public_cloud/ai_machine_learning/endpoints_guide_01_getting_started/guide.en-gb.md

Example of how to use the Completions API for LLMs.

```bash
curl -X POST \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer (os.getenv('OVH_AI_ENDPOINTS_ACCESS_TOKEN'))" \
     https://your-endpoint-url/v1/completions \
     -d '{
       "model": "your-model-name",
       "prompt": "Once upon a time"
     }'
```

--------------------------------

### Create PostgreSQL database and user

Source: https://github.com/ovh/docs/blob/develop/pages/bare_metal_cloud/virtual_private_servers/install_env_web_dev_on_vps/guide.en-au.md

Example commands to create a database, a user, and grant privileges in PostgreSQL.

```bash
sudo -u postgres psql -c "CREATE DATABASE db_name;"
sudo -u postgres psql -c "CREATE USER db_user WITH ENCRYPTED PASSWORD 'strong_password';"
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE db_name TO db_user;"
```

--------------------------------

### Example output of mkfs.ext4

Source: https://github.com/ovh/docs/blob/develop/pages/public_cloud/compute/create_and_configure_an_additional_disk_on_an_instance/guide.es-us.md

Example output after formatting the partition.

```console
mke2fs 1.42.12 (29-Aug-2014)
Creating filesystem with 2621184 4k blocks and 655360 inodes
Filesystem UUID: 781be788-c4be-462b-b946-88429a43c0cf
Superblock backups stored on blocks:
32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632

Allocating group tables: done
Writing inode tables: done
Creating journal (32768 blocks): done
Writing superblocks and filesystem accounting information: done
```

--------------------------------

### Example File Permissions

Source: https://github.com/ovh/docs/blob/develop/pages/web_cloud/web_hosting/migrate_website_to_vps/guide.en-us.md

Example of setting file and folder permissions using chmod.

```bash
chmod 755 folders/
chmod 644 files.txt
```

--------------------------------

### AWS Config File Example

Source: https://github.com/ovh/docs/blob/develop/pages/storage_and_backup/object_storage/s3_getting_started_with_object_storage/guide.en-ie.md

Example format for the AWS config file.

```text
[default]
region = <region_in_lowercase>
endpoint_url = <endpoint_url>
services = ovh-rbx-archive

[profile <profile_name>]
region = rbx
output = json
services = ovh-rbx

[services ovh-rbx-archive]
s3 =
  endpoint_url = https://s3.rbx-archive.io.cloud.ovh.net/
  signature_version = s3v4

s3api =
  endpoint_url = https://s3.rbx-archive.io.cloud.ovh.net/

[services ovh-rbx]
s3 =
  endpoint_url = https://s3.rbx.io.cloud.ovh.net/
  signature_version = s3v4

s3api =
  endpoint_url = https://s3.rbx.io.cloud.ovh.net/
```

--------------------------------

### AWS Credentials File Example

Source: https://github.com/ovh/docs/blob/develop/pages/storage_and_backup/object_storage/s3_getting_started_with_object_storage/guide.en-ca.md

Example of the AWS credentials file format.

```bash
cat ~/.aws/credentials
```

```text
[default]
aws_access_key_id = <access_key>
aws_secret_access_key = <secret_key>
```

--------------------------------

### SSH connection example

Source: https://github.com/ovh/docs/blob/develop/pages/hosted_private_cloud/nutanix_on_ovhcloud/80-first-steps/guide.en-ca.md

Example command to connect to a CVM via SSH.

```bash
ssh nutanix@ipcvm
```

--------------------------------

### Home page metadata example

Source: https://github.com/ovh/docs/blob/develop/docs-guideline/docs-guideline.md

Example of YAML frontmatter for metadata on a home page.

```yaml
---
title: OVHcloud Documentation
excerpt: How can we help you ? 
---

```

--------------------------------

### Start a stopped Notebook using the Python SDK

Source: https://github.com/ovh/docs/blob/develop/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition/guide.en-us.md

Example of how to start a stopped Notebook using the Python SDK.

```python
from ovhai.api.notebook import notebook_start
from ovhai import AuthenticatedClient
client = AuthenticatedClient(
    base_url="https://gra.training.ai.cloud.ovh.net",
    token="YOUR_AI_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
    response = notebook_start.sync_detailed(
        id=id, client=client
    )
```

--------------------------------

### Start QEMU guest agent service (Debian/Ubuntu)

Source: https://github.com/ovh/docs/blob/develop/pages/bare_metal_cloud/virtual_private_servers/using-automated-backups-on-a-vps/guide.en-gb.md

Command to start the QEMU guest agent service and ensure it is running.

```bash
sudo service qemu-guest-agent start
```

--------------------------------

### Install ovhai library

Source: https://github.com/ovh/docs/blob/develop/pages/public_cloud/ai_machine_learning/notebook_guide_introduction_definition/guide.en-us.md

Command to install the ovhai Python SDK using pip.

```bash
pip install ovhai

```

--------------------------------

### Example output of lsblk

Source: https://github.com/ovh/docs/blob/develop/pages/public_cloud/compute/create_and_configure_an_additional_disk_on_an_instance/guide.en-gb.md

Example output showing disk and partition information, including mount points.

```console
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
vda 254:0 0 10G 0 disk
└─vda1 254:1 0 10G 0 part /
vdb       8:0    0   10G  0 disk
└─vdb1    8:1    0   10G  0 part /mnt/disk
```

--------------------------------

### Index structure example

Source: https://github.com/ovh/docs/blob/develop/docs-guideline/docs-guideline.md

The structure of the index.md file for organizing guides and categories.

```bash
## Contents
+ Knowledge base
    + [L1 category](full-slug)
        + [L2 category](full-slug)
            + [English title of the guide](repository-guide-path)

```

--------------------------------

### Verify OVHcloud CLI installation

Source: https://github.com/ovh/docs/blob/develop/pages/manage_and_operate/cli/cli-getting-started/guide.en-gb.md

This command checks the installed version of the OVHcloud CLI.

```sh
ovhcloud version
```

--------------------------------

### Chat Completions API Example

Source: https://github.com/ovh/docs/blob/develop/pages/public_cloud/ai_machine_learning/endpoints_guide_01_getting_started/guide.pl-pl.md

Example of how to use the Chat Completions API for LLMs.

```python
import os

from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("OVH_AI_ENDPOINTS_ACCESS_TOKEN"),
    base_url="https://{service_name}.{region}.ai.cloud.ovh.net/v1",
)

chat_completion = client.chat.completions.create(
    messages=[
        {
            "role": "user",
            "content": "Explain the importance of low-latency LLMs.",
        }
    ],
    model="{model_name}",
)

print(chat_completion.choices[0].message.content)
```