Skip to content

Custom Blueprint

Customers can create and manage "Custom Cluster Blueprints" by adding "addons" to the default cluster blueprints. It is important to emphasize that this "builds on" and "extends" the "Default Cluster Blueprints" and does not replace it.


Other than the default cluster blueprint which is common across all projects, all custom blueprints are scoped to a Project. This isolation boundary guarantees that there is no accidental spillover or leakage.


The lifecycle of cluster blueprints is managed by users with an "infrastructure administrator" role in Rafay.

Step 1: Create Custom Blueprint

As an Admin in the Rafay Console,

  • Navigate to the Project
  • Click on Blueprints under Infrastructure
  • Click on New blueprint
  • Provide a name and description

New Blueprint

All custom cluster blueprints are version controlled so that the lifecycle can be properly managed. In this example, the admin has not yet configured anything yet. So, no versions are available yet.

New Blueprint

Step 2: New Version

  • Click on New Version and use the wizard to provide details
  • Provide a version number/name
  • Select PSPs and scoping (cluster or namespace)
  • Select custom addons and identity version of the addon
  • Optionally disable addons from the default blueprint (i.e. Ingress Controller)
  • Save

In the example below, we have created a custom blueprint called "production" with Kubeless as the custom addon.

New Version

View Versions

The entire history of blueprint versions are maintained on the Rafay Controller. Admins can view details about the versions of cluster blueprints.

View All Versions

Filter Clusters by Blueprint

Infrastructure admins can "filter" clusters by blueprint name using the Rafay Console to efficiently manage a fleet of clusters. An illustrative example is shown below.

Filter Clusters by Blueprint

View All Cluster Blueprints

Admins can view all custom cluster blueprints

  • Navigate to the Project
  • Click on Blueprints under Infrastructure.

This will display both the "default cluster blueprint" as well as any cluster blueprints that have been created. An illustrative example is shown below.

View Cluster Blueprints

Apply Custom Blueprint

Once a custom cluster blueprint has been created and published, it can be used for both during initial provisioning of clusters or can be applied to existing clusters.

New Clusters

While creating a new cluster, select the "custom blueprint" from the dropdown. An illustrative example is shown below

Blueprint for New Cluster

Existing Clusters

  • Click on options (gear icon on far right) for an existing cluster.
  • Select "Update Blueprint" from the options
  • Select the "blueprint" and "version" from the dropdown.
  • Click on Save and Publish

Blueprint for Existing Cluster

This will start the update of the cluster blueprint on the target cluster. Once all the required resources are operational on the cluster, the blueprint update/sync will be complete.

Status and Debug

In addition to using the Zero Trust KubeCTL channel for debug and diagnostics, admins can also use the built in status details if issues are encountered during a blueprint sync process with a cluster.

In the Blueprint Sync Status field on the cluster, click on the Status link. This will provide detailed status by component in the blueprint.

An illustrative example is shown below

Deep Blueprint Status