Application Catalog Authentication and SSO Branding Compute and Service Types General Settings Legal and Contact Configuration Portal Customization White Labeling

Customization

The Partner Portal now includes advanced customization options to support partner branding across various areas, including login/signup screens, Developer Hub, and PaaS Studio.

Info

Please review the related white labeling section

Overview of Customization Features¶

The following customization options are available in the Partner Portal:

Basic Information: Partner Name, Description, and Console Host configuration.
Portal Settings: GSLB, Self Signup, Default Portal Redirection, and API/Support Links.
Authentication/Branding:
- Theme Customization (Primary, Secondary, Sidebar Colors).
- Login/SSO Button Labels and SSO Email Pre-Population.
- Login Layout, Logo Branding (Light/Dark), and Background Image.
- Custom Signup URL and Label.
Contact & Legal:
- Contact and Support Email configuration.
- Terms of Service, Documentation URL, and Privacy Policy configuration.
Portal Content Customization:
- Application Catalog Display, Grouping, and Configuration.
- Customizing Available Compute and Service Types.
- Renaming the Developer Hub Portal.

Accessing Theme Customization Settings¶

To access and modify theme customization settings:

Log in to the Partner Console and select a partner from the list
Click the Edit icon for the selected partner
Navigate to the Theme Customizations tab

Theme Customization¶

ℹ️ Minimum Controller Version: v3.1-31

By default, users see the system-defined theme colors until custom colors are configured.

Customize the Primary, Secondary, and Sidebar colors used across the SAAS portal. Customizing these colors will be reflected on the following pages:

Login/Signup page
Developer Hub
PaaS Studio
When colors are selected, a preview is displayed on the right pane, showing how the customized theme will appear
Click Save Changes to apply the updated color settings
A Reset to Default option is available to remove the custom settings and restore the default configuration.

These changes apply at the partner level and affect all organizations under the partner.

Additional Customization Options¶

In addition to theme colors, the following options are available for partners who want deeper customization of their console experience. These settings help tailor the branding and user interaction on the login, signup, and related pages.

On the Partner page, click on Edit Partner Details

Basic Info¶

The Basic Info tab in the Edit Partner Details screen allows you to configure essential identification, domain, and host information for the partner.

Basic Information¶

Field	Description	Example (from image)
Name	The official, primary name of the partner.	`Rafay Airgap`
Description	A brief description of the partner's role or offering.	`Rafay Cloud Partner`

Domain & Host Configuration¶

This section defines the networking and access configuration for the partner environment.

Field	Description	Example (from image)
Domain	The root domain name associated with the partner's console and services.	`Team Rafay`
Admin Console Host	The specific hostname used to access the administrative interface or partner console.	`console.qc-gpupaas.dev.rafay-edge.net`
Ops Console Host	The specific hostname used to access the Operations Console, if applicable.	`ops-console.qc-gpupaas.dev.rafay-edge.net`

Settings¶

The Settings tab in the Edit Partner Details screen allows you to configure general system behavior, portal redirection, and support access for the partner's environment.

General Settings¶

This section contains various checkboxes to control visibility and core system features.

Setting	Description
GSLB	Enables or disables Global Server Load Balancing functionality for the partner.
Self Signup	Allows end-users to self-register for access to the portal without manual administrative approval.
API Docs Link	Controls the visibility of a link to the API documentation within the portal interface.
Disable System Domain	When enabled, prevents the use of the default system domain, often used in white-labeling scenarios to enforce partner-specific domain usage.
Hide Portal Title (Default: PaaS Studio/Developer Hub)	Hides the default portal name (e.g., PaaS Studio or Developer Hub) from the interface.

Portal Configuration¶

This setting determines where a user is directed immediately after they log in.

Setting	Description
Default Portal	Specifies the portal to which the user will be automatically redirected upon login. Use this with caution as it can lead to security issues if configured incorrectly.
Options	The available options for the default destination are: Infrastructure, PaaS Studio, or Developer Hub.

Support Portal Settings¶

This section is for configuring access to an external support system.

