@cloudyskysoftware/pulumi-render 0.3.10 → 0.3.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,6 +16,41 @@
|
|
|
16
16
|
You'll need an API key. Follow Render's [docs](https://render.com/docs/api#getting-started) for creating one.
|
|
17
17
|
Then set the API key as a secret with `pulumi config set --secret render:apiKey`.
|
|
18
18
|
|
|
19
|
+
### Importing Existing Resources
|
|
20
|
+
|
|
21
|
+
Import IDs should satisfy all ID segments in the `GET` endpoint for the resource
|
|
22
|
+
you are importing. The IDs required in the path should be separated by `/`.
|
|
23
|
+
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).
|
|
24
|
+
|
|
25
|
+
For example, to read a custom domain, the path in the OpenAPI spec is: `GET /services/{serviceId}/custom-domains/{customDomainIdOrName}`.
|
|
26
|
+
|
|
27
|
+
Thus, the `pulumi import` command to run is:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# The type render:services:CustomDomain can be easily found by using your IDEs
|
|
31
|
+
# Go To Definition functionality for the resource and looking at the type
|
|
32
|
+
# property defined in the custom resource's class definition.
|
|
33
|
+
pulumi import render:services:CustomDomain {resourceName} /{serviceId}/{customDomainIdOrName}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Alternatively, you can also import using the `import` Pulumi resource option.
|
|
37
|
+
Run `pulumi up` to import the resource into your stack's state. Once imported,
|
|
38
|
+
you should remove the `import` resource option.
|
|
39
|
+
|
|
40
|
+
```typescript
|
|
41
|
+
const myCustomDomain = new render.services.CustomDomain(
|
|
42
|
+
"myCustomDomain",
|
|
43
|
+
{ name: "www.somedomain.com", serviceId: staticSite.id },
|
|
44
|
+
{
|
|
45
|
+
protect: true,
|
|
46
|
+
import: `/srv-xxxxxxxxxxxxxxx/www.somedomain.com`,
|
|
47
|
+
}
|
|
48
|
+
);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Refer to the Pulumi [docs](https://www.pulumi.com/docs/iac/adopting-pulumi/import/) for importing a
|
|
52
|
+
resource.
|
|
53
|
+
|
|
19
54
|
## Releasing A New Version
|
|
20
55
|
|
|
21
56
|
:info: Switch to the `main` branch first and get the latest `git pull origin main && git fetch`. Check what the last release tag was.
|