Skip to content

Commit

Permalink
Document action needed in Palette if Vcntr pwd changes: doc-866 (#1547)
Browse files Browse the repository at this point in the history 
* Added note-required pwd change if Vcntr pwd changes

* Delete extra breaks

* Update the caution with steps.

* Created a how-to, removed steps from caution

* Added link to section and an intro.

* Changed a word.

* Added space between steps, fixed link

* Added login step, shortened heading title

* Updated steps and validation

* Add another use case for username
  • Loading branch information
@ritawatson
ritawatson authored Sep 15, 2023
1 parent 618c0ad commit 365b849
Showing 1 changed file with 39 additions and 25 deletions.
64 changes: 39 additions & 25 deletions docs/docs-content/clusters/data-center/vmware.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,8 @@ The following are some architectural highlights of Kubernetes clusters provision

The following prerequisites must be met before deploying a Kubernetes clusters in VMware:

<br />

- vSphere version 7.0 or above. vSphere 6.7 is supported but we do not recommend it, as it reached end of general support in 2022.

<br />

Palette supports port groups as follows. Opaque networks in vCenter Server are *not* supported.

- Virtual machine port groups on vSphere standard switch
Expand Down Expand Up @@ -117,30 +113,27 @@ Zone tagging is required for dynamic storage allocation across fault domains whe
| cluster-3 | k8s-zone | az3 |


<br />

## VMware Privileges

The vSphere user account that deploys Palette must have the minimum root-level vSphere privileges listed in the table below. The **Administrator** role provides superuser access to all vSphere objects. For users without the **Administrator** role, one or more custom roles can be created based on tasks the user will perform.
Permissions and privileges vary depending on the vSphere version you are using.

Select the tab for your vSphere version.

<br />


:::caution

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.

:::

<br />


<Tabs queryString="vm-privileges">

<TabItem label="8.0" value="8.0" >

<br />

## Root-Level Role Privileges

Expand All @@ -161,14 +154,11 @@ Root-level role privileges listed in the table are applied only to root objects
|**VM Storage Policies**|View VM storage policies|
|**Storage views**|View|

<br />

## Spectro Role Privileges


The Spectro role privileges listed in the table must be applied to the spectro-template folder, hosts, clusters, virtual machines, templates, datastore, and network objects.

<br />

:::info

Expand Down Expand Up @@ -298,7 +288,6 @@ Palette downloads images and Open Virtual Appliance (OVA) files to the spectro-t
</TabItem>
<TabItem label="7.0" value="7.0" >

<br />

## Root-Level Role Privileges

Expand All @@ -317,14 +306,12 @@ Root-level role privileges listed in the table are applied only to root object a
|**Profile-driven storage**|Profile-driven storage view|
|**Storage views**|View|

<br />

## Spectro Role Privileges


The Spectro role privileges listed in the table must be applied to the spectro-template folder, hosts, clusters, virtual machines, templates, datastore, and network objects.

<br />

:::info

Expand Down Expand Up @@ -452,7 +439,6 @@ Palette downloads images and Open Virtual Appliance (OVA) files to the spectro-t
</TabItem>
<TabItem label="6.7" value="6.7" >

<br />

## Root-Level Role Privileges

Expand All @@ -473,14 +459,11 @@ Root-level role privileges listed in the table are applied only to root object a
|**Profile-driven storage**|Profile-driven storage view|
|**Storage views**|View|

<br />

## Spectro Role Privileges

The Spectro role privileges listed in the table must be applied to the spectro-template folder, hosts, clusters, virtual machines, templates, datastore, and network objects.

<br />

:::info

Palette downloads images and Open Virtual Appliance (OVA) files to the spectro-templates folder and clones images from it to create nodes.
Expand Down Expand Up @@ -618,7 +601,6 @@ Palette downloads images and Open Virtual Appliance (OVA) files to the spectro-t

You can use two different PCG installation methods for VMware vSphere. You can use the Palette CLI, or you can use an OVA/OVF template. Review the prerequisites for each option to help you identify the correct installation method.

<br />

<Tabs>

Expand All @@ -638,8 +620,6 @@ You can use two different PCG installation methods for VMware vSphere. You can u

- You can set up the PCG as a single or three-node cluster based on your requirements for high availability (HA). The minimum PCG resource requirements are the following.

<br />

- Single-node cluster: 2 vCPU, 4 GB memory, 60 GB storage.

- High-Availability (HA) three-node cluster: 6 vCPU, 12 GB memory, 70 GB storage.
Expand Down Expand Up @@ -698,8 +678,6 @@ Self-hosted Palette installations provide a system PCG out-of-the-box and typica

4. Next, provide environment configurations for the cluster. Refer to the following table for information about each option.

<br />

|**Parameter**| **Description**|
|:-------------|----------------|
|**HTTPS Proxy**|Leave this blank unless you are using an HTTPS Proxy. This setting will be propagated to all PCG nodes and all of its cluster nodes. Example: `https://USERNAME:PASSWORD@PROXYIP:PROXYPORT`.|
Expand Down Expand Up @@ -822,7 +800,6 @@ Once installed, the PCG registers itself with Palette. To verify the PCG is regi

To change the PCG install values, restart the installation process using the `palette pcg install` command. Use the following steps to redeploy the PCG or restart the install process.

<br />

1. Make the necessary changes to the PCG configuration file the CLI created during the installation, if needed. Use a text editor, such as vi or nano to update the PCG install configuration file.

Expand Down Expand Up @@ -1072,6 +1049,43 @@ In addition to the default cloud account already associated with the private clo
| **Username** | vCenter username|
| **Password** | vCenter password|
:::caution
If you change the password for a user account in vCenter, you must also change it in Palette for the same VMware cloud account. We recommend updating the passwords immediately to avoid potentially locking Palette out of vCenter. For guidance, refer to [Change VMware Cloud Account Password in Palette](/clusters/data-center/vmware#change-vmware-cloud-account-password-in-palette).
:::
## Change VMware Cloud Account Password
The user account password in vCenter must match the password for the corresponding VMware cloud account in Palette. This section provides steps to change the password in Palette in the event the vCenter password changes.
### Prerequisites
- Access to the vCenter credentials.
### Change the Password in Palette
1. Log in to [Palette](https://console.spectrocloud.com/).
2. From the **Menu Menu** navigate to **Tenant Settings** > **Cloud Accounts**.
3. Click the **three-dot Menu** for the VMware account you want to update, and select **Edit**.
<!-- 4. In the **Cloud Account** field, use the drop-down menu to choose the account with the changed password. -->
4. In the window that opens, update the password in the **Password** field and click the **Validate** button.
5. Confirm your changes.
### Validation
Palette validates the password. Incorrect credentials will result in an error. As an extra precaution, try scaling a cluster up or down.
:::info
In addition to changing the password for a VMware account, Palette provides a way for you to also change the user associated with an account by entering a new username in the **Username** field. Ensure the new user account has the same permissions as the previous user account in vCenter.
:::
# Deploy a VMware Cluster
<video title="vmware-cluster-creation" src="/videos/clusters/data-center/cluster-creation-videos/vmware.mp4"></video>
Expand Down

0 comments on commit 365b849

Please sign in to comment.