OVHcloud

https://docs.ovhcloud.com/fr/
Admin
OVHcloud is a European cloud provider that offers public and private cloud infrastructure,...
Tokens:5,455,957
Snippets:31,839
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### API response example for OS installation

Source: https://docs.ovhcloud.com/fr/guides/bare-metal-cloud/dedicated-servers/api-os-installation.md

Example JSON response from the API after starting an OS installation. The taskId can be used to track the installation progress.

```json
{
    "taskId": 123456789,
    "status": "init",
    "startDate": "2024-01-26T17:57:10+01:00",
    "doneDate": null,
    "function": "reinstallServer",
    "comment": "Start bare metal OS installation"
}
```

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

### Example setup_vm.sh script

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/compute/create-image-from-existing-image-with-packer.md

Example setup_vm.sh script that runs with sudo if not root, then installs git and clones a repository. Customize the script for your needs.

```sh
#!/bin/sh

set -ex

if [ `id -u` -ne 0 ]; then
     sudo $0
    exit 0
fi

## votre code personnalisé ci-dessous
apt-get install git
git clone ...
```

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

### Example valid hostname

Source: https://docs.ovhcloud.com/fr/guides/bare-metal-cloud/virtual-private-servers/install-ispmanager.md

Example of a valid hostname (FQDN) to enter when prompted during installation.

```console
ispmanager.mondomaine.ovh
```

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

### Example output of the Nginx setup commands

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/containers-orchestration/managed-kubernetes/backing-up-volumes-stash.md

Shows the expected output from applying the manifest, checking the pod, waiting for the external IP, and making curl requests.

```console
$ kubectl apply -f nginx-example.yml

namespace/nginx-example created
persistentvolumeclaim/nginx-logs created
deployment.apps/nginx-deployment created
service/nginx-service created

$ kubectl get pod -n nginx-example
NAME                                READY   STATUS    RESTARTS   AGE
nginx-deployment-766444c4d9-cxd2p   1/1     Running   0          32s

$ kubectl -n nginx-example get svc nginx-service -w

NAME            TYPE           CLUSTER-IP    EXTERNAL-IP   PORT(S)        AGE
nginx-service   LoadBalancer   10.3.39.164   <pending>     80:31734/TCP   49s
nginx-service   LoadBalancer   10.3.39.164   51.210.210.247   80:31734/TCP   3m

$ curl -I 51.210.210.247
HTTP/1.1 200 OK
Server: nginx/1.7.9
Date: Tue, 21 Dec 2021 14:16:20 GMT
Content-Type: text/html
Content-Length: 612
Last-Modified: Tue, 23 Dec 2014 16:25:09 GMT
Connection: keep-alive
ETag: "54999765-264"
Accept-Ranges: bytes

$ curl -I 51.210.210.247
HTTP/1.1 200 OK
Server: nginx/1.7.9
Date: Tue, 21 Dec 2021 14:16:31 GMT
Content-Type: text/html
Content-Length: 612
Last-Modified: Tue, 23 Dec 2014 16:25:09 GMT
Connection: keep-alive
ETag: "54999765-264"
Accept-Ranges: bytes

```

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

### Install node-fetch for Node.js

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/ai-machine-learning/ai-endpoints-catalog-api.md

Installs the node-fetch package for Node.js, required to run the JavaScript examples in this guide.

```bash
npm install node-fetch
```

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

### Create virtual machine instance with trunk (example)

Source: https://docs.ovhcloud.com/fr/guides/hosted-private-cloud/opcp/setup-trunk-on-node.md

Example command to create a virtual machine instance using the trunk. Must use --port, not --nic.

```bash
openstack server create \
  --image ubuntu-22.04 \
  --flavor m1.large \
  --port primary-port \
  --key-name my-keypair \
  my-trunk-instance
```

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

### Login to OVHcloud CLI

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/cross-functional/disaster-recovery-plan-implementation.md

Authenticate with the OVHcloud CLI. Run this command to log in and create your API credentials as described in the OVHcloud CLI getting started guide.

```bash
ovhcloud login
```

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

