Modify Cloud Provider Configuration

When using public cloud providers, VerteX automatically downloads the required infrastructure provider images from our public registries to set up a workload cluster. For example, if you want to deploy an AWS cluster, VerteX downloads the required Amazon Machine Image (AMI) that contains the desired Operation System (OS) and Kubernetes binaries specified in the cluster profile. The exception to this is when you are using a custom image, in which case you must provide the image yourself through the Bring Your Own OS (BYOOS) workflow.

In the event you need to enable new cloud providers, or rotate the credentials used to access our infrastructure provider images, you can do so through the System API. Use the following steps to modify the cloud provider configuration for your self-hosted VerteX instance.

Prerequisites

• System administrator permissions, either a Root Administrator or Operations Administrator. Refer to the System Administrators page to learn more about system administrator roles.

• You need cloud credentials from us to download the required infrastructure provider images. Reach out to our support team at support@spectrocloud.com to obtain these credentials.

• curl or similar tool to make API requests.

Update Cloud Provider Configuration

1. Open a terminal session.

2. Log in to the VerteX System API by using the /v1/auth/syslogin endpoint. Use the curl command below and replace the example.com placeholder URL with the URL of your VerteX instance. Ensure you replace the credentials below with your system console credentials.

   TOKEN=$(curl --insecure --location 'https://example.com/v1/auth/syslogin' \
   --header 'Content-Type: application/json' \
   --data '{
     "password": "**********",
     "username": "**********"
   }')

   The response will contain the authentication token that you will use in the next request.

3. Next, prepare a payload for the cloud provider you want to enable or update. Select the tab for details on the expected payload for each cloud provider.

   Replace the placeholders in the payload below with the configuration values provided by our support team.

   Azure

   CONFIG_JSON=$(cat <<EOF
   {
     "clientId": "**************",
     "clientSecret": "**************",
     "tenantId": "**************",
     "subscriptionId": "**************",
     "storage": {
       "accessKey": "**************",
       "storageName": "**************",
       "container": "**************"
     }
   }
   EOF
   )

   AWS

   CONFIG_JSON=$(cat <<EOF
   {
     "accessKey": "**************",
     "secretKey": "**************"
   }
   EOF
   )

   GCP

   CONFIG_JSON=$(cat <<EOF
   {
     "jsonCredentials": "**************"
   }
   EOF
   )

4. Use the /v1/system/config/:provider/account endpoint to update the cloud provider configuration. Select the tab for the cloud provider you want to update and issue the corresponding curl command. Replace the example.com placeholder URL with the URL of your VerteX instance.

   Azure

   curl --insecure --request PUT --location 'https://example.com/v1/system/config/azure/account' \
   --header "Authorization: $TOKEN" \
   --header 'Content-Type: application/json' \
   --data "$CONFIG_JSON"

   AWS

   curl --insecure --request PUT --location 'https://vertex.example.com/v1/system/config/aws/account' \
   --header "Authorization: $TOKEN" \
   --header 'Content-Type: application/json' \
   --data "$CONFIG_JSON"

   GCP

   curl --insecure --request PUT --location 'https://vertex.example.com/v1/system/config/gcp/account' \
   --header "Authorization: $TOKEN" \
   --header 'Content-Type: application/json' \
   --data "$CONFIG_JSON"

You have successfully updated the cloud provider configuration for your self-hosted VerteX instance.

Validate

Use the following steps to validate the cloud provider configuration update.

1. Open a terminal session.

2. Log in to the VerteX System API by using the /v1/auth/syslogin endpoint. Use the curl command below and replace the example.com placeholder URL with the URL of your VerteX instance. Ensure you replace the credentials below with your system console credentials.

   TOKEN=$(curl --insecure --location 'https://example.com/v1/auth/syslogin' \
   --header 'Content-Type: application/json' \
   --data '{
     "password": "**********",
     "username": "**********"
   }')

   The response will contain the authentication token that you will use in the next request.

3. Use the /v1/system/config/:provider/account endpoint to get the cloud provider configuration. Select the tab for the cloud provider you want to update and issue the corresponding curl command. Replace the example.com placeholder URL with the URL of your VerteX instance.

   Azure

   curl --insecure --request GET --location 'https://example.com/v1/system/config/azure/account' \
   --header "Authorization: $TOKEN" \
   --header 'Content-Type: application/json'

   AWS

   curl --insecure --request GET --location 'https://vertex.example.com/v1/system/config/aws/account' \
   --header "Authorization: $TOKEN" \
   --header 'Content-Type: application/json'

   GCP

   curl --insecure --request GET --location 'https://vertex.example.com/v1/system/config/gcp/account' \
   --header "Authorization: $TOKEN" \
   --header 'Content-Type: application/json'

4. The response will contain the cloud provider configuration details. Verify that the configuration values match the values you provided in the payload.