Setting	Description
Enable Support Portal	Check this box to enable and display a link to a separate support portal for end-users to get help and support. Once enabled, a field will appear to input the Support Portal URL.

Login/Signup Configuration¶

The Login/Auth tab allows partners to customize the authentication experience for their users, including button labels, Single Sign-On (SSO) settings, signup links, and the visual layout of the login page.

Field / Setting	Description	Example
Login Label (Default: `Login`)	Customizes the text on the standard login button.	`Login with Email ID`
Login SSO Label (Default: `Login With SSO`)	Customizes the text on the dedicated SSO login button.	`Login with SSO Email ID`
Query Param for Login Hint (Optional)	The query parameter name expected by the Identity Provider (IDP) to pre-fill the user's email address during SSO login. (See detailed explanation below).	`saml_login_hint`
Signup Label	Customizes the prompt shown above the signup link (e.g., Don't have an account? Register Now).	`Register Now`
Signup URL	Redirects users to a custom signup page managed by the partner instead of the default sign-up page.	`https://www.console.com`
Page Layout Style	Determines the visual presentation of the login page: Default (Standard full-screen login box) or Split (Split screen with a background image on the left).	`Default`
Common IDP for all organisation	When checked (Enabled), this enforces a single, shared Identity Provider (IDP) configuration across all organizations under this partner. Refer Global IDP Page for more details.	`Enabled`

Pre-Fill Email ID for SSO Logins¶

ℹ️ Minimum Controller Version: v3.1-31

This feature is configured using the Query Param for Login Hint field. It is designed to improve user experience by pre-filling the user's email address on the SSO Identity Provider (IDP) login page, eliminating the need for manual entry.

Admins configure a query parameter name (e.g., saml_login_hint) that the portal appends to the SSO redirect URL. This parameter passes the user’s email ID to the IDP so it can be auto-filled on the login screen.

Example: https://idp.partner.com/sso?saml_login_hint=user@example.com

Important:

The IDP must support email auto-fill using query parameters.

This is a customer-specific functionality. Contact Rafay Customer Support for assistance.

Logo Branding¶

ℹ️ Minimum Controller Version: v3.1-31

Partners can configure branding by specifying URLs for different logo and background image types.

Light Background Logo: Used on login pages or areas with light-colored backgrounds.
- Enter the image URL in the Light Background field.
  Example: https://rafay.co/wp-content/uploads/2021/10/Rafay_Positive_Ver2x-1.png
Dark Background Logo: Displayed in the Developer Hub and PaaS Studio (dark theme areas).
- Enter the image URL in the Dark Background field.
  Example: https://rafay.co/wp-content/uploads/2021/08/rafay-logo@2x.png
If no dark background logo is configured, the system defaults to the light background logo.
Favicon: Enter the URL for a favicon to customize the browser tab icon.
Background Image: Specify a background image URL for use with the Split layout or Default layout on the login page.

Recommended Sizes for background image: - Default Layout: 1920x1080px - Split Layout: 700x560px

Image previews are displayed alongside the input fields to help validate how the branding will appear.

Contact¶

The Contact tab in the Edit Partner Details screen allows partners to configure contact, support, branding, and legal URLs, as well as the login page's privacy policy settings.

Contact Information¶

Field	Description
Notification Email	The email address designated to receive general system notifications.
Sender Email	The email address used as the "from" address for system-generated emails.
Helpdesk Email	The customer-facing email address for users seeking help or support.

Additional Information¶

Field	Description
Product Name	The customized name of the product or service being offered (e.g., `rauto-ncp-partner-qc-gpupaas.partner.dev.rafay-edge.net`).
Support Team Name	The name of the partner's support team (e.g., `rauto-support`).
Copyright Text	The custom copyright notice to be displayed, often in the footer (e.g., `@rauto-Copyright`).

URLs (Optional)¶

Field	Description
Terms of Service URL	A link to the partner's custom Terms of Service page.
Documentation URL	A link to the partner's product or service documentation.

Configurable Privacy Policy and Inline CTA¶

ℹ️ Minimum Controller Version: v3.1-31

Partners can configure how privacy policy information is presented on the login screen using the following options:

Privacy Policy URL Enter a custom URL pointing to the partner's own privacy policy (e.g., https://example.com/privacy-policy). This replaces the default privacy policy link in the login footer.
Display Privacy Policy CTA Inline Enable this checkbox to show an inline call-to-action (CTA) message directly on the login screen.
Privacy Policy Label Text Customize the message displayed with the inline CTA. For example: By logging in, you agree to accept Privacy Policy, where "Privacy Policy" will be hyperlinked to the configured Privacy Policy URL. The preview shows the default text is "By logging in, you agree to accept Privacy Policy".

A real-time preview of the final message is displayed on the right side of the screen under Login Page Preview.

Important Notes

Enabling the inline CTA will require the Privacy Policy URL to be configured.

The CTA message text is fully customizable to align with the partner’s tone or policy requirements.

Applications Configuration¶

The Applications tab in the Edit Partner Details screen allows you to configure how the list of available applications is displayed to end-users in the Partner Console, including the view type, grouping, labeling, and defining the applications themselves.

General Display Settings¶

These settings control the overall presentation of the application catalog.

Setting	Description
Preferred Applications View	Sets the default display format for the application list: Grid View (as shown in the Live Preview) or List View.
Separator Label	Defines a custom label that displays above the main application list (e.g., Other Applications).
Enable Application Grouping	When checked, applications can be organized into definable groups (Group/Category field below) for better categorization and display. The Live Preview changes to show Applications Preview (Grouped by Category).

Configuring an Application¶

To add an application to the catalog, click the + Add Application button. This reveals a form where you define the application's details. You can configure multiple applications by clicking + Add Application again.

Field	Description
Application Name	The public-facing name of the application displayed in the catalog (e.g., App Name in the preview).
Image URL	The URL to the application's icon or image (e.g., `https://example.com/app-icon.png`). This image will be displayed on the application card/row.
Application URL	The full URL that users will be directed to when they click the application (e.g., `https://example.com/app`).
Description	A brief description of the application.
Group/Category	(Optional) If Enable Application Grouping is checked, enter the category name here (e.g., Development, Production, Tools). Applications are grouped by this value in the end-user view.

To remove a configured application, click the Remove button associated with that application's configuration block.

After completing all application configurations and display settings, click Save Changes at the bottom of the screen to apply the updates.

After completing all customizations, click Save Changes to apply the updates.

Customizing Compute Types¶

ℹ️ Minimum Controller Version: v3.1-30

GPU Providers can define which compute types are visible in the end user portal. For example, custom entries such as "Namespace" can be used to reflect internal conventions.

Procedure¶

Log in to the Operations Console.
Navigate to Partners → click Edit.
Select the PaaS Customizations tab.

Edit or add to the YAML/JSON configuration using the following structure:

{
  "compute": {
    "nav_label": "Compute",
    "types": [
      {
        "value": "baremetal",
        "label": "Baremetal",
        "icon": "zmdi zmdi-laptop",
        "description": "Physical dedicated servers with direct hardware access, providing maximum performance and control for resource-intensive workloads.",
        "objectLabel": "Bare Metal",
        "templateCard": {
          "labelClass": "text-red-700/70",
          "iconClass": "border-yellow-500/10 bg-yellow-100"
        },
        "homeComputeCard": {
          "description": "Bare Metal instances provide dedicated physical servers with direct hardware access, offering maximum performance, security isolation, and control for demanding workloads that require consistent performance or specific hardware configurations.",
          "iconClass": "border-red-500/10 bg-red-100 text-red-700/70"
        }
      },
      {
        "value": "vm",
        "label": "Virtual Machines",
        "icon": "zmdi zmdi-cloud",
        "description": "Virtualized computing environments that provide flexible, isolated instances with dedicated resources for various workload requirements.",
        "objectLabel": "Virtual Machine",
        "templateCard": {
          "labelClass": "text-red-700/70",
          "iconClass": "border-yellow-500/10 bg-yellow-100"
        },
        "homeComputeCard": {
          "description": "Virtual Machines offer flexible, isolated computing environments with dedicated CPU, memory, and storage resources. Ideal for a wide range of applications, VMs provide OS-level isolation with the ability to scale resources based on workload demands.",
          "iconClass": "border-yellow-500/10 bg-yellow-100 text-yellow-700/70"
        }
      },
      {
        "value": "k8s",
        "label": "Kubernetes",
        "icon": "zmdi zmdi-brain",
        "description": "Container orchestration platform for deploying, scaling, and managing containerized applications with automated workload distribution.",
        "objectLabel": "Kubernetes",
        "templateCard": {
          "labelClass": "text-red-700/70",
          "iconClass": "border-blue-500/10 bg-blue-100"
        },
        "homeComputeCard": {
          "description": "Kubernetes provides a powerful container orchestration platform for deploying, scaling, and managing containerized applications. With features like automated deployment, scaling, load balancing, and self-healing capabilities, it offers an efficient environment for modern microservices architectures.",
          "iconClass": "border-purple-500/10 bg-purple-100 text-purple-700/70"
        }
      },
      {
        "value": "vcluster",
        "label": "vCluster",
        "icon": "zmdi zmdi-robot",
        "description": "Virtual Kubernetes clusters that provide isolated environments within a shared infrastructure, enabling multi-tenant resource optimization.",
        "objectLabel": "vCluster",
        "templateCard": {
          "labelClass": "text-red-700/70",
          "iconClass": "border-pink-500/10 bg-pink-100"
        },
        "homeComputeCard": {
          "description": "vClusters are virtual Kubernetes clusters that run inside a namespace of an underlying Kubernetes cluster, providing fully isolated environments with their own control plane. Ideal for multi-tenant scenarios, they enable efficient resource utilization while maintaining strict workload separation.",
          "iconClass": "border-pink-500/10 bg-pink-100 text-pink-700/70"
        }
      },
      {
        "value": "Namespace",
        "label": "Namespace",
        "icon": "zmdi zmdi-robot",
        "description": "Isolated namespaces in a Kubernetes cluster.",
        "objectLabel": "Namespace",
        "templateCard": {
          "labelClass": "text-red-700/70",
          "iconClass": "border-pink-500/10 bg-pink-100"
        },
        "homeComputeCard": {
          "description": "Isolated namespaces in a Kubernetes cluster for efficient resource utilization.",
          "iconClass": "border-pink-500/10 bg-pink-100 text-pink-700/70"
        }
      }
    ]
  }

Note: Default compute types include: Baremetal, Virtual Machines, Kubernetes, and vCluster.

When a new compute profile is created, the corresponding compute type options become available for selection.

Migration¶

If upgrading from a controller version older than v3.1-30:

Annotate existing compute profiles to associate the appropriate compute type, e.g.:

"paas.envmgmt.io/compute_type": "vm"

Run the migration script to associate existing compute instances with the correct type

Important: Contact Rafay support for assistance with the migration process.

Customizing Service Types¶

Just like compute types, service types can also be customized.

Procedure¶

Log in to the Operations Console.
Navigate to Partners → click Edit.
Select the PaaS Customizations tab.
Edit or add to the YAML/JSON configuration using the following structure:

{
  "service": {
    "navLabel": "Services",
    "types": [
      {
        "value": "notebook",
        "label": "Notebooks",
        "icon": "zmdi zmdi-laptop",
        "description": "Notebooks are applications that run on compute instances.",
        "objectLabel": "Notebook"
      },
      {
        "value": "Applications",
        "label": "Applications",
        "icon": "zmdi zmdi-robot",
        "description": "Pre-defined application configurations.",
        "objectLabel": "Applications"
      }
    ]
  }
}

When a new service profile is created, the corresponding service type options become available for selection.

Renaming the Developer Hub Portal¶

ℹ️ Minimum Controller Version: v3.1-31

To change the label of the end user portal (default is Developer Hub):

Go to Partners → click Edit.
In the PaaS Customizations tab, add:

"developer_hub_label": "Customer Hub"