### Show trunk configuration (example)

Source: https://docs.ovhcloud.com/fr/guides/hosted-private-cloud/opcp/setup-trunk-on-node.md

Example command to show the configuration of trunk 'my-trunk'.

```bash
openstack network trunk show my-trunk
```

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

### Example output of ovhai job get

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/ai-machine-learning/ai-cli-overview.md

Example output of the ovhai job get command showing the job details, including the sshUrl field.

```console
ovhai job get `<job-id>`

---
id: 0d916855-1cd4-4b66-8803-b4782bc13902
createdAt: "2021-02-23T08:45:01.297780Z"
updatedAt: "2021-02-23T08:45:19.823082Z"
user: user-xxx
spec:
  image: ovhcom/ai-training-fastai
  env: []
  defaultHttpPort: 8080
  resources:
    gpu: 1
    gpuModel: Tesla-V100S
    cpu: 7
  volumes: []
  timeout: 0
  name: ai-training-fastai-kind
  sshPublicKeys:
    - ssh-ed25519 AAAAC3NzaC1someKey
status:
  state: RUNNING
  queuedAt: "2021-02-23T08:45:01.297318Z"
  startedAt: "2021-02-23T08:45:13Z"
  stoppedAt: ~
  ip: 10.42.155.122
  infos: ~
  history:
    - state: QUEUED
      date: "2021-02-23T08:45:01.297012Z"
    - state: INITIALIZING
      date: "2021-02-23T08:45:04.356856Z"
    - state: PENDING
      date: "2021-02-23T08:45:10.163754Z"
    - state: RUNNING
      date: "2021-02-23T08:45:19.822354Z"
  duration: 6
  jobUrl: "http://0d916855-1cd4-4b66-8803-b4782bc13902.job.gra.ai.cloud.ovh.net"
  sshUrl: "ssh://0d916855-1cd4-4b66-8803-b4782bc13902@gra.ai.cloud.ovh.net"
  monitoringUrl: "http://monitoring.gra.ai.cloud.ovh.net/d/job/job-monitoring?var-job=0d916855-1cd4-4b66-8803-b4782bc13902&from=1614069913000"
```

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

### SSH with example key file

Source: https://docs.ovhcloud.com/fr/guides/bare-metal-cloud/dedicated-servers/creating-ssh-keys.md

Example of using the -i option to connect to a server with the key file myServer_rsa.

```bash
ssh -i ~/.ssh/myServer_rsa ubuntu@203.0.113.100

```

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

### Install gdown

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/ai-machine-learning/ai-training-nvidia-neuralangelo-video-to-3d.md

Installs the gdown Python package to download the example Lego video.

```shell
pip install gdown
```

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

### Example GET request with CORS headers

Source: https://docs.ovhcloud.com/fr/guides/storage-and-backup/object-storage/pcs-cors.md

Example HTTP GET request to an object in a PCS container, including CORS-related headers such as Origin, Sec-Fetch-Mode, and X-Auth-Token. This is a real request that a browser might send.

```http
GET /v1/AUTH_702xxxxxxxxxxxxxxxxxxxxxxxxxxdaf/pcs-web/lorem.txt HTTP/1.1
Host: storage.gra.cloud.ovh.net
Connection: keep-alive
sec-ch-ua: "Chromium";v="92", " Not A;Brand";v="99", "Google Chrome";v="92"
X-Auth-Token: gAAAAABhB60RtB6kbTjksGne23pvSiW1X24BjFzpgInOeoXomd21etqpLw6ocys4SuC9PHZ3PfVMCHIMvb6yjyoEwg1XY2iWfcenCMOhG7POgv-i2NePNJSkjc9cE0eVTDEQ-VhtcOCc-ZvbU459a0HpsWUbGMwn8bUi4-hl3Cv5bwGgLuBxmbw
sec-ch-ua-mobile: ?0
User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.107 Safari/537.36
Accept: */*
Origin: http://example.com
Sec-Fetch-Site: cross-site
Sec-Fetch-Mode: cors
Sec-Fetch-Dest: empty
Referer: http://example.com
Accept-Encoding: gzip, deflate, br
Accept-Language: fr-FR,fr;q=0.9,en-US;q=0.8,en;q=0.7
If-None-Match: 51f122f524c46cafcf9628305db99144
If-Modified-Since: Tue, 03 Aug 2021 07:10:26 GMT
```

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

