Skip to content

Commit b45adf0

Browse files
addetzaddetz
committed
Merge branch 'master' into docs-rel-4-8-a
2 parents 019b349 + ebc01ee commit b45adf0

33 files changed

+1131
-63
lines changed

‎_partials/pcg/_pcg-initial-installation.mdx‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,15 @@ partial_name: pcg-initial-installation
2424
| **Allow Insecure Connection** | Bypass x509 server Certificate Authority (CA) verification. Enter `y` if you are using a self-hosted Palette or Palette VerteX instance with self-signed TLS certificates and need to provide a file path to the instance CA. Otherwise, enter `n`. |
2525
| **Spectro Cloud API Key** | Enter your Palette API Key. Refer to the <VersionedLink text="Create API Key" url="/user-management/authentication/api-key/create-api-key" /> guide for more information. |
2626
| **Spectro Cloud Organization** | Select your Palette organization name. |
27-
| **Spectro Cloud Project** | Select the project you want to register your {props.edition} account in. |
27+
| **Spectro Cloud Project** | Select the Palette project you want to register your {props.edition} account in. |
2828
| **Acknowledge** | Accept the login banner message. Login banner messages are only displayed if the tenant admin enabled a login banner. |
2929

3030
:::info
3131

32-
The `CloudAccount.apiKey` and `Mgmt.apiKey` values in the **pcg.yaml** file are encrypted and cannot be manually
33-
updated. To change these values, use the `palette pcg install --update-passwords` command. Refer to the <VersionedLink text="PCG command" url="/automation/palette-cli/commands/pcg#update-passwords" /> reference page for more information.
32+
After completing the `palette pcg install` steps, the configuration details are saved to a file named `pcg.yaml` in the `~/.palette/pcg/pcg-<date-time>` directory.
33+
The `CloudAccount.apiKey` and `Mgmt.apiKey` values in the `pcg.yaml` file are encrypted and cannot be manually updated. To change these values, use the
34+
`palette pcg install --update-passwords` command. Refer to the <VersionedLink text="PCG command" url="/automation/palette-cli/commands/pcg#update-passwords" />
35+
reference page for more information.
3436

3537
:::
3638

@@ -46,9 +48,9 @@ partial_name: pcg-initial-installation
4648
| **Management Plane Type** | Select **Palette** or **VerteX**. |
4749
| **Enable Ubuntu Pro (required for production)** | Enter `y` if you want to use Ubuntu Pro and provide an Ubuntu Pro token. Otherwise, enter `n`. |
4850
| **Select an image registry type** | For a non-airgap installation, choose `Default` to pull images from public image registries. This requires an internet connection. For airgapped installations, select `Custom` and point to your airgap support VM or a custom internal registry that contains the required images. |
49-
| **Share PCG Cloud Account across platform Projects** | Enter `y` if you want the cloud account associated with the PCG to be available from all projects within your organization. Enter `n` if you want the cloud account to only be available at the tenant admin scope. |
5051
| **Cloud Type** | Select **{props.edition}**. |
5152
| **Private Cloud Gateway Name** | Enter a custom name for the PCG. |
53+
| **Share PCG Cloud Account across platform Projects** | Enter `y` if you want the cloud account associated with the PCG to be available from all projects within your organization. Enter `n` if you want the cloud account to only be available at the tenant admin scope. |
5254

5355
5. If you want to configure your PCG to use a proxy network, complete the following fields, as appropriate.
5456

‎_partials/permissions/_cloudstack-dynamic-permissions.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
partial_category: permissions
3+
partial_name: cloudstack-dynamic-permissions
4+
---
5+
**Last Update**: December 13, 2025
6+
7+
```text
8+
assignToLoadBalancerRule
9+
associateIpAddress
10+
createAffinityGroup
11+
createEgressFirewallRule
12+
createLoadBalancerRule
13+
createNetwork
14+
createTags
15+
deleteAffinityGroup
16+
deleteNetwork
17+
deleteTags
18+
deployVirtualMachine
19+
destroyVirtualMachine
20+
disassociateIpAddress
21+
getUserKeys
22+
listAccounts
23+
listAffinityGroups
24+
listCapabilities
25+
listDiskOfferings
26+
listDomains
27+
listLoadBalancerRuleInstances
28+
listLoadBalancerRules
29+
listNetworkOfferings
30+
listNetworks
31+
listProjects
32+
listPublicIpAddresses
33+
listServiceOfferings
34+
listSSHKeyPairs
35+
listTags
36+
listTemplates
37+
listUsers
38+
listVPCs
39+
listVirtualMachines
40+
listVirtualMachinesMetrics
41+
listVolumes
42+
listZones
43+
queryAsyncJobResult
44+
startVirtualMachine
45+
stopVirtualMachine
46+
updateVMAffinityGroup
47+
```

