KOP Blueprints - Default Blueprints - Rafay Product Documentation

Overview

Overview

In order to streamline cluster deployments and installation of commonly used services, the platform has default blueprints in the system that can be leveraged by admins. There are two primary use cases for default system blueprints:

Use Cases


Navigating to Default Blueprints

As an Admin, login into the Web Console

In the example below, the dashboard shows that there are >300 versions of the default blueprint over the entire lifecycle and that there two clusters in the Project based on the default blueprint

Clicking on the clusters link will display the status of the default blueprint on the list of clusters. An illustrative example is shown below.


Types of Default Blueprints

There are two types of default blueprints that are available in the platform today:

The following table summarizes the blueprints that can be used for each cluster type (imported or created). All cluster types support the minimal blueprint. If you want to use the default blueprint type, use the one as specified in the table that corresponds to your cluster type.

Cluster Type Minimal Blueprint Supported Default Blueprint To Use
AWS EKS YES default
Azure AKS YES default-aks
Google GKE YES default-gke
Upstream (MKS) YES default-upstream
VMware vSphere YES default
Red Hat OpenShift YES default-openshift

Considerations when using default blueprints (minimal or cluster optimized defaults)

Enabling Turnkey Services (ex. Cost Management)

Certain turnkey services in the platform such as cost management are only available with custom blueprints as they require more configuration settings. The following table summarizes which turnkey services can be used with default blueprints.

Service Can be used with default blueprint
Monitoring & Visibility YES
Network Policy Manager NO
Service Mesh Manager NO
Policy Management (OPA) NO
Cost Management NO
Secrets Store CSI Driver NO

Managed System Add-ons Behavior

For Amazon EKS clusters, the Default Blueprint includes certain managed system add-ons that are enabled by default.

The Node Termination Handler add-on is enabled by default when the Default Blueprint is selected. This add-on can be disabled during blueprint configuration if it is not required.

This behavior is specific to the Default Blueprint and applies only to EKS clusters.

Using Your Own Software Add-Ons

Many times you want all your clusters by default to be running certain software add-ons. For example, if you are using a specific platform for observability, maybe you want that software to be always running in your clusters.

In order to enable this, you should use a custom blueprint where you can define a blueprint that has that observability software-add on. Refer to custom blueprints to learn more.


Versions for default blueprints

Default blueprints are version controlled. These are remotely updated when patches or upgrades are necessary. The configuration for each version can be checked by clicking the eye icon next to each version.

In the example below, the managed cluster is based on a default blueprint. Note the following details

Disabling Default Blueprints In the System

Sometimes as an admin, you may want to disable the default blueprint that is included with the controller. For example, you may want to prevent publishing the default blueprint to their production clusters because you want to make sure to use custom blueprints which contains specific software add-ons that you have validated for your organization.

In order to achieve this, default blueprints can be disabled in the system.

Important

In order to this operation, you must be an organization administrator. After disabling the default blueprint, organization administrators can still deploy the default blueprint to their clusters but other users will not be able to use the default blueprints when creating or updating clusters.