### POST /dedicated/server/{serviceName}/install/start

Source: https://docs.ovhcloud.com/fr/guides/bare-metal-cloud/dedicated-servers/api-os-installation.md

Starts the OS installation on a dedicated server. The request body includes the operating system and customizations such as hostname, language, and post-installation script.

```APIDOC
## POST /dedicated/server/{serviceName}/install/start

### Description
Starts the installation of an operating system on a dedicated server. The payload specifies the OS and customization options.

### Method
POST

### Endpoint
/dedicated/server/{serviceName}/install/start

### Parameters
#### Path Parameters
- **serviceName** (string) - Required - The name of the dedicated server.

#### Request Body
- **operatingSystem** (string) - Required - The OS identifier, e.g., "win2025core-std_64".
- **customizations** (object) - Optional - Customization options.
  - **hostname** (string) - Optional - The hostname to set.
  - **language** (string) - Optional - The language locale, e.g., "fr-fr".
  - **postInstallationScript** (string) - Optional - Base64-encoded post-installation script (PowerShell or batch).
  - **postInstallationScriptExtension** (string) - Optional - Extension of the script: "ps1" for PowerShell or "cmd" for batch. Default is "ps1".

### Request Example
```json
{
  "operatingSystem": "win2025core-std_64",
  "customizations": {
    "hostname": "ma-fenetre",
    "language": "fr-fr",
    "postInstallationScript": "ImNvdWNvdSBwb3N0SW5zdGFsbGF0aW9uU2NyaXB0UG93ZXJTaGVsbCIgfCBPdXQtRmlsZSAtRmlsZVBhdGggImM6XG92aHVwZFxzY3JpcHRcY291Y291LnR4dCIKKEdldC1JdGVtUHJvcGVydHkgLUxpdGVyYWxQYXRoICJSZWdpc3RyeTo6SEtMTVxTT0ZUV0FSRVxNaWNyb3NvZnRcQ3J5cHRvZ3JhcGh5IiAtTmFtZSAiTWFjaGluZUd1aWQiKS5NYWNoaW5lR3VpZCB8IE91dC1GaWxlIC1GaWxlUGF0aCAiYzpcb3ZodXBkXHNjcmlwdFxjb3Vjb3UudHh0IiAtQXBwZW5kCihHZXQtRGF0ZSkuVG9Vbml2ZXJzYWxUaW1lKCkuVG9TdHJpbmcoInl5eXktTU0tZGQgSEg6bW06c3MiKSB8IE91dC1GaWxlIC1GaWxlUGF0aCAiYzpcb3ZodXBkXHNjcmlwdFxjb3Vjb3UudHh0IiAtQXBwZW5kCg=="
  }
}
```

### Response
#### Success Response (200)
- **taskId** (integer) - The ID of the installation task.
- **status** (string) - The status of the task (e.g., "init").
- **startDate** (string) - The start date of the task.
- **doneDate** (string or null) - The completion date, null if not finished.
- **function** (string) - The function name, e.g., "reinstallServer".
- **comment** (string) - A comment about the task.

#### Response Example
```json
{
    "taskId": 123456789,
    "status": "init",
    "startDate": "2024-01-26T17:57:10+01:00",
    "doneDate": null,
    "function": "reinstallServer",
    "comment": "Start bare metal OS installation"
}
```
```

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

### Verify ESO Installation with kubectl get all

Source: https://docs.ovhcloud.com/fr/guides/manage-and-operate/secret-manager/external-secret-operator.md

Verifies that the External Secrets Operator is running after installation. Shows the expected output of 'kubectl get all -n external-secrets', including pods, services, deployments, and replicasets.

