[](https://github.com/unplatform-io/pulumi-commercetools/actions)
[](https://www.npmjs.com/package/@unplatform/commercetools)
[](https://pypi.org/project/pulumi-commercetools)
[](https://badge.fury.io/nu/pulumi.commercetools)
[](https://pkg.go.dev/github.com/unplatform-io/pulumi-commercetools/sdk/v2/go)
# CommerceTools provider
The CommerceTools resource provider for Pulumi lets you provision [CommerceTools](https://commercetools.com/) resources.
This provider is a [bridge](https://github.com/pulumi/pulumi-terraform-bridge) to the excellent [CommerceTools Terraform Provider](https://github.com/labd/terraform-provider-commercetools) from the Labd folks.
To use this package, please [install the Pulumi CLI first](https://pulumi.io/).
## Installing
The plugin itself needs to be installed by running:
pulumi plugin install --server https://github.com/unplatform-io/pulumi-commercetools/releases/download/v0.0.0 resource commercetools v0.0.0
Where v0.0.0 is the desired version.
This SDK is available in many languages in the standard packaging formats.
### Node.js (Java/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
$ npm install @unplatform/commercetools
or `yarn`:
$ yarn add @unplatform/commercetools
### Python
To use from Python, install using `pip`:
$ pip install pulumi_commercetools
### Go
To use from Go, use `go get` to grab the latest version of the library
$ go get github.com/unplatform-io/pulumi-commercetools/sdk/v2/go/...
### .NET
To use from .NET, install using `dotnet add package`:
$ dotnet add package Pulumi.CommerceTools
## Configuration
The following configuration points are available for the `commercetools` provider:
- `commercetools:apiUrl` - the url of the commercetools api (e.g. `https://api.europe-west1.gcp.commercetools.com`)
- `commercetools:tokenUrl` - the url used to authenticate (e.g. `https://auth.europe-west1.gcp.commercetools.com`)
- `commercetools:scopes` - the authentication scopes needed
- `commercetools:clientId` - the client id used to authenticate
- `commercetools:clientSecret` - the client secret used to authenticate
- `commercetools:projectKey` - the key of the commerce tools project
## Reference
For detailed reference documentation, please visit [the docs of the commerce tools terraform provider][1].
[1]: https://commercetools-terraform-provider.readthedocs.io/en/latest/
## Upgrading the pulumi plugin
To upgrade the plugin to a never version of the upstream terraform client the following steps should be taken:
- Update the submodule: `git submodule update --remote --merge`
- Validate if the patches in `upstream_patches/` are still valid e.g.
- They might reference the wrong line of code
- They might be unneeded
- Validate if there are new mappings / changed mappings in `provider/resources.go`
- You can check if there are new items by reading the console output of `make tfgen`
- If upstream has stopped using terraform SDK and now fully uses terraform plugin framework:
- Remove the muxer in `provider/resources.go`, `provider/cmd/pulumi-*-commercetools/main.go` and the `provider/shim/shim.go`
- Validate the current implementation with the documentation on [How to Bridge a Provider](https://github.com/pulumi/pulumi-terraform-bridge/blob/master/pf/README.md)
- Rebuild the SDK's using `make build_sdks`
- Validate the functionality using the sample project, make sure to fill in valid credentials in `Pulumi.commercetools-test.yml`
Raw data
{
"_id": null,
"home_page": "https://pulumi.io",
"name": "pulumi-commercetools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pulumi commercetools",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a1/04/1019912fca0d2077c3d40b3bd5724dbcecfed824bc9e0dfa7e1d5d35c04d/pulumi_commercetools-1.14.1.tar.gz",
"platform": null,
"description": "[](https://github.com/unplatform-io/pulumi-commercetools/actions)\n[](https://www.npmjs.com/package/@unplatform/commercetools)\n[](https://pypi.org/project/pulumi-commercetools)\n[](https://badge.fury.io/nu/pulumi.commercetools)\n[](https://pkg.go.dev/github.com/unplatform-io/pulumi-commercetools/sdk/v2/go)\n\n# CommerceTools provider\nThe CommerceTools resource provider for Pulumi lets you provision [CommerceTools](https://commercetools.com/) resources.\n\nThis provider is a [bridge](https://github.com/pulumi/pulumi-terraform-bridge) to the excellent [CommerceTools Terraform Provider](https://github.com/labd/terraform-provider-commercetools) from the Labd folks.\n\nTo use this package, please [install the Pulumi CLI first](https://pulumi.io/).\n\n## Installing\n\nThe plugin itself needs to be installed by running:\n\n pulumi plugin install --server https://github.com/unplatform-io/pulumi-commercetools/releases/download/v0.0.0 resource commercetools v0.0.0\n\nWhere v0.0.0 is the desired version.\n\nThis SDK is available in many languages in the standard packaging formats.\n\n### Node.js (Java/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n $ npm install @unplatform/commercetools\n\nor `yarn`:\n\n $ yarn add @unplatform/commercetools\n\n### Python\n\nTo use from Python, install using `pip`:\n\n $ pip install pulumi_commercetools\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library\n\n $ go get github.com/unplatform-io/pulumi-commercetools/sdk/v2/go/...\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n $ dotnet add package Pulumi.CommerceTools\n\n## Configuration\n\nThe following configuration points are available for the `commercetools` provider:\n\n- `commercetools:apiUrl` - the url of the commercetools api (e.g. `https://api.europe-west1.gcp.commercetools.com`)\n- `commercetools:tokenUrl` - the url used to authenticate (e.g. `https://auth.europe-west1.gcp.commercetools.com`)\n- `commercetools:scopes` - the authentication scopes needed\n- `commercetools:clientId` - the client id used to authenticate\n- `commercetools:clientSecret` - the client secret used to authenticate\n- `commercetools:projectKey` - the key of the commerce tools project\n\n## Reference\n\nFor detailed reference documentation, please visit [the docs of the commerce tools terraform provider][1].\n\n[1]: https://commercetools-terraform-provider.readthedocs.io/en/latest/\n\n\n## Upgrading the pulumi plugin\nTo upgrade the plugin to a never version of the upstream terraform client the following steps should be taken:\n- Update the submodule: `git submodule update --remote --merge`\n- Validate if the patches in `upstream_patches/` are still valid e.g.\n - They might reference the wrong line of code\n - They might be unneeded\n- Validate if there are new mappings / changed mappings in `provider/resources.go`\n - You can check if there are new items by reading the console output of `make tfgen`\n- If upstream has stopped using terraform SDK and now fully uses terraform plugin framework:\n - Remove the muxer in `provider/resources.go`, `provider/cmd/pulumi-*-commercetools/main.go` and the `provider/shim/shim.go`\n - Validate the current implementation with the documentation on [How to Bridge a Provider](https://github.com/pulumi/pulumi-terraform-bridge/blob/master/pf/README.md)\n- Rebuild the SDK's using `make build_sdks`\n- Validate the functionality using the sample project, make sure to fill in valid credentials in `Pulumi.commercetools-test.yml`\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing commercetools cloud resources.",
"version": "1.14.1",
"project_urls": {
"Homepage": "https://pulumi.io",
"Repository": "https://github.com/unplatform-io/pulumi-commercetools"
},
"split_keywords": [
"pulumi",
"commercetools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1041019912fca0d2077c3d40b3bd5724dbcecfed824bc9e0dfa7e1d5d35c04d",
"md5": "1e5b650be24f82de9202e892d8f8085b",
"sha256": "84e58890a06ece6a7f7cc7aed00bddc9f90489aa884520b4d346d928be40514d"
},
"downloads": -1,
"filename": "pulumi_commercetools-1.14.1.tar.gz",
"has_sig": false,
"md5_digest": "1e5b650be24f82de9202e892d8f8085b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 60012,
"upload_time": "2024-03-21T09:30:19",
"upload_time_iso_8601": "2024-03-21T09:30:19.384580Z",
"url": "https://files.pythonhosted.org/packages/a1/04/1019912fca0d2077c3d40b3bd5724dbcecfed824bc9e0dfa7e1d5d35c04d/pulumi_commercetools-1.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 09:30:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "unplatform-io",
"github_project": "pulumi-commercetools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-commercetools"
}
JSON