‎_partials/permissions/_cloudstack-static-permissions.mdx‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
partial_category: permissions
3+
partial_name: cloudstack-static-permissions
4+
---
5+
**Last Update**: December 13, 2025
6+
7+
```text
8+
assignToLoadBalancerRule
9+
associateIpAddress
10+
createAffinityGroup
11+
createEgressFirewallRule
12+
createLoadBalancerRule
13+
createNetwork
14+
createTags
15+
deleteAffinityGroup
16+
deleteNetwork
17+
deleteTags
18+
deployVirtualMachine
19+
destroyVirtualMachine
20+
disassociateIpAddress
21+
getUserKeys
22+
listAccounts
23+
listAffinityGroups
24+
listCapabilities
25+
listDiskOfferings
26+
listDomains
27+
listLoadBalancerRuleInstances
28+
listLoadBalancerRules
29+
listNetworkOfferings
30+
listNetworks
31+
listProjects
32+
listPublicIpAddresses
33+
listServiceOfferings
34+
listSSHKeyPairs
35+
listTags
36+
listTemplates
37+
listUsers
38+
listVPCs
39+
listVirtualMachines
40+
listVirtualMachinesMetrics
41+
listVolumes
42+
listZones
43+
queryAsyncJobResult
44+
startVirtualMachine
45+
stopVirtualMachine
46+
updateVMAffinityGroup
47+
```