```bash
$  kubectl get all -n external-secrets
NAME                                                    READY   STATUS    RESTARTS   AGE
pod/external-secrets-8cbc56569-9875p                    1/1     Running   0          12s
pod/external-secrets-cert-controller-565fcd479b-xbkcp   0/1     Running   0          12s
pod/external-secrets-webhook-7fb59d4b88-9tkl6           0/1     Running   0          12s

NAME                               TYPE        CLUSTER-IP    EXTERNAL-IP   PORT(S)   AGE
service/external-secrets-webhook   ClusterIP   10.3.43.102   <none>        443/TCP   13s

NAME                                               READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/external-secrets                   1/1     1            1           13s
deployment.apps/external-secrets-cert-controller   0/1     1            0           13s
deployment.apps/external-secrets-webhook           0/1     1            0           13s

NAME                                                          DESIRED   CURRENT   READY   AGE
replicaset.apps/external-secrets-8cbc56569                    1         1         1       13s
replicaset.apps/external-secrets-cert-controller-565fcd479b   1         1         0       13s
replicaset.apps/external-secrets-webhook-7fb59d4b88           1         1         0       13s
```

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

### Create bare metal instance with trunk (example)

Source: https://docs.ovhcloud.com/fr/guides/hosted-private-cloud/opcp/setup-trunk-on-node.md

Example command to create a bare metal instance using the trunk. Includes an availability zone. Must use --port, not --nic.

```bash
openstack server create \
  --image ubuntu-22.04 \
  --flavor baremetal \
  --port primary-port \
  --key-name my-keypair \
  --availability-zone "nova::88830859-5b16-4935-8f41-d381b754cbe5" \
  my-trunk-instance
```

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

### Set up web root and copy site files on VPS

Source: https://docs.ovhcloud.com/fr/guides/web-cloud/web-hosting/migrate-website-to-vps.md

Commands to run on the VPS after transferring files via SFTP. They create the web root if needed, copy the site files from /home/debian/site/ to /var/www/html/ (using rsync or cp as an alternative), set ownership to www-data:www-data for Nginx/Apache on Debian/Ubuntu, and fix directory permissions to 755 and file permissions to 644. Replace /var/www/html with your actual web root if it differs.

```bash
sudo mkdir -p /var/www/html
```

```bash
sudo rsync -a /home/debian/site/ /var/www/html/
```

```bash
sudo cp -a /home/debian/site/. /var/www/html/
```

```bash
sudo chown -R www-data:www-data /var/www/html
```

```bash
sudo find /var/www/html -type d -exec chmod 755 {} \;
sudo find /var/www/html -type f -exec chmod 644 {} \;
```

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

### Install boto3 with pip

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/data-platform/tutorials-bucket-s3-access.md

Install the boto3 library using pip. This is a prerequisite for the Python example that follows.

```sh
pip install boto3
```

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

### Example connection to PostgreSQL instance

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/databases/postgresql-connect-cli.md

An example of a real connection command using the provided URI format. Replace the credentials and host with your own.

```console
$ psql "postgres://avnadmin:Mysup3rs3cur3p4ssw0rd@postgresql-ab123456-cd7891011.database.cloud.ovh.net:20184/defaultdb?sslmode=require"
```

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

### Install Python openai client

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/ai-machine-learning/ai-endpoints-batch-mode.md

Install the openai Python client to use the batch API examples.

```sh
pip install openai
```

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

### Create production bastion with PostgreSQL replication setup

Source: https://docs.ovhcloud.com/fr/guides/public-cloud/cross-functional/disaster-recovery-plan-implementation.md

Creates the bastion-prod instance and runs a cloud-config script that installs PostgreSQL client 17, discovers oc_* tables, creates a publication, dumps the schema, and sets up a subscription on the DRP database. Requires environment variables for regions, network IDs, and PostgreSQL credentials.

