Skip to main content
Version: latest

Configure Palette Agent Version

In connected clusters, the Palette agent gets upgraded automatically with Palette upgrades, unless you explicitly pause upgrades. In airgap clusters, this does not happen automatically. When you want to upgrade the agent version, you can include the new agent version in a new cluster profile, and upgrade the cluster using the new profile.

This page teaches you how to identify the matching agent version of a Palette instance, as well as how to specify a Palette agent package in the Operating System (OS) pack of a cluster profile. This is useful for upgrading the Palette agent on an airgap Edge cluster and for launching new connected clusters while using an older version of the Palette agent.

Prerequisites​

  • An active Edge cluster.

  • Linux Machine (Physical or VM) with an AMD64 architecture.

  • Palette API key. Refer to the User Authentication resource to learn how to create a Palette API key.

  • An Edge type cluster profile. Refer to Create Edge Native Cluster Profile guide to learn how to create an Edge Native cluster profile. You may also have other add-on profiles that you wish to attach to your cluster.

  • The pack.content.images parameter in your profiles contains the exact location of container images to be downloaded.

Procedure​

Identify the Target Agent Version​

If you already know the agent version you want to use for your cluster, you can skip this step.

  1. The target agent version depends on the Palette instance you use to build content bundles for your Edge cluster. Use the following request to identify the target version. If you are using self-hosted Palette or VerteX, replace api.spectrocloud.com with the fully qualified domain name of your API endpoints. Replace the apiKey field with your API key.

    curl --location 'https://api.spectrocloud.com/v1/services/stylus/version' \
    --header 'apiKey: ******'

    You can expect a response similar to the following. In the following response, the target agent version is 4.5.5.

    {
      "metadata": {
        "creationTimestamp": "0001-01-01T00:00:00.000Z",
        "deletionTimestamp": "0001-01-01T00:00:00.000Z",
        "lastModifiedTimestamp": "0001-01-01T00:00:00.000Z"
      },
      "spec": {
        "latestVersion": {
          "content": "name: stylus\nversion: 4.5.5\nbuildId: \"20241025\"\nmajorVersion: \"4.5\"\napplyFilepath: /roar/stylus/4.5/4.5.5/apply/manifest.yaml\ndeleteFilepath: \"\"\n",
          "name": "manifest.yaml",
          "path": "nickfury/4.5/4.5.5/apply/services.yaml"
        },
        "name": "stylus"
      }
    }

Upgrade Palette Agent Version​

  1. Log in to Palette.

  2. From the left Main Menu, select Profiles. Select the profile you want your cluster to upgrade to.

  3. Create a new version of the profile. For more information, refer to Update a Cluster.

  4. In the OS layer of the profile, include the following lines. Replace versionNumber with your target agent version number you obtained in the first step or any other version number you want to use. Replace amd64 with arm64 if your hardware uses arm64 architecture.

    pack:
      content:
        images:
          - image: "{{.spectro.pack.edge-native-byoi.options.system.uri}}"
          - image: "container://us-docker.pkg.dev/palette-images/edge/stylus-linux-amd64:v<versionNumber>"

    options:
      system.uri: ttl.sh/ubuntu:k3s-1.29.5-v4.5.8-palette-demo

    stylusPackage: container://us-docker.pkg.dev/palette-images/edge/stylus-linux-amd64:v<versionNumber>
    info

    Following the EdgeForge process, it's likely that your provider image has a peVersion parameter. You can use a different version value in the peVersion parameter from the version you use for stylusPackage.

  5. Click Save Changes to publish the new version.

  1. Follow Build Content Bundles and Export Cluster Definition to build a content bundle using your new cluster profile and export the cluster definition.

  2. Upload the content bundle to your cluster through Local UI. For more information, refer to Upload Content Bundle.

  3. Update your cluster using the new cluster definition. For more information, refer to Update Local Cluster.

Validate​

  1. Log in to Local UI. Refer to Access Local UI Console for guidance.

  2. In the Edge Host page, confirm that the agent version has been updated in the Overview table.