Install and Manage using Pulumi

Prerequisites

Pulumi installed

Install the Pulumi CLI. See Pulumi Provider for installation instructions.

Control Plane provider installed

Install the Control Plane Pulumi provider and configure your organization. See Pulumi Provider for setup instructions.

Install a Template

Use the CatalogTemplate resource to install a template from the catalog.

1. Choose a Template

   Browse the available templates in the Template Catalog and identify the template name and version you want to install.

2. Add a Values File

   Create a values.yaml file in your Pulumi project directory with the template’s configuration. Refer to the specific template’s documentation for available options.

3. Define the Resource

   Add a CatalogTemplate resource to your Pulumi program, reading the values from the file:

   TypeScript

   import * as cpln from '@pulumiverse/cpln';
   import * as fs from 'fs';
   
   const values = fs.readFileSync('values.yaml', 'utf8');
   
   const release = new cpln.CatalogTemplate('example', {
       name: 'my-release',
       template: 'postgres',
       version: '1.0.0',
       gvc: 'my-gvc',
       values: values,
   });
   

   Python

   import pulumiverse_cpln as cpln
   from pathlib import Path
   
   values = Path("values.yaml").read_text()
   
   release = cpln.CatalogTemplate(
       "example",
       name="my-release",
       template="postgres",
       version="1.0.0",
       gvc="my-gvc",
       values=values,
   )
   

   Go

   package main
   
   import (
       "os"
   
       "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
       "github.com/pulumiverse/pulumi-cpln/sdk/go/cpln"
   )
   
   func main() {
       pulumi.Run(func(ctx *pulumi.Context) error {
           valuesBytes, err := os.ReadFile("values.yaml")
           if err != nil {
               return err
           }
   
           _, err = cpln.NewCatalogTemplate(ctx, "example", &cpln.CatalogTemplateArgs{
               Name:     pulumi.String("my-release"),
               Template: pulumi.String("postgres"),
               Version:  pulumi.String("1.0.0"),
               Gvc:      pulumi.String("my-gvc"),
               Values:   pulumi.String(string(valuesBytes)),
           })
           return err
       })
   }
   

   C#

   using Pulumi;
   using Pulumiverse.Cpln;
   using System.IO;
   
   return await Deployment.RunAsync(() =>
   {
       var values = File.ReadAllText("values.yaml");
   
       var release = new CatalogTemplate("example", new CatalogTemplateArgs
       {
           Name = "my-release",
           Template = "postgres",
           Version = "1.0.0",
           Gvc = "my-gvc",
           Values = values,
       });
   });
   

   Properties:

   • name — A unique release name for this installation.
   • template — The name of the catalog template (e.g., postgres).
   • version — The template version to install.
   • gvc — The GVC to deploy to. Leave empty if the template creates its own GVC.
   • values — YAML-formatted string to customize the template configuration.
4. Deploy

   Deploy the stack:

   pulumi up
   

   Pulumi will provision the required Control Plane resources based on your configuration.

Outputs

After deploying, the resource exposes a resources output containing a list of all Control Plane resources created by the release. Each entry includes:

• kind — The resource type (e.g., workload, secret, gvc).
• name — The resource name.
• link — The full Control Plane URL for the resource.

Manage a Template

Upgrade

To upgrade a release with new values or a new template version, update the version property and/or your values.yaml file and re-deploy:

pulumi up

Any workloads affected by the change will roll out new deployments. Unchanged items will not be redeployed.

Preview Changes

Use pulumi preview to see the changes that will be applied before upgrading:

pulumi preview

Uninstall a Template

Remove the CatalogTemplate resource from your program and deploy:

pulumi up

Alternatively, destroy all resources in the stack:

pulumi destroy

This deletes all Control Plane resources created by the release.