```bash
BASTION_IMAGE_PROD=$(ovhcloud cloud reference list-images --region "$REGION_PROD" --os-type linux --filter 'name=="Ubuntu 24.04"' --output json | jq -r .[0].id)
BASTION_FLAVOR_PROD=$(ovhcloud cloud reference list-flavors --filter "region==\"$REGION_PROD\" && name==\"b3-8\"" --output json | jq -r .[0].id)
ovhcloud cloud instance create $REGION_PROD \
  --name bastion-prod \
  --boot-from.image "$BASTION_IMAGE_PROD" \
  --flavor "$BASTION_FLAVOR_PROD" \
  --billing-period hourly \
  --network.private.id "$NETWORK_ID_PROD" \
  --network.private.subnet-id "$SUBNET_ID_PROD" \
  --network.private.gateway.id "$GATEWAY_ID_PROD" \
  --network.private.floating-ip.create.description bastion-prod-fip \
  --ssh-key.name "bastion-key" \
  --wait \
  --user-data "$(cat <<EOF
#cloud-config
package_update: true
apt:
  sources:
     pgdg.list:
       source: deb http://apt.postgresql.org/pub/repos/apt noble-pgdg main
       keyid: B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8
packages:
- postgresql-client-17
runcmd:
- |
  set -eu
  echo '[INFO] discovering oc_* tables on $PG_HOST_PROD'
  TABLES=\$(PGPASSWORD='$PG_PASS_PROD' psql -h '$PG_HOST_PROD' -p '$PG_PORT_PROD' -U avnadmin -d nextcloud -tAc "SELECT string_agg(quote_ident(tablename), ',' ORDER BY tablename) FROM pg_tables WHERE schemaname='public' AND tablename LIKE 'oc\\_%'")
  echo '[INFO] creating publication pub_source_tables'
  PGPASSWORD='$PG_PASS_PROD' psql -h '$PG_HOST_PROD' -p '$PG_PORT_PROD' -U avnadmin -d nextcloud -c "CREATE PUBLICATION pub_source_tables FOR TABLE \$TABLES WITH (publish='insert,update,delete');"
  echo '[INFO] dumping schema from $PG_HOST_PROD'
  PGPASSWORD='$PG_PASS_PROD' pg_dump --schema-only --no-publications -h '$PG_HOST_PROD' -p '$PG_PORT_PROD' -U avnadmin -d nextcloud -t 'oc_*' > /home/ubuntu/origin_tables.sql
  echo '[INFO] preparing subscriber $PG_HOST_DRP'
  PGPASSWORD='$PG_PASS_DRP' psql -h '$PG_HOST_DRP' -p '$PG_PORT_DRP' -U avnadmin -d nextcloud -c "CREATE EXTENSION IF NOT EXISTS aiven_extras CASCADE;"
  PGPASSWORD='$PG_PASS_PROD' psql -h '$PG_HOST_PROD' -p '$PG_PORT_PROD' -U avnadmin -d nextcloud -c "CREATE EXTENSION IF NOT EXISTS aiven_extras CASCADE;"
  PGPASSWORD='$PG_PASS_DRP' psql -h '$PG_HOST_DRP' -p '$PG_PORT_DRP' -U avnadmin -d nextcloud -a -f /home/ubuntu/origin_tables.sql
  PGPASSWORD='$PG_PASS_DRP' psql -h '$PG_HOST_DRP' -p '$PG_PORT_DRP' -U avnadmin -d nextcloud -c "SELECT * FROM aiven_extras.pg_create_subscription('dest_subscription', 'host=$PG_HOST_PROD password=$PG_PASS_PROD port=$PG_PORT_PROD dbname=nextcloud user=avnadmin', 'pub_source_tables', 'dest_slot', TRUE, TRUE);"
EOF
)"
```

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

### Install missing packages manually

Source: https://docs.ovhcloud.com/fr/guides/manage-and-operate/observability/logs-data-platform/elastalert.md

Example of manually installing a missing package, such as setuptools_rust, if an error occurs.

```bash
$ pip install setuptools_rust
```

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

### Install required packages

Source: https://docs.ovhcloud.com/fr/guides/bare-metal-cloud/virtual-private-servers/minecraft-server-on-vps.md

Installs screen, nano, wget, and git, which are needed for the Minecraft server setup.

```sh
$ sudo apt install screen nano wget git
```
Tokens:
Raw