OVHcloud

https://docs.ovhcloud.com/en
Admin
OVHcloud is a European cloud services provider offering bare-metal servers, public and hosted...
Tokens:4,522,348
Snippets:32,960
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET /hosting/web/moduleList Return Example

Source: https://docs.ovhcloud.com/en/guides/web-cloud/web-hosting/api-webhosting.md

Example response from the GET /hosting/web/moduleList endpoint, returning a list of module IDs available for installation.

```json
[
 195,
 184,
 38,
 176
]
```

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

### Example output of the Nginx setup

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

Example output from applying the manifest, checking the pod, waiting for the external IP, and curling the service. Shows the created resources, the pod running, the LoadBalancer getting an external IP, and HTTP 200 responses.

```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 SDK dependencies with example path

Source: https://docs.ovhcloud.com/en/guides/hosted-private-cloud/powered-by-vmware/vmware-installation-api.md

Example command that installs the SDK dependencies using the absolute path to the cloned SDK directory.

```bash
pip install --upgrade --force-reinstall -r requirements.txt --extra-index-url file:///root/vsphere-automation-sdk-python/lib
```

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

### Example Backup Agent installation command

Source: https://docs.ovhcloud.com/en/guides/storage-and-backup/backup-agent/linux-cli-assistant.md

Example installation command with actual URLs from the OVHcloud Control Panel. Replace the URLs with your own.

```bash
curl -sSL "https://ovh-ba-downloads.s3.xxx.xxx/tmp/ovh-ba-install.sh" | sudo bash -s -- --setup "https://s3.xxx.xxx.cloud.ovh.net/xxxx/LinuxAgentPackages.vspc_tenant_xxxx.sh?X-Amz-Algorithm=xxx&X-Amz-Credential=xxx&X-Amz-Date=2xxx&X-Amz-Expires=xxx&X-Amz-SignedHeaders=xxx&X-Amz-Signature=xxx" --script-url "https://ovh-ba-downloads.s3.xxx.xxx/tmp/ovh-ba-install.sh"
```

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

### Example API reply for OS installation

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

Example JSON response from the OS installation API call, showing the task ID, status, start date, and function. The task ID can be used to follow the installation status.

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

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

### Install and start Tailscale on Prague instance

Source: https://docs.ovhcloud.com/en/guides/public-cloud/compute/local-zones-vpn-tailscale-integration.md

Install Tailscale on the Prague instance and start it with the provided auth key. The command downloads and runs the official install script, then brings up the Tailscale interface using the $TAILSCALE-KEY environment variable.

```bash
curl -fsSL https://tailscale.com/install.sh | sh && sudo tailscale up --auth-key=$TAILSCALE-KEY
```

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

### GET /hosting/web/moduleList/{id} Return Example

Source: https://docs.ovhcloud.com/en/guides/web-cloud/web-hosting/api-webhosting.md

Example response from the GET /hosting/web/moduleList/{id} endpoint, showing detailed information about a specific module including version, language requirements, and size.

```json
{
 "keywords": [
   "gallery"
 ],
 "adminNameType": "string",
 "author": "OVH",
 "branch": "old",
 "id": 195,
 "size": {
   "value": 0,
   "unit": "B"
 },
 "name": "myname",
 "upgradeFrom": [],
 "language": [
   "en",
   "fr",
   "de",
   "es",
   "pl"
 ],
 "version": "1.4.2.2",
 "active": false,
 "languageRequirement": {
   "value": "php",
   "unit": "supported versions: ''\nnon supported versions: '8+'"
 },
 "latest": true
}
```

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

### Clone the getting-started repository and open it

Source: https://docs.ovhcloud.com/en/guides/public-cloud/data-platform/tutorials-app-development-build.md

Clones the forepaas/getting-started repository and changes into the directory.

```bash
git clone https://github.com/forepaas/getting-started.git
cd getting-started/
```

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

### Install Python requests library

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

Install the requests library required for the Python examples in this guide.

```bash
pip install requests
```

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

### Install OpenAI JavaScript SDK

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

Install the official OpenAI SDK for Node.js, required for the JavaScript examples in this guide.

```sh
npm install openai
```

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

### Create and enter project directory

Source: https://docs.ovhcloud.com/en/guides/web-cloud/web-hosting/static-website-installation-cecil-api-call.md

Creates a directory named 'myWebSite' and switches into it, preparing the environment for installing Cecil.

```bash
mkdir myWebSite
cd myWebSite
```

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

### Install OpenAI Python client

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

Install the OpenAI Python client library, required for the Python examples in this guide.

```sh
pip install openai
```

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

### Install Pydantic AI with pip

Source: https://docs.ovhcloud.com/en/guides/public-cloud/ai-machine-learning/ai-endpoints-pydantic-ai-integration.md

Installs the Pydantic AI package using pip. Run this in your terminal to get started.

```bash
pip install pydantic-ai
```

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

### POST /hosting/web/{serviceName}/database Return Example

Source: https://docs.ovhcloud.com/en/guides/web-cloud/web-hosting/api-webhosting.md

Example response from the POST /hosting/web/{serviceName}/database endpoint, showing the database creation task details with timestamps and status.

```json
{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}
```

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

### Output of kubectl get crd showing NodePools CRD

Source: https://docs.ovhcloud.com/en/guides/public-cloud/containers-orchestration/managed-kubernetes/managing-nodes.md

Example output from `kubectl get crd` listing installed CRDs. The `nodepools.kube.cloud.ovh.com` entry is highlighted in yellow.

```console
$ kubectl get crd
NAME                                             CREATED AT
...
ingresses.networking.internal.knative.dev              2023-01-03T07:25:05Z
ipamblocks.crd.projectcalico.org                       2022-09-22T07:00:52Z
ipamconfigs.crd.projectcalico.org                      2022-09-22T07:00:52Z
ipamhandles.crd.projectcalico.org                      2022-09-22T07:00:53Z
ippools.crd.projectcalico.org                          2022-09-22T07:00:53Z
ipreservations.crd.projectcalico.org                   2022-09-22T07:00:53Z
kubecontrollersconfigurations.crd.projectcalico.org    2022-09-22T07:00:53Z
metrics.autoscaling.internal.knative.dev               2023-01-03T07:25:05Z
networkpolicies.crd.projectcalico.org                  2022-09-22T07:00:53Z
networksets.crd.projectcalico.org                      2022-09-22T07:00:53Z
nodefeaturerules.nfd.k8s-sigs.io                       2023-04-25T07:59:58Z
nodefeatures.nfd.k8s-sigs.io                           2023-04-25T07:59:58Z
<b style={{color:"yellow"}}>nodepools.kube.cloud.ovh.com                           2022-09-22T06:59:43Z</b>
podautoscalers.autoscaling.internal.knative.dev        2023-01-03T07:25:05Z
podmonitors.monitoring.coreos.com                      2023-04-26T09:19:12Z
podvolumebackups.velero.io                             2022-10-04T06:56:54Z
podvolumerestores.velero.io                            2022-10-04T06:56:54Z
probes.monitoring.coreos.com                           2023-04-26T09:19:12Z
...
```

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

### GET /dedicated/ceph/{serviceName} Example

Source: https://docs.ovhcloud.com/en/guides/storage-and-backup/block-storage/cloud-disk-array/ceph-check-cluster-status.md

Retrieves detailed information about a Ceph cluster, including status, region, and monitor IPs. The example shows a response with status 'INSTALLED' and state 'ACTIVE'.

```bash
GET /dedicated/ceph/98d166d8-7c88-47b7-9cb6-63acd5a59c15
{
  updateDate: "2016-07-26T09:16:07"
  status: "INSTALLED"
  region: "SBG1"
  serviceName: "98d166d8-7c88-47b7-9cb6-63acd5a59c15"
  state: "ACTIVE"
  createDate: "2016-07-20T08:00:37"
  cephMons: [
    "10.99.187.210"
    "10.99.191.210"
    "10.97.131.210"
  ]
  crushTunables: "OPTIMAL"
  label: "Ceph cluster"
  cephVersion: "9.2.1"
}
```

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

### Build output example

Source: https://docs.ovhcloud.com/en/guides/hosted-private-cloud/opcp/how-to-create-centos-image.md

Example output showing the generated qcow2 image and the dib-manifests directory.

```console
my-centos8-image.qcow2

