Skip to content

Commit

Permalink
docs: BACKPORT CHERRYPICK TESTING (with Carolina) DON'T HATE ME
Browse files Browse the repository at this point in the history
  • Loading branch information
karl-cardenas-coding authored and achuribooks committed Dec 10, 2024
1 parent 4b55d7c commit 5a43c0d
Showing 1 changed file with 199 additions and 0 deletions.
199 changes: 199 additions & 0 deletions _partials/self-hosted/_cloud-provider-config.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
---
partial_category: self-hosted
partial_name: cloud-provider-config
---



When using public cloud providers, {props.edition} 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, {props.edition} 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) <VersionedLink text="workflow" url="/byoos/image-builder/" />.

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](https://docs.spectrocloud.com/api/v1/system/).
Use the following steps to modify the cloud provider configuration for your self-hosted {props.edition} instance.

## Prerequisites

- System administrator permissions, either a Root Administrator or Operations Administrator. Refer to the
<PaletteVertexUrlMapper
edition={props.edition}
text="System Administrators"
url="/system-management/account-management"
/> 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 [[email protected]](mailto:[email protected]) 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 {props.edition} 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 {props.edition} instance.
Ensure you replace the credentials below with your system console credentials.

```shell
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.

<!-- prettier-ignore -->

<Tabs groupId="provider">
<TabItem value="Azure" label="Azure">



```json
CONFIG_JSON=$(cat <<EOF
{
"spec": {
"clientId": "**************",
"clientSecret": "**************",
"tenantId": "**************",
"subscriptionId": "**************"
}
}
EOF
)
```
</TabItem>
<TabItem value="AWS" label="AWS">



```json
CONFIG_JSON=$(cat <<EOF
{
"spec": {
"accessKey": "**************",
"secretKey": "**************"
}
}
EOF
)
```
</TabItem>
<TabItem value="GCP" label="GCP">



```json
CONFIG_JSON=$(cat <<EOF
{
"spec": {
"json": "**************"
}
}
EOF
)
```
</TabItem>

</Tabs>

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 {props.edition} instance.

<!-- prettier-ignore -->

<Tabs groupId="provider">
<TabItem value="Azure" label="Azure">

```shell
curl --insecure --request PUT --location 'https://example.com/v1/system/config/azure/account' \
--header "Authorization: $TOKEN" \
--header 'Content-Type: application/json' \
--data "$CONFIG_JSON"
```
</TabItem>
<TabItem value="AWS" label="AWS">

```shell
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"
```
</TabItem>
<TabItem value="GCP" label="GCP">

```shell
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"
```
</TabItem>

</Tabs>


You have successfully updated the cloud provider configuration for your self-hosted {props.edition} instance.


## Validate

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

1. Open a terminal session.


2. Log in to the {props.edition} 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 {props.edition} instance.
Ensure you replace the credentials below with your system console credentials.

```shell
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 {props.edition} instance.

<!-- prettier-ignore -->

<Tabs groupId="provider">
<TabItem value="Azure" label="Azure">

```shell
curl --insecure --request GET --location 'https://example.com/v1/system/config/azure/account' \
--header "Authorization: $TOKEN" \
--header 'Content-Type: application/json'
```
</TabItem>
<TabItem value="AWS" label="AWS">

```shell
curl --insecure --request GET --location 'https://vertex.example.com/v1/system/config/aws/account' \
--header "Authorization: $TOKEN" \
--header 'Content-Type: application/json'
```
</TabItem>
<TabItem value="GCP" label="GCP">

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

</Tabs>

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

0 comments on commit 5a43c0d

Please sign in to comment.