White Labeling
The Partner Portal now includes advanced customization options to support partner branding across various areas, including login/signup screens, Developer Hub, and PaaS Studio.
Overview of Customization Features¶
The following customization options are available in the Partner Portal:
- Theme Customization
- Login and SSO Button Text Customization
- Pre-Population of Email ID for SSO
- Signup Label and Link Customization
- Login Layout and Background Image Options
- Logo Branding for Light and Dark Backgrounds
- Configurable Privacy Policy and Inline CTA
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
Login and Signup Configuration¶
ℹ️ Minimum Controller Version: v3.1-31
The Login/Signup Configuration section allows partners to customize multiple elements of the login interface to provide a branded experience for their users.
Login and SSO Button Text Customization¶
Partners can update the button labels for:
- Login Button
- SSO Login Button
Custom labels help personalize the interface (e.g., Login with Email ID)
Pre-Fill Email ID for SSO Logins¶
ℹ️ Minimum Controller Version: v3.1-31
To improve user experience, pre-filling of the user's email address on the SSO Identity Provider (IDP) login page is supported. This eliminates the need for users to manually enter their email ID during login.
Admins can configure a query parameter 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
Here, saml_login_hint
is the query parameter name expected by the IDP, and user@example.com
is the email value passed by the portal.
To set this up, enter the parameter name supported by the IDP (e.g., saml_login_hint
).
This setting only defines the query parameter name. The actual email address is dynamically passed by the system during redirect.
Important: - The IDP must support email auto-fill using query parameters. - This is a customer-specific functionality. Contact Rafay Customer Support for assistance.
Sign up Label and URL Customization¶
ℹ️ Minimum Controller Version: v3.1-31
Partners can modify the signup section:
- Sign up Label: Customize the prompt shown (e.g., Register now)
- Sign up URL: Redirect to a custom signup page managed by the partner instead of the default Rafay signup page (e.g.,
https://www.clientconsole.com
)
Page Layout Options¶
Two layout styles are available under Page Layout Style:
- Default – Standard full-screen login box
- Split – Split screen with a background image on the left and login form on the right
Partners can preview the configuration and layout in real time on the right-side panel before saving.
✅ All these configurations are made from the Edit Partner screen in the Partner Console under Login/Signup Configuration.
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
- Enter the image URL in the Light Background field.
-
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.
- Enter the image URL in the Dark Background field.
-
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.
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 (Mandatory) Enter a custom URL pointing to the partner's own privacy policy (e.g.,
https://example.com/privacy-policy
). This replaces the default Rafay privacy policy in the login footer and allows for compliance with partner-specific legal or branding requirements. -
Display Privacy Policy CTA Inline
Enable this checkbox to show an inline call-to-action (CTA) message directly on the login screen. When enabled, the configured Privacy Policy Label Text will appear as a hyperlink pointing to the provided privacy policy URL. -
Privacy Policy Label Text
Customize the message displayed with the inline CTA. For example: By logging in, you agree to our privacy policy, where “privacy policy” will be hyperlinked to the configured URL.
A real-time preview of the final message is displayed on the right side of the screen under Login Page Preview.
Important Notes
- The Privacy Policy URL field becomes mandatory when inline CTA is enabled.
- The CTA message text is fully customizable to align with the partner’s tone or policy requirements.
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.
Steps:¶
- 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.
Steps:¶
- 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"