diff --git a/docs/docs-content/clusters/data-center/vmware.md b/docs/deprecated/clusters/data-center/vmware.md similarity index 100% rename from docs/docs-content/clusters/data-center/vmware.md rename to docs/deprecated/clusters/data-center/vmware.md diff --git a/docs/docs-content/clusters/data-center/data-center.md b/docs/docs-content/clusters/data-center/data-center.md index 70b318ff5a..f47603c11f 100644 --- a/docs/docs-content/clusters/data-center/data-center.md +++ b/docs/docs-content/clusters/data-center/data-center.md @@ -30,4 +30,4 @@ environments. - [OpenStack](openstack.md) -- [VMware](vmware.md) +- [VMware](./vmware/vmware.md) diff --git a/docs/docs-content/clusters/data-center/maas/register-manage-maas-cloud-accounts.md b/docs/docs-content/clusters/data-center/maas/register-manage-maas-cloud-accounts.md index eda1255283..97005478f2 100644 --- a/docs/docs-content/clusters/data-center/maas/register-manage-maas-cloud-accounts.md +++ b/docs/docs-content/clusters/data-center/maas/register-manage-maas-cloud-accounts.md @@ -21,9 +21,7 @@ additional cloud accounts that reference specific PCGs. [PCG Architecture](../../pcg/architecture.md#pcg-deployment-options) page. - An active [MAAS API key](https://maas.io/docs/api-authentication-reference) which can be generated in the MAAS web - console under **My Preferences** > **API keys**. The following is an example key: - - `APn53wz232ZwBMxDp5:MHZIbUp3e4DJTjZEKg:mdEv33WAG536MhNC8mIywNLtjcDTnFAQ` + console under **My Preferences**, and selecting **API keys**. For details, refer to the MAAS document on [how to add an API key](https://maas.io/docs/how-to-manage-user-accounts#heading--api-key). diff --git a/docs/docs-content/clusters/data-center/vmware/_category_.json b/docs/docs-content/clusters/data-center/vmware/_category_.json new file mode 100644 index 0000000000..c3460c6dbd --- /dev/null +++ b/docs/docs-content/clusters/data-center/vmware/_category_.json @@ -0,0 +1,3 @@ +{ + "position": 30 +} diff --git a/docs/docs-content/clusters/data-center/vmware/architecture.md b/docs/docs-content/clusters/data-center/vmware/architecture.md new file mode 100644 index 0000000000..745b89c005 --- /dev/null +++ b/docs/docs-content/clusters/data-center/vmware/architecture.md @@ -0,0 +1,96 @@ +--- +sidebar_label: "Architecture" +title: "Architecture" +description: "Learn about the architecture used to support VMware clusters through Palette." +hide_table_of_contents: false +sidebar_position: 10 +tags: ["data center", "vmware", "architecture"] +--- + +## Overview + +Palette supports using VMware vSphere as a data center provider. You can deploy Kubernetes clusters to your vSphere +environment using Palette. Below are some key features of the Palette VMware architecture: + +- Kubernetes nodes can be distributed across multiple-compute clusters, which serve as distinct fault domains. + +- Support for static IP addresses, as well as DHCP. If you are using Dynamic Host Configuration Protocol (DHCP), Dynamic + DNS is required. + +- Support for IP address pool management for assigning blocks of IPs dedicated to clusters or projects. + +- A Private Cloud Gateway (PCG) must be setup within the VMware vSphere environment to communicate with the Palette + management platform and the VMware vCenter that installed in the private data center. + + The PCG facilitates communication between Palette and your infrastructure environment. The PCG is necessary in + environments where Palette does not have direct network access. Many infrastructure environments are placed in a + private network that blocks connections originating externally. The PCG connects to Palette, and acts as an endpoint, + allowing you to target the environment when deploying clusters in Palette. + + ![vmware_arch_oct_2020.webp](/clusters_vmware_architecture_arch-overview.webp) + +You can learn more in the [PCG Architecture](../../pcg/architecture.md) section. + +## Zone Tagging + +You can use tags to create node zones and regions for your Kubernetes clusters. The node zones and regions can be used +to dynamically place Kubernetes workloads and achieve higher availability. Kubernetes nodes inherit the zone and region +tags as [Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). Kubernetes workloads can +use the node labels to ensure that the workloads are deployed to the correct zone and region. + +The following is an example of node labels that are discovered and inherited from vSphere tags. The tag values are +applied to Kubernetes nodes in vSphere. + + + +```yaml hideClipboard +topology.kubernetes.io/region=usdc +topology.kubernetes.io/zone=zone3 +failure-domain.beta.kubernetes.io/region=usdc +failure-domain.beta.kubernetes.io/zone=zone3 +``` + + +:::info + +To learn more about node zones and regions, refer to the +[Node Zones/Regions Topology](https://cloud-provider-vsphere.sigs.k8s.io/cloud_provider_interface.html) section of the +Cloud Provider Interface documentation. + +::: + +Zone tagging is required to install Palette and is helpful for Kubernetes workloads deployed in vSphere clusters through +Palette if they have persistent storage needs. Use vSphere tags on data centers and compute clusters to create distinct +zones in your environment. You can use vSphere +[Tag Categories and Tags](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html) +to create zones in your vSphere environment and assign them to vSphere objects. + +The zone tags you assign to your vSphere objects, such as a datacenter and clusters are applied to the Kubernetes nodes +you deploy through Palette into your vSphere environment. Kubernetes clusters deployed to other infrastructure +providers, such as public cloud may have other native mechanisms for auto discovery of zones. + +For example, assume a vCenter environment contains three compute clusters, cluster-1, cluster-2, and cluster-3. To +support this environment you create the tag categories `k8s-region` and `k8s-zone`. The `k8s-region` is assigned to the +datacenter, and the `k8s-zone` tag is assigned to the compute clusters. + +The following table lists the tag values for the data center and compute clusters. + +| **vSphere Object** | **Assigned Name** | **Tag Category** | **Tag Value** | +| ------------------ | ----------------- | ---------------- | ------------- | +| **Datacenter** | dc-1 | k8s-region | region1 | +| **Cluster** | cluster-1 | k8s-zone | az1 | +| **Cluster** | cluster-2 | k8s-zone | az2 | +| **Cluster** | cluster-3 | k8s-zone | az3 | + +Create a tag category and tag values for each datacenter and cluster in your environment. Use the tag categories to +create zones. Use a name that is meaningful and that complies with the tag requirements listed in the following section. + +### Tag Requirements + +The following requirements apply to tags: + +- A valid tag must consist of alphanumeric characters. + +- The tag must start and end with an alphanumeric character. + +- The regex used for tag validation is `(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?` diff --git a/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md new file mode 100644 index 0000000000..231dbe6af6 --- /dev/null +++ b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md @@ -0,0 +1,218 @@ +--- +sidebar_label: "Create and Manage VMware Clusters" +title: "Create and Manage VMware Clusters" +description: "Learn how to configure VMware to create VMware clusters in Palette." +hide_table_of_contents: false +sidebar_position: 20 +tags: ["data center", "vmware"] +--- + +You can deploy Kubernetes clusters on VMware vSphere using Palette. Use the following steps to create and manage VMware +clusters in Palette. + +## Prerequisites + +Before you begin, ensure that you have the following prerequisites: + +- A VMware vSphere user account with the necessary permissions to create and manage clusters. Refer to the + [Required Permissions](./permissions.md) page for more information. + +- A VMware account registered in Palette. VMware accounts are automatically registered when you deploy a Private Cloud + Gateway (PCG) in Palette. Check out the [Deploy a PCG](../../pcg/deploy-pcg/vmware.md) guide to learn how to deploy a + PCG. + + :::info + + If you have a self-hosted Palette or VerteX instance, you can use the System PCG instance that is deployed in a VMware + environment. Refer to the [System PCG](../../pcg/architecture.md#system-private-gateway) to learn more about the + system PCG. + + ::: + +- A cluster profile for the VMware vSphere environment. You can learn how to create a cluster profile by following the + steps in the + [Create a Cluster Profile](../../../profiles/cluster-profiles/create-cluster-profiles/create-cluster-profiles.md) + guide. + +- Depending on the network type you select for the cluster, you may need to create an IP Address Management (IPAM) pool + or define a search domain. Use the following guidelines to create an IPAM pool or define a search domain. + + - An IP Address Management (IPAM) pool is required to assign static IP addresses to the nodes in the cluster. You can + learn how to create an IPAM pool by following the steps in the + [Create and Manage IPAM Node Pools](../../pcg/manage-pcg/create-manage-node-pool.md) guide. + + - A search domain, also called DNS mapping, can be used to assign cluster nodes to a specific network, cluster, and + datacenter. Check out the [Add DNS Mapping](../../pcg/manage-pcg/add-dns-mapping.md) guide to learn how to add + multiple DNS mappings to a PCG. + +## Create a VMware Cluster + +1. Log in to [Palette](https://console.spectrocloud.com). + +2. Navigate to the left **Main Menu** and select **Clusters**. + +3. Click **Deploy New Cluster** on the Create a New Cluster page. + +4. Select **VMware** and click the **Start VMware Configuration** button. + +5. Fill out the input fields. Use the table below to learn more about each input fields. Click on the **Next** button + when you are done. + + | Field Name | Description | Required | + | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | + | **Cluster name** | The name of the cluster. | Yes | + | **Description** | A brief description of the cluster. | No | + | **Tags** | Tags to help you identify the cluster. | No | + | **Cloud Account** | The VMware vSphere account to use for the cluster. If no account is available, ensure you [deployed a PCG](../../pcg/deploy-pcg/vmware.md) into the VMware vSphere environment. | Yes | + +6. Select the cluster profile you want to use for the cluster. Click the **Next** to proceed. + +7. Modify any cluster profile layers as needed. Click **Next** to continue. + +8. Fill out the VMware vSphere configuration details for the cluster. Refer to the table below to learn more about each + option. Click **Next** to proceed. + + | Field Name | Description | Required | + | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | + | **Datacenter** | The VMware vSphere datacenter where the cluster and its nodes will be deployed. | Yes | + | **Deployment Folder** | The folder in the datacenter where the cluster and its nodes will be deployed. Check the box **Append cluster name** if you want the cluster name appended to the folder name. | Yes | + | **Image Template Folder** | The folder in the datacenter where the image templates are stored. This is typically in the **spectro-templates** folder. | Yes | + | **Network Type** | The network type to use for the cluster. Select **Static IP** if you want to use static IP addresses. Select **DHCP** if you want to use Dynamic Host Configuration Protocol (DHCP). | Yes | + | **SSH Key** | The SSH key to use for the cluster. Check out the [Create and Upload an SSH Key](../../cluster-management/ssh-keys.md#create-and-upload-an-ssh-key) guide to learn how to upload an SSH key to Palette. | No | + | **NTP Servers** | The Network Time Protocol (NTP) servers to use for the cluster. | No | + + :::warning + + We recommend specifying Network Time Protocol (NTP) servers to ensure that the cluster nodes have the correct time. + If no NTP servers are specified, it could lead to time drift issues. + + ::: + +9. Configure the control plane and worker node pool configurations. Click **Next** to proceed. + + ### Control Plane Pool Configuration + + :::tip + + To apply the same configuration to the worker node pool as the control plane node pool, click the **Copy from the + Control Plane Pool** button. This will copy the control plane pool configuration to the worker node pool. + + ::: + + | Field Name | Description | + | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | + | **Node Pool Name** | The name of the control plane node pool. | + | **Number of nodes in the pool** | The number of control plane nodes. Allowed values are 1, 3, and 5. | + | **Allow Worker Capability** | Enable this option to workloads to be deployed on control plane nodes. | + | **Additional Labels** | Additional labels to apply to the control plane nodes. | + | **Taints** | Taints to apply to the control plane nodes. If enabled, an input field is displayed to specify the taint key, value and effect. Check out the [Node Labels and Taints](../../cluster-management/taints.md) page to learn more. | + + #### Cloud Configuration + + | Field Name | Description | + | ---------- | ---------------------------------------------------------------- | + | **CPU** | The number of CPUs to allocate to the control plane nodes. | + | **Memory** | The amount of memory to allocate to the control plane nodes. | + | **Disk** | The amount of disk space to allocate to the control plane nodes. | + + #### Fault Domain Configuration + + | Field Name | Description | + | ------------------- | ------------------------------------------------------- | + | **Compute Cluster** | The compute cluster to use for the control plane nodes. | + | **Resource Pool** | The resource pool to use for the control plane nodes. | + | **Datastore** | The datastore to use for the control plane nodes. | + | **Network** | The network to use for the control plane nodes. | + + #### Network Configuration + + Depending on what option you selected for the **Network Type** field, the following fields are displayed. + + | Field Name | Description | Network Type | + | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | + | **IPAM Pool** | The IPAM pool to use for the control plane nodes. An IPAM pool is required to assign IP addresses to the nodes in the cluster. You can learn how to create an IPAM pool by following the steps in the [Create and Manage IPAM Node Pools](../../pcg/manage-pcg/create-manage-node-pool.md) guide. | Static IP | + | **Search Domain** | The search domain to assign the cluster nodes in. If no search domain is defined, click on the **Define DNS** button and specify the search domain. Check out the [Add DNS Mapping](../../pcg/manage-pcg/add-dns-mapping.md) guide to learn how to add multiple DNS mappings to a PCG. | DHCP | + + ### Worker Plane Pool Configuration + + | Field Name | Description | + | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **Node Pool Name** | The name of the control plane node pool. | + | **Enable Autoscaler** | Enable this option to automatically scale the worker nodes based on the workload. | + | **Node Repave Interval** | The interval at which the worker nodes are repaved in seconds. Refer to the [Repave Behavior and Configuration](../../cluster-management/node-pool.md#repave-behavior-and-configuration) for additional information about repave behaviors. | + | **Number of Nodes in the Pool** | The number of worker nodes. | + | **Rolling Update** | Choose between **Expand First** and **Contract First** to determine the order in which nodes are added or removed from the worker node pool. Expand first adds new nodes before removing old nodes. Contract first removes old nodes before adding new nodes. | + | **Additional Labels** | Additional labels to apply to the control plane nodes. | + | **Taints** | Taints to apply to the control plane nodes. If enabled, an input field is displayed to specify the taint key, value and effect. Check out the [Node Labels and Taints](../../cluster-management/taints.md) page to learn more. | + + Click on the **Next** button when you are done. + +10. You can configure the following cluster management features now if needed, or you can do it later: + + - OS Patching + - Schedule scans + - Schedule backups + - Role Based Access Control (RBAC) + - Location + + #### OS Patching + + Specify your preferred **OS Patching Schedule** for the cluster. Check out the + [OS Patching](../../cluster-management/os-patching.md) page to learn more about OS patching. + + #### Scan Options + + Enable any scan options you want Palette to perform, and select a scan schedule. Palette provides support for + Kubernetes configuration security, penetration testing, and conformance testing. + + #### Backup Options + + Schedule any backups you want Palette to perform. Review + [Backup and Restore](../../cluster-management/backup-restore/backup-restore.md) for more information. + + #### RBAC Configuration + + RBAC configuration is required when you configure custom OIDC. You must map a set of users or groups to a Kubernetes + RBAC role. To learn how to map a Kubernetes role to users and groups, refer to + [Create Role Bindings](../../cluster-management/cluster-rbac.md#create-role-bindings). Refer to + [Use RBAC with OIDC](../../../integrations/kubernetes.md#use-rbac-with-oidc) for an example. + + #### Location + + Specify the location of the cluster. The cluster location is added to the project dashboard location map. + +11. Click on the **Validate** button and review the cluster configuration and settings summary. + +12. Click **Finish Configuration** to deploy the cluster. + +The cluster deployment process is initiated. You can monitor the cluster deployment progress by navigating to the left +**Main Menu** and selecting **Clusters**. Click on the cluster you just created to view the cluster details page. The +**Cluster Status** field displays the current status of the cluster. + +## Validate + +Use the following steps to validate that the cluster is available and healthy. + +1. Log in to [Palette](https://console.spectrocloud.com). + +2. Navigate to the left **Main Menu** and click **Clusters**. + +3. The **Clusters** page lists all available clusters that Palette manages. Select the cluster you deployed to review + its details page. + +4. Ensure the **Cluster Status** field contains the value **Running**. + +:::tip + +You can download the cluster's kubeconfig file to access the cluster using the Kubernetes command-line tool, kubectl. +Check out the [Access a Cluster](../../cluster-management/palette-webctl.md) guide to learn how to download the +kubeconfig file. + +::: + +## Next Steps + +Now that you have a Kubernetes cluster deployed, you can start developing and deploying applications to your clusters. +We recommend you review the Day-2 responsibilities and become familiar with the cluster management tasks. Check out the +[Manage Clusters](../../cluster-management/cluster-management.md) documentation to learn more about Day-2 +responsibilities. diff --git a/docs/docs-content/clusters/data-center/vmware/permissions.md b/docs/docs-content/clusters/data-center/vmware/permissions.md new file mode 100644 index 0000000000..3ffe56b768 --- /dev/null +++ b/docs/docs-content/clusters/data-center/vmware/permissions.md @@ -0,0 +1,192 @@ +--- +sidebar_label: "Required Permissions" +title: "Required Permissions" +description: "The permissions required to configure VMware to allow Palette to deploy clusters in VMware vSphere." +hide_table_of_contents: false +sidebar_position: 60 +tags: ["data center", "vmware", "permissions"] +--- + +The VMware vSphere user account that deploys host clusters require access to the following vSphere objects and +permissions listed in the following table. Review the vSphere objects and privileges required to ensure each role is +assigned the required privileges. + +### Spectro Root Role Privileges + +The spectro root role privileges are only applied to root objects and data center objects. Select the tab for the +vSphere version you are using to view the required privileges for the spectro root role. + + + + + +| **vSphere Object** | **Privilege** | +| ----------------------- | -------------------------------------------------- | +| **CNS** | Searchable | +| **Datastore** | Browse datastore | +| **Host** | Configuration
Storage partition configuration | +| **vSphere Tagging** | Create and edit vSphere tags | +| **Network** | Assign network | +| **Sessions** | Validate session | +| **VM Storage Policies** | View VM storage policies | +| **Storage views** | View | + + + + + +| **vSphere Object** | **Privileges** | +| -------------------------- | -------------------------------------------------- | +| **CNS** | Searchable | +| **Datastore** | Browse datastore | +| **Host** | Configuration
Storage partition configuration | +| **vSphere tagging** | Create vSphere Tag
Edit vSphere Tag | +| **Network** | Assign network | +| **Profile-driven storage** | View | +| **Sessions** | Validate session | +| **Storage views** | View | + + + + + +| **vSphere Object** | **Privileges** | +| -------------------------- | -------------------------------------------------- | +| **CNS** | Searchable | +| **Datastore** | Browse datastore | +| **Host** | Configuration
Storage partition configuration | +| **vSphere tagging** | Create vSphere Tag
Edit vSphere Tag | +| **Network** | Assign network | +| **Profile-driven storage** | Profile-driven storage view | +| **Sessions** | Validate session | +| **Storage views** | View | + + + + + +:::warning + +If the network is a Distributed Port Group under a vSphere Distributed Switch (VDS), _ReadOnly_ access to the VDS +without “Propagate to children” is required. + +::: + +### Spectro Role Privileges + +As listed in the table, apply spectro role privileges to vSphere objects you intend to use for Palette installation. A +separate table lists Spectro role privileges for VMs by category. + +Open Virtual Appliance (OVA) files are downloaded to the folder you selected. These images are cloned from the folder +and applied VMs that deployed during deployments. + +Select the tab for the vSphere version you are using to view the required privileges for the spectro role. + + + + + +| **vSphere Object** | **Privileges** | +| --------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| **CNS** | Searchable | +| **Datastore** | Allocate space
Browse datastore
Low-level file operations
Remove file
Update VM files
Update VM metadata | +| **Folder** | Create Folder
Delete folder
Move folder
Rename folder | +| **Host** | Local operations: Reconfigure VM | +| **Network** | Assign network | +| **Resource** | Apply recommendation
Assign VM to resource pool
Migrate powered off VM
Migrate powered on VM
Query vMotion | +| **Sessions** | Validate sessions | +| **Storage policies** | View access for VM storage policies is required.
Ensure `StorageProfile.View` is available. | +| **spectro-templates** | Read only. This is the vSphere folder created during the install. For airgap installs, you must manually create this folder. | +| **Storage views** | View | +| **Tasks** | Create task
Update task | +| **vApp** | Import
View OVF environment
Configure vAPP application
Configure vApp instance | +| **vSphere tagging** | Assign or Unassign vSphere Tag
Create vSphere Tag
Delete vSphere Tag
Edit vSphere Tag | + +The following table lists spectro role privileges for VMs by category. All privileges are for the vSphere object, +Virtual Machines. + +| **Category** | **Privileges** | +| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Change Configuration | Acquire disk lease
Add existing disk
Add new disk
Add or remove device
Advanced configuration
Change CPU count
Change memory
Change settings
Change swapfile placement
Change resource
Change host USB device
Configure raw device
Configure managedBy
Display connection settings
Extend virtual disk
Modify device settings
Query fault tolerance compatibity
Query unowned files
Reload from path
Remove disk
Rename
Reset guest information
Set annotation
Toggle disk change tracking
Toggle fork parent
Upgrade VM compatibility | +| Edit Inventory | Create from existing
Create new
Move
Register
Remove
Unregister | +| Guest Operations | Alias modification
Alias query
Modify guest operations
Invoke programs
Queries | +| Interaction | Console Interaction
Power on/off | +| Provisioning | Allow disk access
Allow file access
Allow read-only disk access
Allow VM download
Allow VM files upload
Clone template
Clone VM
Create template from VM
Customize guest
Deploy template
Mark as template
Mark as VM
Modify customization specification
Promote disks
Read customization specifications | +| Service Configuration | Allow notifications
Allow polling of global event notifications
Manage service configurations
Modify service configurations
Query service configurations
Read service configurations | +| Snapshot Management | Create snapshot
Remove snapshot
Rename snapshot
Revert to snapshot | +| Sphere Replication | Configure replication
Manage replication
Monitor replication | +| vSAN | Cluster: ShallowRekey | + + + + + +| **vSphere Object** | **Privileges** | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| **CNS** | Searchable | +| **Datastore** | Allocate space
Browse datastore
Low-level file operations
Remove file
Update VM files
Update VM metadata | +| **Folder** | Create Folder
Delete folder
Move folder
Rename folder | +| **Host** | Local operations: Reconfigure VM | +| **Network** | Assign network | +| **Resource** | Apply recommendation
Assign VM to resource pool
Migrate powered off VM
Migrate powered on VM
Query vMotion | +| **Profile-driven storage** | Profile-driven storage view | +| **Sessions** | Validate session | +| **spectro-templates** | Read only. This is the vSphere folder created during the install. For airgap installs, you must manually create this folder. | +| **Storage views** | Configure service
View | +| **Tasks** | Create task
Update task | +| **vApp** | Import
View OVF environment
Configure vAPP applications
Configure vApp instances | +| **vSphere tagging** | Assign or unassign vSphere Tag
Create vSphere Tag
Delete vSphere Tag
Edit vSphere Tag | + +The following table lists spectro role privileges for VMs by category. All privileges are for the vSphere object, +Virtual Machines. + +| **Category** | **Privileges** | +| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Change Configuration | Acquire disk lease
Add existing disk
Add new disk
Add or remove device
Advanced configuration
Change CPU count
Change memory
Change Settings
Change Swapfile placement
Change resource
Change host USB device
Configure Raw device
Configure managedBy
Display connection settings
Extend virtual disk
Modify device settings
Query fault tolerance compatibity
Query unowned files
Reload from path
Remove disk
Rename
Reset guest information
Set annotation
Toggle disk change tracking
Toggle fork parent
Upgrade VM compatibility | +| Edit Inventory | Create from existing
Create new
Move
Register
Remove
Unregister | +| Guest Operations | Alias modification
Alias query
Modify guest operations
Invoke programs
Query guest operations | +| Interaction | Console Interaction
Power on/off | +| Provisioning | Allow disk access
Allow file access
Allow read-only disk access
Allow VM download
Allow VM upload
Clone template
Clone VM
Create template from VM
Customize guest
Deploy template
Mark as template
Modify customization specifications
Promote disks
Read customization specifications | +| Service Configuration | Allow notifications
Allow polling of global event notifications
Manage service configurations
Modify service configurations
Query service configurations
Read service configurations | +| Snapshot Management | Create snapshot
Remove snapshot
Rename snapshot
Revert to snapshot | +| vSphere Replication | Configure replication
Manage replication
Monitor replication | +| vSAN | Cluster
ShallowRekey | + + + + + +| **vSphere Object** | **Privileges** | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| **CNS** | Searchable | +| **Datastore** | Allocate space
Browse datastore
Low-level file operations
Remove file
Update VM files
Update VM metadata | +| **Folder** | Create Folder
Delete folder
Move folder
Rename folder | +| **Host** | Local operations: Reconfigure VM | +| **Network** | Assign network | +| **Profile-driven storage** | Profile-driven storage view | +| **Resource** | Apply recommendation
Assign VM to resource pool
Migrate powered off VM
Migrate powered on VM
Query vMotion | +| **Sessions** | Validate session | +| **spectro-templates** | Read only. This is the vSphere folder created during the install. For airgap installs, you must manually create this folder. | +| **Storage views** | View | +| **Tasks** | Create task
Update task | +| **vApp** | Import
View OVF environment
Configure vAPP applications
Configure vApp instances | +| **vSphere tagging** | Assign or unassign vSphere Tag
Create vSphere Tag
Delete vSphere Tag
Edit vSphere Tag | + +The following table lists spectro role privileges for VMs by category. All privileges are for the vSphere object, +Virtual Machines. + +| **Category** | **Privileges** | +| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Change Configuration | Acquire disk lease
Add existing disk
Add new disk
Add or remove device
Advanced configuration
Change CPU count
Change memory
Change Settings
Change Swapfile placement
Change resource
Change host USB device
Configure Raw device
Configure managedBy
Display connection settings
Extend virtual disk
Modify device settings
Query fault tolerance compatibity
Query unowned files
Reload from path
Remove disk
Rename
Reset guest information
Set annotation
Toggle disk change tracking
Toggle fork parent
Upgrade VM compatibility | +| Edit Inventory | Create from existing
Create new
Move
Register
Remove
Unregister | +| Guest Operations | Alias modification
Alias query
Modify guest operations
Invoke programs
Query guest operations | +| Interaction | Console Interaction
Power on/off | +| Provisioning | Allow disk access
Allow file access
Allow read-only disk access
Allow VM download
Allow VM upload
Clone template
Clone VM
Create template from VM
Customize guest
Deploy template
Mark as template
Modify customization specifications
Promote disks
Read customization specifications | +| Service Configuration | Allow notifications
Allow polling of global event notifications
Manage service configurations
Modify service configurations
Query service configurations
Read service configurations | +| Snapshot Management | Create snapshot
Remove snapshot
Rename snapshot
Revert to snapshot | +| vSphere Replication | Configure replication
Manage replication
Monitor replication | +| vSAN | Cluster
ShallowRekey | + + + + diff --git a/docs/docs-content/clusters/data-center/vmware/vmware.md b/docs/docs-content/clusters/data-center/vmware/vmware.md new file mode 100644 index 0000000000..92d4ea5e80 --- /dev/null +++ b/docs/docs-content/clusters/data-center/vmware/vmware.md @@ -0,0 +1,49 @@ +--- +sidebar_label: "VMware" +title: "VMware" +description: "Learn how to configure VMware to create VMware clusters in Palette." +hide_table_of_contents: false +sidebar_position: 30 +tags: ["data center", "vmware"] +--- + +Palette supports usning VMware as a data center provider. With this, you can deploy and manage Kubernetes clusters on +VMware virtual machines. For this to work, Palette uses a [Private Cloud Gateway (PCG)](../../pcg/architecture.md), +which creates a secure connection from the internal network to the internet-accessible Palette instance, ultimately +bypassing the need to create firewall rules or other network configurations allowing external connections to the +internal network. + +:::tip + +Palette supports the ability to manage your VMware workloads on the same Kubernetes infrastructure as your other +applications through the Palette Virtual Machine Orchestrator (VMO). VMO provides a unified platform for managing +containerized and virtualized applications. This solution allows organizations to onboard, deploy, manage, and scale VMs +within the same cluster as their containerized applications. Check out the +[VMO documentation](../../../vm-management/vm-management.md) for more information. + +::: + +## Get Started + +To get started with VMware as your target platform for deploying Kubernetes clusters, you need to deploy a PCG in your +VMware environment. The PCG acts as a bridge between your VMware environment and Palette, enabling secure communication +between the two. Start by reviewing the [Deploy a PCG in VMware vSphere](../../pcg/deploy-pcg/vmware.md) guide. + +:::info + +If you are using a self-hosted Palette or VerteX instance, you can skip the PCG deployment and use the System PCG that +is already available in the instance. Review the [System PCG](../../pcg/architecture.md#system-private-gateway) section +of the PCG architecture page for more information. + +::: + +After you have deployed the PCG, you can proceed to create and manage VMware clusters in Palette. Refer to the +[Create and Manage VMware Clusters](create-manage-vmware-clusters.md) guide for detailed instructions. + +## Resources + +- [Architecture](architecture.md) + +- [Create and Manage VMware Clusters](create-manage-vmware-clusters.md) + +- [Permissions](permissions.md) diff --git a/docs/docs-content/clusters/pcg/manage-pcg/add-dns-mapping.md b/docs/docs-content/clusters/pcg/manage-pcg/add-dns-mapping.md new file mode 100644 index 0000000000..f6455d08db --- /dev/null +++ b/docs/docs-content/clusters/pcg/manage-pcg/add-dns-mapping.md @@ -0,0 +1,68 @@ +--- +sidebar_label: "Add DNS Mapping" +title: "Add DNS Mapping" +description: "Learn how to add DNS mapping for a Private Cloud Gateway (PCG) deployed in a VMware vSphere environment." +hide_table_of_contents: false +sidebar_position: 15 +tags: ["pcg"] +--- + +If your VMware vSphere environment is configured with Dynamic Host Configuration Protocol (DHCP), you can add a Dynamic +Name Server (DNS) mapping to the Private Cloud Gateway (PCG) to resolve the hostnames of the nodes in the PCG. You can +also use the DNS mapping ensure nodes are alocated to the correct datacenter, cluster and network. + +You can add multiple DNS mappings to a PCG to support different datacenters and networks in your VMware vSphere +environment. + +## Prerequisites + +- A PCG is installed, active, and in a healthy state. Refer to [Deploy a PCG](../deploy-pcg/deploy-pcg.md) for + instructions on how to install a PCG. + +- Access to the VMware vSphere environment. + +- Tenant administrator access. + +## Add DNS Mapping + +1. Log in to [Palette](https://console.spectrocloud.com) as a tenant administrator. + +2. Navigate to the left **Main Menu** and select **Tenant Settings**. + +3. Select **Private Cloud Gateways** from the **Tenant Settings Menu**. + +4. Click on the PCG for which you want to create a node pool. + +5. From the PCG details page, click on the **DNS Mapping** tab. + +6. Select **Add New DNS Mapping**. + +7. Fill out the form. Refer to the table below to learn more about each input option. + + | Field | Description | + | ------------------- | ----------------------------------------------------------- | + | **Search Domain** | The domain name to allocate nodes to and resolve hostnames. | + | **Datacenter** | The vSphere datacenter to which the DNS mapping applies. | + | **Compute Cluster** | The vSphere cluster to which the DNS mapping applies. | + | **Network** | The vSphere network to which the DNS mapping applies. | + +8. Click **Confirm** to add the DNS mapping. + +## Validate + +Use the following steps to validate that the DNS mapping was created successfully. + +1. Log in to [Palette](https://console.spectrocloud.com) as a tenant administrator. + +2. Navigate to the left **Main Menu** and select **Tenant Settings**. + +3. Select **Private Cloud Gateways** from the **Tenant Settings Menu** + +4. Click on the PCG for which you created a node pool. + +5. From the PCG details page, click on the **DNS Mapping** tab. + +6. The new DNS mapping should be listed in the **Search Domain** section. + +To use the new DNS mapping, you will need to create a cluster and select DHCP as the network type. Select the DNS +mapping when configuring the cluster control plane and worker nodes. diff --git a/docs/docs-content/enterprise-version/install-palette/airgap/vmware-vsphere-airgap-instructions.md b/docs/docs-content/enterprise-version/install-palette/airgap/vmware-vsphere-airgap-instructions.md index 0574a48b5a..8ad0e97fa0 100644 --- a/docs/docs-content/enterprise-version/install-palette/airgap/vmware-vsphere-airgap-instructions.md +++ b/docs/docs-content/enterprise-version/install-palette/airgap/vmware-vsphere-airgap-instructions.md @@ -61,7 +61,7 @@ Palette. Self-hosted Palette installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not require a separate, user-installed PCG. However, you can deploy additional PCG instances to support provisioning into remote data centers without a direct incoming connection to Palette. To learn how to install a PCG on VMware, check out -the [VMware](../../../clusters/data-center/vmware.md) guide. +the [VMware](../../../clusters/pcg/deploy-pcg/vmware.md) guide. ::: diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md index 35f8a1317c..e803292e3e 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md @@ -76,7 +76,7 @@ proceeding with the installation. Refer to the Self-hosted Palette installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not require a separate, user-installed PCG. However, you can create additional PCGs as needed to support provisioning into remote data centers that do not have a direct incoming connection from the Palette console. To learn how to install a -PCG on VMware, check out the [VMware](../../../clusters/data-center/vmware.md) guide. +PCG on VMware, check out the [VMware](../../../clusters/pcg/deploy-pcg/vmware.md) guide. ::: diff --git a/docs/docs-content/integrations/cloudanix.md b/docs/docs-content/integrations/cloudanix.md index c487d133ce..70b91c9b3a 100644 --- a/docs/docs-content/integrations/cloudanix.md +++ b/docs/docs-content/integrations/cloudanix.md @@ -8,7 +8,7 @@ hide_table_of_contents: true type: "integration" category: ["security", "amd64"] sidebar_class_name: "hide-from-sidebar" -logoUrl: "https://cloudanix-assets.s3.amazonaws.com/static/cloudanix-logo-p.webp" +logoUrl: "https://cloudanix-assets.s3.amazonaws.com/static/cloudanix-logo-p.png" tags: ["packs", "cloudanix", "security"] --- diff --git a/docs/docs-content/vertex/install-palette-vertex/airgap/vmware-vsphere-airgap-instructions.md b/docs/docs-content/vertex/install-palette-vertex/airgap/vmware-vsphere-airgap-instructions.md index d0bd73812b..79a4fb3888 100644 --- a/docs/docs-content/vertex/install-palette-vertex/airgap/vmware-vsphere-airgap-instructions.md +++ b/docs/docs-content/vertex/install-palette-vertex/airgap/vmware-vsphere-airgap-instructions.md @@ -61,7 +61,7 @@ VerteX. Self-hosted VerteX installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not require a separate, user-installed PCG. However, you can deploy additional PCG instances to support provisioning into remote data centers without a direct incoming connection to VerteX. To learn how to install a PCG on VMware, check out -the [VMware](../../../clusters/data-center/vmware.md) guide. +the [VMware](../../../clusters/data-center/vmware/vmware.md) guide. ::: diff --git a/static/assets/docs/images/clusters_vmware_architecture_arch-overview.webp b/static/assets/docs/images/clusters_vmware_architecture_arch-overview.webp new file mode 100644 index 0000000000..555e5b603d Binary files /dev/null and b/static/assets/docs/images/clusters_vmware_architecture_arch-overview.webp differ diff --git a/static/assets/docs/images/vmware_arch_oct_2020.webp b/static/assets/docs/images/vmware_arch_oct_2020.webp deleted file mode 100644 index 63ff037595..0000000000 Binary files a/static/assets/docs/images/vmware_arch_oct_2020.webp and /dev/null differ