Skip to content

Service Profile

During the infrastructure setup step, the Org Administrator would have navigated to the "Template Catalog" and cloned the compute and KubeRay templates into this project. In this step, you will use the PaaS Studio to create and publish a Service Profile (i.e. SKU) that will be made available to end users for self-service consumption via the Developer Hub.

Overall Steps

Progressive Templating

The PaaS Studio is where admins perform the second layer of progressive templating. In the first step as the Infra/Org Admin, when we cloned/created the template, we locked down some of the configuration. In this step, as a PaaS admin, you will progressively lock down a few more configurations to ensure that the end user has a simple, intuitive experience.

Progressive Templating

Ray as Service Profile

In this step, let us start with the creation of a service profile for a Ray as Service SKU.

Navigate to the PaaS Studio with a PaaS Project Admin role (If you are logged in as an Org Admin with access to all projects, ensure you selec the right project).

  • Select Service Profiles and click on New Service Profile

General Section

In this section, you can provide general information about your SKU.

  • Provide a unique name (e.g. ray-service)
  • Select the environment template and version for the service instance that was shared to your project by the Org Admin
  • In the description field, enter something like "KubeRay as a Service on a Virtual Cluster". This will be displayed to the end user when they select the SKU
  • In the service type dropdown, select "custom service". This will make the SKU card available under Custom Services for the end user in the Developer Hub
  • Ensure that the "Will compute be auto-created?" option is selected to "No" (This is the default option)
  • Click on Save

Create New Service Profile

Once the service profile has been created, we are ready to configure it with details to optimize the end user experience.

Design Profile Card

In this section, you can specify "icons" and a "readme" that will be displayed to the end user as additional information about your Ray SKU.

Inputs & Constraints

The template from the catalog comes with a default set of commonly used input variables. The "PaaS Studio" administrator now has to make a decision on which of these should be made available as inputs for the end user.

  • Navigate to the Input Settings configuration section.
  • Disable the checkboxes for the "Allow Override"

For example, a common approach is to abstract away everything for the end user and provide them with a 1-click experience.

  • Leave the "cluster_name" as is. The name of the virtual cluster will be injected dynamically when the service instance is provisioned.
  • For "Enable Volcano", you might wish to select "true" if your host cluster has fixed capacity.

Input Selectors

Output Settings

This section allows the administrator to configure and specify what outputs should be presented to the user once the SKU is successfully fulfilled. For our Ray service profile, we want to only show the end user three variables that they need to access their Ray Dashboard.

Info

The template generates authentication credentials based on Basic Authentication

Ray Dashboard URL

  • Click on "Add Output"
  • For name, type "ray_cluster_url"
  • For label, type something like "Ray Dashboard URL"

Username

  • Click on "Add Output"
  • For name, type "user"
  • For label, type something like "Username"

Password

  • Click on "Add Output"
  • For name, type "password"

  • For label, type something like "Password"

  • Click on Save Changes to save your profile

Output Selectors

Verify Service Profile

Info

This is a completely optional step.

Admins may wish to validate what the service profile will look like for the end user. They can do this by following the steps below:

  • click on Service Instances
  • Click on New Service Instance
  • You should now see the newly created "Ray" SKU as an option.

Note that this is similar to what the end users will be shown when they access the Self-Service Developer Hub Portal.