# OVH Resource Provider
The OVH Resource Provider lets you manage [OVHcloud](https://www.ovhcloud.com/en/) resources.
<a href="https://github.com/scraly/pulumi-ovh/releases/latest"><img alt="GitHub release" src="https://img.shields.io/github/v/release/scraly/pulumi-ovh?logo=github&style=flat-square"></a>
[](https://godoc.org/github.com/scraly/pulumi-ovh)
[](https://badge.fury.io/js/@scraly%2Fpulumi-ovh)
[](https://badge.fury.io/py/scraly-pulumi-ovh)
[](https://badge.fury.io/nu/Scraly.PulumiPackage.Ovh)
<a href="https://gitpod.io/#https://github.com/scraly/pulumi-ovh"><img src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod" alt="Contribute with Gitpod"/></a>
## Usage
This package is available for several languages/platforms:
### Node.js (JavaScript/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
```bash
npm install @scraly/pulumi-ovh
```
or `yarn`:
```bash
yarn add @scraly/pulumi-ovh
```
### Python
To use from Python, install using `pip`:
```bash
pip install scraly-pulumi-ovh
```
### Go
To use from Go, use `go get` to grab the latest version of the library:
```bash
go get github.com/scraly/pulumi-ovh/sdk/go/...
```
### .NET
To use from .NET, install using `dotnet add package`:
```bash
dotnet add package Scraly.PulumiPackage.Ovh
```
## Configuration
The following configuration points are available for the `Ovh` provider:
- `ovh:endpoint` (environment: `OVH_ENDPOINT`) - the Ovh endpoint, such `ovh-eu`
- `ovh:applicationKey` (environment: `OVH_APPLICATION_KEY`) - the Ovh application key
- `ovh:applicationSecret` (environment: `OVH_APPLICATION_SECRET`) - the Ovh application secret
- `ovh:consumerKey` (environment: `OVH_CONSUMER_KEY`) - the Ovh consumer key
## Upgrading/Sync with existing Terraform provider
* install gh CLI
* Install upgrade-provider CLI
* create and retrieve your GitHub Personal access token (PAT)
* export it:
```bash
$ export GITHUB_TOKEN="<your-gh-pat>"
```
* execute the upgrade-provider CLI:
If the provider is already up to date:
```bash
$ upgrade-provider scraly/pulumi-ovh
---- Setting Up Environment ----
- ✓ GOWORK="off": done
- ✓ PULUMI_MISSING_DOCS_ERROR="false": done
- ✓ PULUMI_CONVERT_EXAMPLES_CACHE_DIR="": done
---- Discovering Repository ----
- Ensure 'github.com/scraly/pulumi-ovh'
- ✓ Expected Location: /workspace/pulumi-ovh
- ✓ Downloading: skipped - already exists
- ✓ Validating: done
- pull default branch
- ✓ /usr/bin/git ls-remote --heads origin: done
- ✓ finding default branch: main
- ✓ /usr/bin/git fetch: done
- ✓ /usr/bin/git checkout main: done
- ✓ /usr/bin/git pull origin: done
- ✓ Repo kind: plain
- X Planning Provider Update: current upstream version 0.32.0 is greater than/ equal to the target version 0.32.0
```
In this case, OK nothing to do :)
If the provider need to be upgraded:
```bash
$ upgrade-provider scraly/pulumi-ovh
---- Setting Up Environment ----
- ✓ GOWORK="off": done
- ✓ PULUMI_MISSING_DOCS_ERROR="false": done
- ✓ PULUMI_CONVERT_EXAMPLES_CACHE_DIR="": done
---- Discovering Repository ----
- Ensure 'github.com/scraly/pulumi-ovh'
- ✓ Expected Location: /workspaces/pulumi-ovh
- ✓ Downloading: skipped - already exists
- ✓ Validating: done
- pull default branch
- ✓ /usr/bin/git ls-remote --heads origin: done
- ✓ finding default branch: main
- ✓ /usr/bin/git fetch: done
- ✓ /usr/bin/git checkout main: done
- ✓ /usr/bin/git pull origin: done
- ✓ Repo kind: plain
- ✓ Planning Provider Update: 0.32.0 -> 0.33.0
- ✓ Planning Bridge Update: v3.53.0 -> v3.57.0
- ✓ Planning Plugin SDK Update: v2.26.1 -> 2.27.0
- ✓ Planning Plugin Framework Update: -> 0.15.2
---- Update Artifacts ----
- Ensure Branch
- ✓ /usr/bin/git branch: done
- ✓ Already exists: no
- ✓ /usr/bin/git checkout -b upgrade-terraform-provider-ovh-to-v0.33.0: done
- ✓ /usr/bin/git checkout upgrade-terraform-provider-ovh-to-v0.33.0: done
- Update TF Provider
- ✓ Update TF Plugin SDK Fork: updated
- ✓ /usr/local/go/bin/go mod tidy: done
- ✓ Lookup Tag SHA: 6f0cc4b7d791d1682b613e2c2cbd9a48d4267686
- ✓ /usr/local/go/bin/go get github.com/ovh/terraform-provider-ovh@6f0cc4b7d791d1682...: done
- ✓ /usr/local/go/bin/go get github.com/pulumi/pulumi-terraform-bridge/v3@v3.57.0: done
- ✓ /usr/local/go/bin/go get github.com/pulumi/pulumi-terraform-bridge/pf@v0.15.2: done
- ✓ /usr/local/go/bin/go mod tidy: done
- ✓ /usr/local/go/bin/go mod tidy: done
- ✓ /bin/echo Plugins not removed.: done
- X /usr/bin/make tfgen: exit status 2:
[resource plugin random-4.8.2] installing
warning: A new version of Pulumi is available. To upgrade from version '3.78.1' to '3.79.0', run
$ curl -sSL https://get.pulumi.com | sh
or visit https://pulumi.com/docs/install/ for manual instructions and release notes.
```
Add new TF resources in `provider/resources.go` file and execute the command again and again.
## Reference
For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/ovh/api-docs/).
Raw data
{
"_id": null,
"home_page": "https://www.pulumi.com",
"name": "scraly-pulumi-ovh",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "pulumi ovh category/cloud",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f6/3a/ebca1525a82a8212596398f70aefc9707490c8fbabe4d27a4d2f25bd74ce/scraly_pulumi_ovh-0.33.0.tar.gz",
"platform": null,
"description": "# OVH Resource Provider\n\nThe OVH Resource Provider lets you manage [OVHcloud](https://www.ovhcloud.com/en/) resources.\n\n<a href=\"https://github.com/scraly/pulumi-ovh/releases/latest\"><img alt=\"GitHub release\" src=\"https://img.shields.io/github/v/release/scraly/pulumi-ovh?logo=github&style=flat-square\"></a>\n[](https://godoc.org/github.com/scraly/pulumi-ovh)\n[](https://badge.fury.io/js/@scraly%2Fpulumi-ovh)\n[](https://badge.fury.io/py/scraly-pulumi-ovh)\n[](https://badge.fury.io/nu/Scraly.PulumiPackage.Ovh)\n<a href=\"https://gitpod.io/#https://github.com/scraly/pulumi-ovh\"><img src=\"https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod\" alt=\"Contribute with Gitpod\"/></a>\n\n## Usage\n\nThis package is available for several languages/platforms:\n\n### Node.js (JavaScript/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n```bash\nnpm install @scraly/pulumi-ovh\n```\n\nor `yarn`:\n\n```bash\nyarn add @scraly/pulumi-ovh\n```\n\n### Python\n\nTo use from Python, install using `pip`:\n\n```bash\npip install scraly-pulumi-ovh\n```\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library:\n\n```bash\ngo get github.com/scraly/pulumi-ovh/sdk/go/...\n```\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n```bash\ndotnet add package Scraly.PulumiPackage.Ovh\n```\n\n## Configuration\n\nThe following configuration points are available for the `Ovh` provider:\n\n- `ovh:endpoint` (environment: `OVH_ENDPOINT`) - the Ovh endpoint, such `ovh-eu`\n- `ovh:applicationKey` (environment: `OVH_APPLICATION_KEY`) - the Ovh application key\n- `ovh:applicationSecret` (environment: `OVH_APPLICATION_SECRET`) - the Ovh application secret\n- `ovh:consumerKey` (environment: `OVH_CONSUMER_KEY`) - the Ovh consumer key\n\n## Upgrading/Sync with existing Terraform provider\n\n* install gh CLI\n* Install upgrade-provider CLI\n* create and retrieve your GitHub Personal access token (PAT)\n* export it:\n\n```bash\n$ export GITHUB_TOKEN=\"<your-gh-pat>\"\n```\n\n* execute the upgrade-provider CLI:\n\nIf the provider is already up to date:\n\n```bash\n$ upgrade-provider scraly/pulumi-ovh\n---- Setting Up Environment ----\n- \u2713 GOWORK=\"off\": done\n- \u2713 PULUMI_MISSING_DOCS_ERROR=\"false\": done\n- \u2713 PULUMI_CONVERT_EXAMPLES_CACHE_DIR=\"\": done\n---- Discovering Repository ----\n- Ensure 'github.com/scraly/pulumi-ovh'\n - \u2713 Expected Location: /workspace/pulumi-ovh\n - \u2713 Downloading: skipped - already exists\n - \u2713 Validating: done\n- pull default branch\n - \u2713 /usr/bin/git ls-remote --heads origin: done\n - \u2713 finding default branch: main\n - \u2713 /usr/bin/git fetch: done\n - \u2713 /usr/bin/git checkout main: done\n - \u2713 /usr/bin/git pull origin: done\n- \u2713 Repo kind: plain\n- X Planning Provider Update: current upstream version 0.32.0 is greater than/ equal to the target version 0.32.0\n```\n\nIn this case, OK nothing to do :)\n\nIf the provider need to be upgraded:\n```bash\n$ upgrade-provider scraly/pulumi-ovh\n---- Setting Up Environment ----\n- \u2713 GOWORK=\"off\": done\n- \u2713 PULUMI_MISSING_DOCS_ERROR=\"false\": done\n- \u2713 PULUMI_CONVERT_EXAMPLES_CACHE_DIR=\"\": done\n---- Discovering Repository ----\n- Ensure 'github.com/scraly/pulumi-ovh'\n - \u2713 Expected Location: /workspaces/pulumi-ovh\n - \u2713 Downloading: skipped - already exists\n - \u2713 Validating: done\n- pull default branch\n - \u2713 /usr/bin/git ls-remote --heads origin: done\n - \u2713 finding default branch: main\n - \u2713 /usr/bin/git fetch: done\n - \u2713 /usr/bin/git checkout main: done\n - \u2713 /usr/bin/git pull origin: done\n- \u2713 Repo kind: plain\n- \u2713 Planning Provider Update: 0.32.0 -> 0.33.0\n- \u2713 Planning Bridge Update: v3.53.0 -> v3.57.0\n- \u2713 Planning Plugin SDK Update: v2.26.1 -> 2.27.0\n- \u2713 Planning Plugin Framework Update: -> 0.15.2\n---- Update Artifacts ----\n- Ensure Branch\n - \u2713 /usr/bin/git branch: done\n - \u2713 Already exists: no\n - \u2713 /usr/bin/git checkout -b upgrade-terraform-provider-ovh-to-v0.33.0: done\n - \u2713 /usr/bin/git checkout upgrade-terraform-provider-ovh-to-v0.33.0: done\n- Update TF Provider\n - \u2713 Update TF Plugin SDK Fork: updated\n - \u2713 /usr/local/go/bin/go mod tidy: done\n - \u2713 Lookup Tag SHA: 6f0cc4b7d791d1682b613e2c2cbd9a48d4267686\n - \u2713 /usr/local/go/bin/go get github.com/ovh/terraform-provider-ovh@6f0cc4b7d791d1682...: done\n- \u2713 /usr/local/go/bin/go get github.com/pulumi/pulumi-terraform-bridge/v3@v3.57.0: done\n- \u2713 /usr/local/go/bin/go get github.com/pulumi/pulumi-terraform-bridge/pf@v0.15.2: done\n- \u2713 /usr/local/go/bin/go mod tidy: done\n- \u2713 /usr/local/go/bin/go mod tidy: done\n- \u2713 /bin/echo Plugins not removed.: done\n- X /usr/bin/make tfgen: exit status 2:\n[resource plugin random-4.8.2] installing\nwarning: A new version of Pulumi is available. To upgrade from version '3.78.1' to '3.79.0', run \n $ curl -sSL https://get.pulumi.com | sh\nor visit https://pulumi.com/docs/install/ for manual instructions and release notes.\n\n\n\n```\n\nAdd new TF resources in `provider/resources.go` file and execute the command again and again.\n\n## Reference\n\nFor detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/ovh/api-docs/).\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing OVH resources.",
"version": "0.33.0",
"project_urls": {
"Homepage": "https://www.pulumi.com",
"Repository": "https://github.com/scraly/pulumi-ovh"
},
"split_keywords": [
"pulumi",
"ovh",
"category/cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f63aebca1525a82a8212596398f70aefc9707490c8fbabe4d27a4d2f25bd74ce",
"md5": "fc80953e89975b7c3feba824156afc21",
"sha256": "0cb527d9f6b988997dcb0182a27cd635c1d41c44db7791567baac12b51c78116"
},
"downloads": -1,
"filename": "scraly_pulumi_ovh-0.33.0.tar.gz",
"has_sig": false,
"md5_digest": "fc80953e89975b7c3feba824156afc21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 226469,
"upload_time": "2023-08-28T10:02:13",
"upload_time_iso_8601": "2023-08-28T10:02:13.758043Z",
"url": "https://files.pythonhosted.org/packages/f6/3a/ebca1525a82a8212596398f70aefc9707490c8fbabe4d27a4d2f25bd74ce/scraly_pulumi_ovh-0.33.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-28 10:02:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scraly",
"github_project": "pulumi-ovh",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "scraly-pulumi-ovh"
}
JSON
