Skip to main content

Register and Manage Cox Edge Accounts

Palette supports integration with Cox Edge accounts and account environments. This section explains how to create a Cox Edge account in Palette.

Add Cox Edge Account​

To add a Cox Edge account to Palette, use the following instructions.

Prerequisites​

  • A Spectro Cloud account.

  • A Cox Edge account.

  • Tenant admin access in Palette.

  • Your Cox Edge organization id. Ask your system administrator for this value or use the API endpoint api/v2/organizations to retrieve the organization id.

    curl --silent  "https://portal.coxedge.com/api/v2/organizations" \
    --header "MC-Api-Key: YourAPIkeyHere" | jq '.data[] | {id}'
    {
      "id": "268ce256-15ef-465f-bc0f-952fac3e7c1e"
    }

Enablement​

You can use the steps below or the interactive guide to help you add a Cox Edge account to Palette. Click on the first image link to navigate the destination site with the tutorial at right.

  1. Log in to the Cox Edge portal.
  1. Navigate to the drop-down User Menu and click on API Credentials.
  1. Select Generate API key.
  1. Give the key a name and select Generate.
  1. Copy the API key value to a secure location. You will use this value in the future.
  1. Copy the API endpoint URL. The API endpoint is located above the table that lists all your API keys.
  1. Click the four-tile Home button at the top and select Edge Compute.
  1. Next, click on the environment drop-down menu and select Add Environment to create a compute environment. A compute environment is required when adding a Cox Edge account to Palette. If you already have a compute environment available, skip to step 11.
  1. Provide a name and description and click Next.
  1. Add members to the compute environment. You can also add members at a later point. Apply the changes.
  1. Open another browser tab and log in to Palette as a Tenant admin.
  1. Go to Tenant Settings > Cloud Accounts and click +Add Cox Edge Account.

  1. Fill out the following input fields.

    • Account Name: Assign a name to the Cox Edge account.

    • API Base URL: Add the API endpoint URL you copied down earlier. You can locate this value in the API Key overview page in the Cox Edge portal.

    • API Key: Provide the API key you generated earlier.

    • Organization Id: Ask your system administrator for this value or use the Cox Edge API to retrieve the organization id.

    • Environment: This optional field allows you to enter name of the environment you wish to target if you have one.

    • Service: Use the value edge-services.

  2. Click Validate to confirm you have access to the Cox Edge account.

  1. Select Confirm to add the Cox Edge account to Palette.

Validate​

  1. Log in to Palette as a Tenant admin.
  1. Navigate to the left Main Menu and select Tenant Settings to ensure you are in the Cloud Accounts page.
  1. Your Cox Edge account is now listed with all the other infrastructure provider accounts.
  1. You can also deploy a cluster to Cox Edge to validate everything is working. Use the Create and Manage Cox IaaS Cluster guide to create and deploy a cluster to Cox Edge.