pulumi-render


Namepulumi-render JSON
Version 0.3.12 PyPI version JSON
download
home_pageNone
SummaryA Pulumi package for creating and managing Render resources.
upload_time2024-10-05 09:28:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseApache-2.0
keywords pulumi render category/cloud kind/native
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pulumi Native Provider for Render

[Render](https://render.com/) is a unified cloud to build and run all your apps and websites with free TLS certificates, a global CDN, DDoS protection, private networks, and auto deploys from Git.

> This provider was generated using [`pulschema`](https://github.com/cloudy-sky-software/pulschema) and [`pulumi-provider-framework`](https://github.com/cloudy-sky-software/pulumi-provider-framework).

## Package SDKs

- Node.js: https://www.npmjs.com/package/@cloudyskysoftware/pulumi-render
- Python: https://pypi.org/project/pulumi-render/
- .NET: https://www.nuget.org/packages/Pulumi.Render
- Go: `import github.com/cloudyskysoftware/pulumi-render/sdk/go/render`

## Using The Provider

You'll need an API key. Follow Render's [docs](https://render.com/docs/api#getting-started) for creating one.
Then set the API key as a secret with `pulumi config set --secret render:apiKey`.

### Importing Existing Resources

Import IDs should satisfy all ID segments in the `GET` endpoint for the resource
you are importing. The IDs required in the path should be separated by `/`.
Locate the `GET` endpoint in the [OpenAPI spec](https://github.com/cloudy-sky-software/pulumi-render/blob/main/provider/cmd/pulumi-gen-render/openapi.yml).

For example, to read a custom domain, the path in the OpenAPI spec is: `GET /services/{serviceId}/custom-domains/{customDomainIdOrName}`.

Thus, the `pulumi import` command to run is:

```bash
# The type render:services:CustomDomain can be easily found by using your IDEs
# Go To Definition functionality for the resource and looking at the type
# property defined in the custom resource's class definition.
pulumi import render:services:CustomDomain {resourceName} /{serviceId}/{customDomainIdOrName}
```

Alternatively, you can also import using the `import` Pulumi resource option.
Run `pulumi up` to import the resource into your stack's state. Once imported,
you should remove the `import` resource option.

```typescript
const myCustomDomain = new render.services.CustomDomain(
  "myCustomDomain",
  { name: "www.somedomain.com", serviceId: staticSite.id },
  {
    protect: true,
    import: `/srv-xxxxxxxxxxxxxxx/www.somedomain.com`,
  }
);
```

Refer to the Pulumi [docs](https://www.pulumi.com/docs/iac/adopting-pulumi/import/) for importing a
resource.

## Releasing A New Version

:info: Switch to the `main` branch first and get the latest `git pull origin main && git fetch`. Check what the last release tag was.

1. Regular releases should just increment the patch version unless a minor or a major (breaking changes) version bump is warranted.
1. Update the `CHANGELOG.md` with notes about what will be included in this release.
1. Commit the changelog with `git commit -am "vX.Y.Z"` or something similar and push `git push origin main`.
1. Tag the commit with the release version by running

   ```bash
   git tag vX.Y.Z
   git tag sdk/vX.Y.Z
   ```

1. Push the tags.

   ```bash
   git push --tags
   ```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pulumi-render",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "pulumi, render, category/cloud, kind/native",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/7d/07/b6d54ae8c0edd71d9e1e3b031a65c32fea827f5efd295defd56e31e25dc4/pulumi_render-0.3.12.tar.gz",
    "platform": null,
    "description": "# Pulumi Native Provider for Render\n\n[Render](https://render.com/) is a unified cloud to build and run all your apps and websites with free TLS certificates, a global CDN, DDoS protection, private networks, and auto deploys from Git.\n\n> This provider was generated using [`pulschema`](https://github.com/cloudy-sky-software/pulschema) and [`pulumi-provider-framework`](https://github.com/cloudy-sky-software/pulumi-provider-framework).\n\n## Package SDKs\n\n- Node.js: https://www.npmjs.com/package/@cloudyskysoftware/pulumi-render\n- Python: https://pypi.org/project/pulumi-render/\n- .NET: https://www.nuget.org/packages/Pulumi.Render\n- Go: `import github.com/cloudyskysoftware/pulumi-render/sdk/go/render`\n\n## Using The Provider\n\nYou'll need an API key. Follow Render's [docs](https://render.com/docs/api#getting-started) for creating one.\nThen set the API key as a secret with `pulumi config set --secret render:apiKey`.\n\n### Importing Existing Resources\n\nImport IDs should satisfy all ID segments in the `GET` endpoint for the resource\nyou are importing. The IDs required in the path should be separated by `/`.\nLocate the `GET` endpoint in the [OpenAPI spec](https://github.com/cloudy-sky-software/pulumi-render/blob/main/provider/cmd/pulumi-gen-render/openapi.yml).\n\nFor example, to read a custom domain, the path in the OpenAPI spec is: `GET /services/{serviceId}/custom-domains/{customDomainIdOrName}`.\n\nThus, the `pulumi import` command to run is:\n\n```bash\n# The type render:services:CustomDomain can be easily found by using your IDEs\n# Go To Definition functionality for the resource and looking at the type\n# property defined in the custom resource's class definition.\npulumi import render:services:CustomDomain {resourceName} /{serviceId}/{customDomainIdOrName}\n```\n\nAlternatively, you can also import using the `import` Pulumi resource option.\nRun `pulumi up` to import the resource into your stack's state. Once imported,\nyou should remove the `import` resource option.\n\n```typescript\nconst myCustomDomain = new render.services.CustomDomain(\n  \"myCustomDomain\",\n  { name: \"www.somedomain.com\", serviceId: staticSite.id },\n  {\n    protect: true,\n    import: `/srv-xxxxxxxxxxxxxxx/www.somedomain.com`,\n  }\n);\n```\n\nRefer to the Pulumi [docs](https://www.pulumi.com/docs/iac/adopting-pulumi/import/) for importing a\nresource.\n\n## Releasing A New Version\n\n:info: Switch to the `main` branch first and get the latest `git pull origin main && git fetch`. Check what the last release tag was.\n\n1. Regular releases should just increment the patch version unless a minor or a major (breaking changes) version bump is warranted.\n1. Update the `CHANGELOG.md` with notes about what will be included in this release.\n1. Commit the changelog with `git commit -am \"vX.Y.Z\"` or something similar and push `git push origin main`.\n1. Tag the commit with the release version by running\n\n   ```bash\n   git tag vX.Y.Z\n   git tag sdk/vX.Y.Z\n   ```\n\n1. Push the tags.\n\n   ```bash\n   git push --tags\n   ```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A Pulumi package for creating and managing Render resources.",
    "version": "0.3.12",
    "project_urls": {
        "Homepage": "https://cloudysky.software",
        "Repository": "https://github.com/cloudy-sky-software/pulumi-render"
    },
    "split_keywords": [
        "pulumi",
        " render",
        " category/cloud",
        " kind/native"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3873d1470c23828bb3b0177fa4359bb7b9487e78fdb57cc8ae0d82b7457566e",
                "md5": "71e227aeaca340697f9340322e5c6d34",
                "sha256": "208ed7cec41200b3954741283f228e90c4f5dd9995a487603081c95df3244239"
            },
            "downloads": -1,
            "filename": "pulumi_render-0.3.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "71e227aeaca340697f9340322e5c6d34",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 210176,
            "upload_time": "2024-10-05T09:28:53",
            "upload_time_iso_8601": "2024-10-05T09:28:53.029188Z",
            "url": "https://files.pythonhosted.org/packages/d3/87/3d1470c23828bb3b0177fa4359bb7b9487e78fdb57cc8ae0d82b7457566e/pulumi_render-0.3.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d07b6d54ae8c0edd71d9e1e3b031a65c32fea827f5efd295defd56e31e25dc4",
                "md5": "266978e2679c749bbe7ffd66d370158f",
                "sha256": "e1560c2df20a247897ccd2dff048a46ac88588e076d6442adcb336dca6b82258"
            },
            "downloads": -1,
            "filename": "pulumi_render-0.3.12.tar.gz",
            "has_sig": false,
            "md5_digest": "266978e2679c749bbe7ffd66d370158f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 94085,
            "upload_time": "2024-10-05T09:28:54",
            "upload_time_iso_8601": "2024-10-05T09:28:54.887040Z",
            "url": "https://files.pythonhosted.org/packages/7d/07/b6d54ae8c0edd71d9e1e3b031a65c32fea827f5efd295defd56e31e25dc4/pulumi_render-0.3.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-05 09:28:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cloudy-sky-software",
    "github_project": "pulumi-render",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pulumi-render"
}
        
Elapsed time: 4.88497s