Skip to content

System Catelog

System Catalog

A catalog of pre-built system templates designed to streamline and enhance the user experience. These templates are fully supported by Rafay and are regularly updated with new features. The System Catalog simplifies the process of leveraging the platform’s capabilities, ensuring efficiency and ease of use.

Using System-Catalog Templates

The System-Catalog Project is a read-only project available in the organization, containing pre-built templates to help users quickly set up and deploy resources. Below are the steps on how to use these templates effectively, tailored to the responsibilities of different personas.

Personas

1. Platform Admin

  • Responsibilities:
  • Managing templates within the organization, including:
    • Sharing templates with other projects.
    • Cloning and customizing templates to meet specific requirements.
    • Restricting input variables to ensure standardization while allowing flexibility where needed.
  • Roles Required:
    • ENVIRONMENT_ADMIN
    • ORG_ADMIN

2. End User

  • Responsibilities:
  • Consuming templates shared by the Platform Admin.
  • Depending on permissions, they can:
    • Directly use the template by providing the required inputs (e.g., API Key, secret, credentials).
    • Override certain input variables if customization is permitted by the Platform Admin.
  • Role Required:
  • ENVIRONMENT_TEMPLATE_USER

How to Use System-Catalog Templates

There are two ways to use templates from the System-Catalog Project:

1. Platform Admin: Share and Customize Templates

The Platform Admin handles sharing and customizing templates:

Share Templates:

  • Templates in the System-Catalog Project can be shared with other projects.
  • Ensure the target project has an agent configured, which is mandatory for template usage. A single agent can be shared across multiple projects if necessary, simplifying setup and reducing overhead.
  • The agent from the source project can also be shared with the target project if necessary.

Customize Templates:

  • If customization is required, the Platform Admin can:
  • Clone the Template: Create a new version from the shared template.
  • Restrict Inputs: Define which input variables can or cannot be overridden by end users.
  • Add Customizations: Modify the template to suit specific use cases.

Share the Customized Template:

  • Once the new template is ready, share it in the target project for End Users to consume.

2. End User: Consume Templates

The End User consumes templates that have been shared and configured by the Platform Admin:

Use Templates:

  • Launch the template by providing the required inputs, such as:
  • API Key
  • Secret
  • Credentials
  • Inputs may vary depending on the template but are typically minimal.

Override Inputs:

  • If allowed by the Platform Admin, End Users can override specific input variables to align with their requirements.

Key Workflow

Platform Admin Workflow:

  1. Share a template from the System-Catalog Project to the desired project.
  2. Clone and customize the template to restrict inputs or add new configurations.
  3. Publish the customized template for End Users to consume.

End User Workflow:

  1. Access the shared template in the project.
  2. Provide the necessary inputs, which may include:
    • API Key
    • Secret
    • Credentials
    • SSH Key (e.g., for system-mks)
    • Cloud-specific configurations (e.g., cloud-credentials for cloud templates).
  3. Launch the template to deploy resources.

Agent Configuration

An agent must be configured in the target project where the template is used. Without this, templates cannot be launched.

Role Requirements Summary

  • Platform Admin:
    • ENVIRONMENT_ADMIN
    • ORG_ADMIN
  • End User:
    • ENVIRONMENT_TEMPLATE_USER