OVH Cloud resource plugin for Formae. This plugin enables Formae to manage OVH Public Cloud resources using the OpenStack APIs via gophercloud.

This plugin supports 10 OVH Public Cloud resource types across 3 services:

See schema/pkl/ for the complete list of supported resource types.

Configure an OVH target in your Forma file:

import "@formae/formae.pkl"
import "@ovh/ovh.pkl"

target: formae.Target = new formae.Target {
    label = "ovh-target"
    config = new ovh.Config {
        authURL = "https://auth.cloud.ovh.net/v3"  // EU regions
        // authURL = "https://auth.cloud.ovh.us/v3"  // US regions
        region = "GRA7"  // See supported regions below
    }
}

Supported Regions:

• BHS5 - Beauharnois, Canada
• DE1 - Frankfurt, Germany
• GRA7, GRA9 - Gravelines, France
• SBG5 - Strasbourg, France
• UK1 - London, UK
• WAW1 - Warsaw, Poland
• US-EAST-VA-1 - Virginia, USA

This plugin requires two sets of credentials:

1. OVH Cloud API — for OVH-specific resources (DNS, Database, Kube, Registry)
2. OpenStack API — for infrastructure resources (Compute, Network, Storage)

export OVH_ENDPOINT="ovh-eu"              # Optional: ovh-eu (default), ovh-ca, ovh-us
export OVH_APPLICATION_KEY="your-app-key"
export OVH_APPLICATION_SECRET="your-app-secret"
export OVH_CONSUMER_KEY="your-consumer-key"
export OVH_CLOUD_PROJECT_ID="your-project-id"

Getting OVH API Credentials:

1. Create an application at the /createApp/ URL for your region — note the Application Key and Secret

2. Request a consumer key using the API (the /createToken/ web UI may not work for all account types):

   curl -X POST "https://eu.api.ovh.com/1.0/auth/credential" \
     -H "X-Ovh-Application: YOUR_APP_KEY" \
     -H "Content-Type: application/json" \
     -d '{"accessRules":[{"method":"GET","path":"/*"},{"method":"POST","path":"/*"},{"method":"PUT","path":"/*"},{"method":"DELETE","path":"/*"}]}'

   For US, replace the URL with https://api.us.ovhcloud.com/1.0/auth/credential.

   This returns a consumerKey and a validationUrl.

3. Validate the consumer key by opening the validationUrl in your browser and approving access. The consumer key will not work until validated.

4. Find your Cloud Project ID in the OVH Control Panel under Public Cloud:

   • EU: https://www.ovh.com/manager/
   • US: https://us.ovhcloud.com/manager/

Note: Accounts are region-specific. EU credentials do not work on the US endpoint and vice versa. You must create the application and token on the same regional endpoint.

export OS_USERNAME="your-openstack-username"
export OS_PASSWORD="your-openstack-password"
export OS_PROJECT_ID="your-project-id"
export OS_USER_DOMAIN_NAME="Default"       # Optional, defaults to "Default"

Getting OpenStack Credentials:

1. Go to the OVH Control Panel
2. Navigate to Public Cloud > Project > Users & Roles
3. Create a new user or use an existing one
4. Download the OpenStack RC file or note the credentials

See the examples/ directory for usage examples.

# Evaluate an example
formae eval examples/lifeline/basic_infrastructure.pkl

# Apply resources
formae apply --mode reconcile --watch examples/lifeline/basic_infrastructure.pkl

This plugin is licensed under the Functional Source License, Version 1.1, ALv2 Future License (FSL-1.1-ALv2).

Copyright 2025 Platform Engineering Labs Inc.