my-centos8-image.d:
dib-manifests
```

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

### GET /domain/{serviceName} Response Example

Source: https://docs.ovhcloud.com/en/guides/web-cloud/domains/api-domain-dns.md

Response example for the GET /domain/{serviceName} API call. Shows the domain name details, including the nameServerType field which indicates the DNS setup type (hosted or external). The hostSupported field indicates whether hosts are supported as entities by the registry, which is relevant for glue records.

```js
{
  "parentService": null,
  "domain": "test.com",
  "offer": "gold",
  "dnssecSupported": true,
  "owoSupported": true,
  "transferLockStatus": "locked",
  "whoisOwner": "123456",
  "hostSupported": true,
  "glueRecordIpv6Supported": true,
  "glueRecordMultiIpSupported": true,
  "lastUpdate": "2021-11-02T12:01:13+01:00",
  "nameServerType": "hosted"
}
```

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

### Install OpenVPN client

Source: https://docs.ovhcloud.com/en/guides/public-cloud/network-services/stormshield-vrack.md

Installs the OpenVPN client on the instance.

```bash
sudo apt-get update
sudo apt-get install -y openvpn
```

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

### Install dependencies and run the app locally

Source: https://docs.ovhcloud.com/en/guides/public-cloud/data-platform/tutorials-app-development-react-shadcn.md

Installs dependencies and starts the development server. The dev server runs on http://localhost:3333.

```bash
npm install
npm run dev
```

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

### Generic locustfile.py example

Source: https://docs.ovhcloud.com/en/guides/public-cloud/ai-machine-learning/ai-deploy-load-test-app.md

A basic Locust load test script that defines a user class with a task that sends GET requests to /hello and /world. This is the starting point for configuring Locust.

```python
from locust import HttpUser, task