‎_partials/self-hosted/feature-flags/_feature-flags-intro.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ The following table lists all available feature flags and their supported platfo
1818
| **AwsSecretPartition** | Configure [AWS Secret Cloud](https://aws.amazon.com/federal/secret-cloud/) accounts and deploy EKS clusters in AWS Secret cloud. Refer to our <VersionedLink text="Register and Manage AWS Accounts" url="/clusters/public-cloud/aws/add-aws-accounts#aws-secret-cloud-account-us" /> guide for more information. | :x: | :white_check_mark: |
1919
| **AzureUSSecretCloud** | Configure [Azure Government Secret cloud](https://azure.microsoft.com/en-us/explore/global-infrastructure/government/national-security) accounts and deploy Azure IaaS clusters in Azure Government Secret cloud. Refer to our [Register and Manage Azure Accounts](/clusters/public-cloud/azure/azure-cloud/#azure-government-secret-cloud) guide for more information. | :x: | :white_check_mark: |
2020
| **LxdMaas** | Spawn multiple control plane nodes as LXD VMs and consolidate them on MAAS-managed servers while your worker nodes run on bare metal devices. Refer to our <VersionedLink text="Create and Manage MAAS Clusters Using LXD VMs" url="/clusters/data-center/maas/create-manage-maas-lxd-clusters/" /> guide for more information. | :white_check_mark: | :white_check_mark: |
21+
| **ApacheCloudStack** | Allows for the creation of workloads on Apache CloudStack. Refer to our <VersionedLink text="Create and Manage Apache CloudStack Clusters" url="/clusters/data-center/cloudstack/create-manage-cloudstack-clusters/" /> guide for more information. | :white_check_mark: | :white_check_mark: |
22+
23+
2124

2225
:::warning
2326

‎docs/docs-content/clusters/data-center/cloudstack/_category_.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"position": 30
3+
}

‎docs/docs-content/clusters/data-center/cloudstack/add-cloudstack-accounts.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
sidebar_label: "Add CloudStack Accounts"
3+
title: "Add CloudStack Accounts to Palette"
4+
description: "Learn how to register and manage your CloudStack accounts in Palette."
5+
hide_table_of_contents: false
6+
sidebar_position: 20
7+
tags: ["data center", "cloudstack"]
8+
---
9+
10+
:::preview
11+
12+
This is a Tech Preview feature and is subject to change. Do not use this feature in production workloads. This feature
13+
is supported in self-hosted Palette only.
14+
15+
:::
16+
17+
You can register Apache CloudStack accounts in Palette to create and manage Kubernetes clusters in your CloudStack
18+
environment.
19+
20+
## Prerequisites
21+
22+
- The **ApacheCloudStack** [feature flag](../../../enterprise-version/system-management/feature-flags.md) is enabled.
23+
24+
- An installed [Private Cloud Gateway (PCG)](../../pcg/pcg.md) that connects to your CloudStack environment. Review
25+
[Deploy a PCG in CloudStack](../../pcg/deploy-pcg/cloudstack.md) for guidance.
26+
27+
:::info
28+
29+
If you have a self-hosted Palette or VerteX instance with network connectivity to the CloudStack environment, you can
30+
use a System Private Gateway to add CloudStack accounts. Refer to the
31+
[System Private Gateway](../../pcg/architecture.md#system-private-gateway) guide to learn more.
32+
33+
:::
34+
35+
- A CloudStack user account with the required permissions to deploy workload clusters in the CloudStack environment.
36+
Review [Required Permissions for CloudStack](required-permissions.md) to learn more about the required permissions.
37+
38+
- Access to your CloudStack environment with the following information:
39+
40+
- The CloudStack API endpoint URL. For example, `https://cloudstack.example.com:8443/client/api` or
41+
`https://management-server-ip:8080/client/api`.
42+
43+
- A CloudStack API key and Secret key for the user account that will be used to deploy workload clusters. Refer to the
44+
[Using API Key and Secret Key based Authentication](https://docs.cloudstack.apache.org/en/latest/adminguide/accounts.html#using-api-key-and-secret-key-based-authentication)
45+
guide about API and Secret keys.
46+
47+
- The [CloudStack domain](https://docs.cloudstack.apache.org/en/latest/adminguide/accounts.html#domains) name for the
48+
user account that will be used to deploy workload clusters.
49+
50+
- The Certificate Authority (CA) certificate for your CloudStack environment if it uses a custom or self-signed TLS
51+
certificate.
52+
53+
## Register a CloudStack Account
54+
55+
1. Log in to Palette as a tenant admin.
56+
57+
2. From the left main menu, select **Tenant Settings > Infrastructure > Cloud Accounts**.
58+
59+
3. Locate **CloudStack** and click **Add CloudStack Account**.
60+
61+
4. Fill out the following input values and click **Confirm** to continue.
62+
63+
| **Field** | **Description** |
64+
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
65+
| **Account name** | A custom name for the CloudStack account. This is used by Palette to identify the account. |
66+
| **select private cloud gateway** | Select the PCG from the list of deployed PCGs in your setup. |
67+
| **API URL** | Enter the CloudStack API endpoint URL. For example, `https://cloudstack.example.com:8443/client/api` or `https://management-server-ip:8080/client/api`. |
68+
| **API Key** | Enter the CloudStack API key for the user account that has permissions to deploy workload clusters. |
69+
| **Secret Key** | Enter the CloudStack Secret key for the user account that has permissions to deploy workload clusters. Click **Validate** to verify the connection. |
70+
| **Domain** | Enter the CloudStack [domain](https://docs.cloudstack.apache.org/en/latest/adminguide/accounts.html#domains) name for the user account that has permissions to deploy workload clusters. |
71+
| **Allow Insecure Connection** | Enable this option if you want to skip TLS certificate verification for your CloudStack environment. |
72+
73+
5. After filling out the required information, click **Confirm** to add the CloudStack account to Palette.
74+
75+
## Validate
76+
77+
1. Log in to Palette as a tenant admin.
78+
79+
2. From the left main menu, select **Tenant Settings > Infrastructure > Cloud Accounts**.
80+
81+
3. Verify that the CloudStack account you added appears in the CloudStack accounts list.
82+
83+
## Next Steps
84+
85+
- Learn how to [Create and Manage CloudStack Clusters](create-manage-cloudstack-clusters.md) in Palette.

‎docs/docs-content/clusters/data-center/cloudstack/architecture.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
sidebar_label: "Architecture"
3+
title: "Architecture"
4+
description: "Learn about the architecture used to support CloudStack clusters through Palette."
5+
hide_table_of_contents: false
6+
sidebar_position: 10
7+
tags: ["data center", "cloudstack", "architecture"]
8+
---
9+
10+
:::preview
11+
12+
This is a Tech Preview feature and is subject to change. Do not use this feature in production workloads. This feature
13+
is supported in self-hosted Palette only.
14+
15+
:::
16+
17+
Palette supports using
18+
[Apache CloudStack](https://docs.cloudstack.apache.org/en/latest/conceptsandterminology/concepts.html#cloud-infrastructure-overview)
19+
as a data center provider. You can deploy Kubernetes clusters to your CloudStack environment using Palette. The
20+
CloudStack management environment could include Bare Metal (via IPMI), Hyper-V, Kernel-based Virtual Machine(KVM), Linux
21+
Containers (LXC), vSphere (via vCenter), Xenserver and Xen Project. Below are some key features of the Palette
22+
CloudStack architecture:
23+
24+
- Support for static IP addresses, as well as DHCP. If you are using Dynamic Host Configuration Protocol (DHCP), Dynamic
25+
DNS is required.
26+
27+
- Support for IP address pool management for assigning blocks of IPs dedicated to clusters or projects.
28+
29+
- A Private Cloud Gateway (PCG) must be setup within the CloudStack environment to communicate with the Palette
30+
management platform and the Apache CloudStack management platform that installed in the private data center.
31+
32+
The PCG facilitates communication between Palette and your infrastructure environment. The PCG is necessary in
33+
environments where Palette does not have direct network access. Many infrastructure environments are placed in a
34+
private network that blocks connections originating externally. The PCG connects to Palette, and acts as an endpoint,
35+
allowing you to target the environment when deploying clusters in Palette.
36+
37+
![CloudStack VPC Static Flow](/clusters_pcg_architecture_cloudstack_overview_diagram.webp)
38+
39+
- Support for Projects within a Domain. You can use Apache CloudStack projects to separate workload resources among
40+
different teams, as CloudStack tracks resource usage per project and per user.
41+
42+
You can learn more in the [PCG Architecture](../../pcg/architecture.md) section.

‎docs/docs-content/clusters/data-center/cloudstack/cloudstack.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
sidebar_label: "CloudStack"
3+
title: "Apache CloudStack"
4+
description: "Learn how to configure Apache CloudStack and create CloudStack clusters in Palette"
5+
hide_table_of_contents: false
6+
tags: ["data center", "cloudstack"]
7+
---
8+
9+
:::preview
10+
11+
This is a Tech Preview feature and is subject to change. Do not use this feature in production workloads. This feature
12+
is supported in self-hosted Palette only.
13+
14+
:::
15+
16+
Palette supports using [Apache CloudStack](https://cloudstack.apache.org/) as a data center provider. You can deploy
17+
Kubernetes clusters to your CloudStack environment using Palette.
18+
19+
To make this work, Palette will need a [Private Cloud Gateway (PCG)](../../pcg/pcg.md), which creates a secure
20+
connection from the internal network to the Palette instance, ultimately bypassing the need to create firewall rules or
21+
other network configurations allowing external connections to the internal network.
22+
23+
## Get Started
24+
25+
To get started with CloudStack as your target platform for deploying Kubernetes clusters, you need to deploy a PCG in
26+
your CloudStack environment. The PCG acts as a bridge between your CloudStack environment and Palette, enabling secure
27+
communication between the two. Start by reviewing the [Deploy a PCG in CloudStack](../../pcg/deploy-pcg/cloudstack.md)
28+
guide and the [required permissions](required-permissions.md).
29+
30+
:::info
31+
32+
If you are using a self-hosted Palette or VerteX instance, you can skip the PCG deployment and use the System PCG that
33+
is already available in the instance. Review the [System PCG](../../pcg/architecture.md#system-private-gateway) section
34+
of the PCG architecture page for more information.
35+
36+
:::
37+
38+
After you have deployed the PCG, you can proceed to [add a CloudStack account](./add-cloudstack-accounts.md), which will
39+
enable you to [create and manage CloudStack clusters](./create-manage-cloudstack-clusters.md) in Palette.
40+
41+
## Supported Versions
42+
43+
The following versions of Apache CloudStack are supported in Palette.
44+
45+
| **Version** | **Supported** |
46+
| ----------- | ------------------ |
47+
| 4.19.3.0 | :white_check_mark: |
48+
49+
The following versions of Apache Cloud API are supported in Palette.
50+
51+
| **Version** | **Supported** |
52+
| ----------- | ------------------ |
53+
| 0.6.1 | :white_check_mark: |
54+
55+
## Next Steps
56+
57+
- [Review architecture for CloudStack](architecture.md)
58+
59+
- [Review required permissions for CloudStack](required-permissions.md)
60+
61+
- [Deploy a PCG in CloudStack](../../pcg/deploy-pcg/cloudstack.md) or use a
62+
[System Private Gateway](../../pcg/architecture.md#system-private-gateway) if you have a self-hosted Palette or VerteX
63+
instance with network connectivity to the CloudStack environment.
64+
65+
- [Add CloudStack accounts to Palette](./add-cloudstack-accounts.md)
66+
67+
- [Create and manage CloudStack clusters](create-manage-cloudstack-clusters.md)

0 commit comments

Comments
 (0)