Skip to main content

Integrate with Palette

Integrations are external service connections configured in a Settings resource that provide credentials and endpoints for PaletteAI to interact with external platforms. Integrations can be added while creating a Tenant, Project, or at any time within the Project scope. A Palette integration is required to deploy applications and models.

When Palette is integrated with PaletteAI, Palette is used as your infrastructure provider to deploy dedicated or shared Compute Pools to host your AI/ML applications.

Integration Prerequisites

Before you can add a Palette integration to your tenant or project, you must complete the following tasks in Palette.

info

When Palette AI is installed with systemDefaultResources: true (the default), a default Tenant and Project are automatically created. You can use these defaults or create custom Tenants and Projects, as described below.

  1. Create Palette Tenant - Similar to tenants in PaletteAI, Palette tenants are top-level organizational units that represent a department or business, under which you create individual projects for deploying and managing clusters. If using Palette in a dedicated- or multi-tenant SaaS environment, tenants are created for you by the Spectro Cloud Customer Support team. In self-hosted Palette environments, you must manually create tenants.

  2. Create Palette Project - Within your Palette tenant, create one or multiple projects where you will deploy your AI/ML applications. Palette projects are similar to PaletteAI projects, allowing you to group clusters and related resources and set role-based access controls. You can use an out-of-box project or create your own. Refer to the Palette Create and Manage Projects guide for instructions on creating projects in Palette. If you have multiple tenants, refer to the Switch Tenant guide to ensure you are in the correct tenant prior to creating your project.

  3. Create Palette API Key - Your Palette API key is used in the Settings resource to authenticate PaletteAI with Palette, allowing PaletteAI to discover edge nodes and use those nodes to create clusters for deploying your AI/ML applications.

Deployment Prerequisites

PaletteAI is able to communicate with Palette once you add your integration. However, you will not be able to deploy AI/ML applications until a sufficient number of edge nodes with the required specifications are discovered through PaletteAI's Compute resource. Before you can deploy clusters, you must complete the following tasks in Palette:

  1. Deploy Edge Nodes - Deploy and use edge nodes to form the clusters that host your AI/ML applications. Turn existing machines into Palette-compatible edge nodes using either the EdgeForge Workflow (Appliance Mode) or Agent Mode, and register the nodes with Palette.

  2. Label Edge Nodes - Edge nodes must be properly labeled with the appropriate PaletteAI tags to be discovered by the Compute resource. To tag your edge nodes, add labels below the stylus.site.tags parameter in your edge node's user-data file or tag edge nodes once they are registered with Palette using Edge Host Grid View.

  3. Create Cluster Profiles - Cluster Profiles are created and managed in Palette. They are a required component of Infrastructure and Fullstack Profile Bundles that define the base infrastructure used in your Kubernetes clusters.

    When PaletteAI provisions a Compute Pool, it references the applicable Cluster Profile to configure the underlying Kubernetes cluster through Palette.

  4. Provide Palette a Trusted SSL Certificate - By default, self-hosted Palette uses a self-signed SSL certificate. If you are using a custom SSL certificate, you can provide it to Palette by updating the system certificate in the System console settings. Refer to the System Address Management guide for instructions on how to update the system certificate.

    If you are using a self-signed certificate for Palette, you can enable the skipSSLCertificateVerification flag in the PaletteAI Settings resource to skip SSL certificate verification and allow API calls to Palette to succeed.

    warning

    We recommend leaving the skipSSLCertificateVerification flag disabled. All API calls to Palette will skip SSL certificate verification if this flag is enabled. The flag is useful for demo environments or when experimenting with PaletteAI, but for a production environment, we recommend using a valid SSL certificate signed by a trusted certificate authority.

    apiVersion: v1
    kind: Secret
    metadata:
    name: palette-api-secret
    namespace: primary-dev
    type: Opaque
    stringData:
    palette: |
    {
    "apiKey": "***************************",
    "defaultProjectID": "**************************",
    "hostUrl": "https://console.spectrocloud.com",
    "tenant": "docs",
    "skipSSLCertificateVerification": false
    }

Refer to Settings for more information on the Settings resource.

Additional Self-Hosted Palette Setup

info

This section applies to self-hosted Palette environments only. It does not apply to dedicated or multi-tenant SaaS environments.

While not required to deploy Compute Pools and applications with PaletteAI, we recommend configuring your self-hosted Palette environment to meet your organization's needs prior to deploying clusters. Refer to the following Palette guides for additional information:

  • Activate Palette License - After installing self-hosted Palette, you have 30 days to activate it. During the 30-day trial period, you can use Palette without any restrictions. After 30 days, you can continue to use Palette, but you cannot deploy additional clusters or perform any Day-2 operations on existing clusters until Palette is activated. We recommend activating Palette as soon as possible to avoid any disruptions.

  • Add Pack Registries - Add pack registries to your Palette tenants so that you can use them to create Cluster Profiles. Review the list of Pack registries, select the ones you want to use, and follow the Add System-Level Registry guide to add them to your Palette tenants.

Refer to Palette's System Management guide to discover additional system configuration options, including as feature flags, login banners, and more.