class HelloWorldUser(HttpUser):
    @task
    def hello_world(self):
        self.client.get("/hello")
        self.client.get("/world")
```

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

### Helm install notes with example Ingress and Secret

Source: https://docs.ovhcloud.com/en/guides/public-cloud/containers-orchestration/managed-kubernetes/install-nginx-ingress.md

Notes output from the Helm install, including an example Ingress resource and a TLS Secret example.

```console
NOTES:
The ingress-nginx controller has been installed.
It may take a few minutes for the LoadBalancer IP to be available.
You can watch the status by running 'kubectl --namespace ingress-nginx get services -o wide -w ingress-nginx-controller'

An example Ingress that makes use of the controller:
  apiVersion: networking.k8s.io/v1
  kind: Ingress
  metadata:
    name: example
    namespace: foo
  spec:
    ingressClassName: nginx
    rules:
      - host: www.example.com
        http:
          paths:
            - pathType: Prefix
              backend:
                service:
                  name: exampleService
                  port:
                    number: 80
              path: /
    # This section is only required if TLS is to be enabled for the Ingress
    tls:
      - hosts:
        - www.example.com
        secretName: example-tls

If TLS is enabled for the Ingress, a Secret containing the certificate and key must also be provided:

  apiVersion: v1
  kind: Secret
  metadata:
    name: example-tls
    namespace: foo
  data:
    tls.crt: <base64 encoded cert>
    tls.key: <base64 encoded key>
  type: kubernetes.io/tls
```

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

### Apply and get VirtualService example output

Source: https://docs.ovhcloud.com/en/guides/public-cloud/containers-orchestration/managed-kubernetes/traffic-management-istio.md

Example output from applying the VirtualService and retrieving its configuration, showing the created rule and the resulting VirtualService YAML.

```console
$ kubectl apply -n istio-apps -f ./reviews-50-v2-50-v3.yaml 
virtualservice.networking.istio.io/reviews created

$ kubectl -n istio-apps get virtualservice reviews -o yaml
apiVersion: networking.istio.io/v1beta1
kind: VirtualService
metadata:
[...]
spec:
  hosts:
  - reviews
  http:
  - route:
    - destination:
        host: reviews
        subset: v2
      weight: 50
    - destination:
        host: reviews
        subset: v3
      weight: 50
```

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

### Download Istio and set up istioctl

Source: https://docs.ovhcloud.com/en/guides/public-cloud/containers-orchestration/managed-kubernetes/install-istio.md

Download and extract the latest Istio release, move into the package directory, and add the istioctl client to the PATH. The package directory contains sample applications in samples/ and the istioctl binary in bin/.

```bash
curl -L https://istio.io/downloadIstio | sh -
```

```bash
cd istio-1.11.2
```

```bash
export PATH=$PWD/bin:$PATH
```

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

### Example output of kubeseal installation and version check

Source: https://docs.ovhcloud.com/en/guides/public-cloud/containers-orchestration/managed-kubernetes/encrypt-secret-sealed-secrets-kubeseal.md

Example output from installing kubeseal via Homebrew and checking its version.

```console
$ brew install kubeseal
Running `brew update --preinstall`...
==> Auto-updated Homebrew!
...
==> Pouring kubeseal--0.17.3.arm64_big_sur.bottle.tar.gz
🍺  /Users/avache/homebrew/Cellar/kubeseal/0.17.3: 5 files, 35.3MB
==> Running `brew cleanup kubeseal`...
Disable this behaviour by setting HOMEBREW_NO_INSTALL_CLEANUP.
Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`).

$ kubeseal --version
kubeseal version: v0.17.3
```
Tokens:
Raw