diff --git a/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md b/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md index fa4f67d495..652bbb0e2a 100644 --- a/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md +++ b/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md @@ -15,8 +15,6 @@ The PCG is a Kubernetes cluster that supports Palette in a private network envir At a high level, the following occurs during a successful MAAS PCG installation: -
- - Use the Palette CLI on a laptop, workstation, or Bastion host. @@ -41,12 +39,6 @@ As the following diagram shows, Palette provides an installer in the form of a D Use the following steps to install a PCG cluster in your MAAS environment. You can use the [Palette CLI](/palette-cli) or the PCG Installer Image to deploy a PCG cluster. Review the prerequisites for each option to help you identify the correct install method. - - - - - - ### Prerequisites @@ -56,7 +48,8 @@ Use the following steps to install a PCG cluster in your MAAS environment. You c - Canonical [MAAS installed](https://maas.io/docs/how-to-install-maas), set up, and available in your environment. -- Download the Palette CLI from the [Downloads](../../../spectro-downloads.md#palette-cli) page and install the CLI. Refer to the [Palette CLI Install](../../../palette-cli/install-palette-cli.md) guide to learn more. +- Download the Palette CLI from the [Downloads](../../../spectro-downloads.md#palette-cli) page and install it. Refer to the [Palette CLI Install](../../../palette-cli/install-palette-cli.md) guide to learn more. Use the latest version of the Palette CLI that matches the version of your Palette or Palette VerteX instance. + - A Palette API key. Refer to the [Create API Key](../../../user-management/authentication/api-key/create-api-key.md) page for guidance. @@ -129,8 +122,6 @@ The following steps will guide you on how to install a PCG cluster. 2. Use the [Palette CLI](../../../palette-cli/install-palette-cli.md) `login` command to authenticate the CLI with Palette. When prompted, enter the information listed in the following table. -
- ```shell palette login ``` @@ -279,304 +270,6 @@ To change the PCG install values, restart the installation process using the `pa palette pcg install --config-file /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml ``` - -
- - - - - -## PCG Installer Image - -### Prerequisites - -- Palette version 3.4.X or older. - - - -- Canonical [MAAS installed](https://maas.io/docs/how-to-install-maas), set up, and available in your environment. - - -- A Linux environment with a Docker daemon installed and a connection to Palette and the MAAS endpoint. The installer must be invoked on an up-to-date Linux system with an x86-64 architecture. ARM architecture is currently not supported. - - -- PCG IP address requirements:

- - - For a single-node gateway, one IP address must be available in the MaaS subnet for the PCG, or three available IP addresses for a three-node gateway. -
- - - One IP address must be available in the MAAS subnet for the Kubernetes api-server endpoint when deploying a three-node gateway. - - -- Sufficient available IPs within the configured MAAS subnets. - -:::caution - -By default, the MAAS Kubernetes pack uses a pod classless inter-domain routing (CIDR) range of 192.168.0.0/16. Ensure that the pod CIDR range for any clusters you deploy after setting up the PCG does not overlap with the network used by the bare metal machines that MAAS manages. - -::: - -- Each node in the PCG cluster requires a machine from MAAS in a ready state with the following resources: - -
- - - CPU: 4 - - Memory: 8192 MiB - - Storage: 60 GiB - - For production environments, we recommend using three nodes, each with 100 GiB of storage, as nodes can run out of 60 GiB with prolonged use. If you initially set up the gateway with one node, you can resize it at a later time. - - -- 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`` - - 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). - -
- -- The DNS server that the PCG installer will use, must be able to resolve the DNS names of machines that MAAS deploys so it can connect to them. The default setup is to use the MAAS server as the DNS server for any bare metal servers that it deploys. The default MAAS DNS zone is ``.maas``. You can use ``.maas`` or you can use the MAAS web console to create a new DNS zone. When you deploy the PCG and clusters, you can select the desired DNS zone in which DNS name records should be created. - - In the MAAS subnets configuration, you can specify which DNS servers those servers in the MAAS subnet should use. - -:::caution - -If you configure a different DNS server than the MAAS DNS server, you must be sure to create a DNS delegation in the other DNS server, so that it can forward DNS requests for zones that are hosted by MAAS to the MAAS DNS server. - -::: - -
- -The installer first requests machines from MAAS and then must connect to them. To connect, the installer attempts to use the fully qualified domain name (FQDN) of the server. If you used ``.maas`` as the default DNS zone, the FQDN would be ``machine-hostname.maas``. - -The diagram shows an example of using an external DNS server for servers that MAAS deploys in addition to a DNS delegation. This ensures all servers in the network can resolve the DNS names of servers deployed by MAAS. Note that it is not required for the DNS records to be accessible from the internet. - - -![Image showing external DNS server machines that MAAS deploys in addition to a DNS delegation](/clusters_maas_maas-dns-setup.png) - - -### Understand the Gateway Installation Process - -The following steps outline the overall process to install the PCG. - -For detailed steps, refer to the **Install PCG** section below, which describes a single-step installation that creates the PCG configuration file and installs the PCG. - -If you have already installed the PCG and are experiencing issues that you want to fix by editing the PCG configuration file directly, refer to the **Edit PCG Config** section below. - -
- -1. You obtain a pairing code in Palette that you will use later. - - -2. Use the Docker image to start the installation on the installer host. - - -3. The installer prompts you for information, including the pairing code you obtained in step **1**. - - -4. The installer generates the PCG configuration file from information you provide in step **3**. - -
- - The installer needs access to your Palette account and to your MAAS environment. Additionally, one (no HA) or three (HA) machines must be in ready state and have internet access in MAAS. If you select one machine in step 3, then you need one in MAAS. Likewise, if you select three machines in step 3, you need three in MAAS. -
- -5. The installer installs the MAAS machines and uses the configuration file to build a new cluster to host the PCG application. - -
- - - - -### Install the PCG - -The following steps will guide you to install the PCG. -
- -1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. - - -2. If you have Single or Social Sign-On (SSO) enabled, you will need to use or create a local non-SSO tenant admin account in Palette and use the credentials for that account in step **7**. - -:::caution - -The installer does not work with SSO or Social sign on credentials. You must use a username and password from a local tenant admin account in Palette to deploy the PCG. After the PCG is configured and functioning, this local account is no longer used to keep the PCG connected to Palette, so you can disable the account if desired. - -::: - - -3. Navigate to the **Main Menu** and select **Tenant Settings > Private Cloud Gateway**. - - -4. Click the **Create Private Cloud Gateway** button and select **MAAS**. Private Gateway installation instructions are displayed. - - -5. Note the pairing code displayed in the Instructions section of the page. You will input this code when you use the installer. This pairing code is valid for 24 hours. - - -6. To invoke the installer, copy the following code snippet to your terminal. -
- - ```bash - docker run -it --rm \ - --net=host \ - --volume /var/run/docker.sock:/var/run/docker.sock \ - --volume /tmp:/opt/spectrocloud \ - gcr.io/spectro-images-public/release/spectro-installer:v1.0.12 - ``` - -7. When prompted, enter the pairing code and information listed in each of the following tables. The installer will generate the gateway configuration file. -
- - -#### Palette Parameters - -|**Parameter** | **Description**| -|:-----------------------------|---------------| -|**Install Type**| Choose **Private Cloud Gateway**.
You can change your selection with the up or down keys.| -|**Cloud Type**| Choose MAAS.| -|**Name** | Enter a custom name for the PCG. Example: ``maas-pcg-1``.| -|**Endpoint** |Enter the Palette endpoint URL. When using the Palette SaaS service, enter ``https://console.spectrocloud.com``. When using a dedicated instance of Palette, enter the URL for that instance. | -|**Username** |Enter your Palette username. This is your sign-in email address. Example: ``user1@company.com``. | -|**Password** |Enter your Palette Password. This is your sign-in password.| -|**Pairing Code** |Enter the pairing code you noted from the instructions page in step **5**. | - -
- -#### Environment Configuration - - -|**Parameter**| **Description**| -|:-------------|----------------| -|**HTTPS Proxy (--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``.| -| **HTTP Proxy(--http_proxy)**| Leave this blank unless you are using an HTTP Proxy. This setting will be propagated to all PCG nodes and all of its cluster nodes. Example: ``http://USERNAME:PASSWORD@PROXYIP:PROXYPORT``.| -| **No Proxy(--no_proxy)**| The default is blank. You can add a comma-separated list of local network CIDR addresses, hostnames, and domain names that should be excluded from being a proxy. This setting will be propagated to all the nodes to bypass the proxy server. Example if you have a self-hosted environment: ``maas.company.com,10.10.0.0/16``.| -| **Pod CIDR (--pod_cidr)**|Enter the CIDR pool that will be used to assign IP addresses to pods in the PCG cluster. The pod IP addresses should be unique and not overlap with any machine IPs in the environment.| -| **Service IP Range (--svc_ip_range)**|Enter the IP address range that will be used to assign IP addresses to services in the PCG cluster. The service IP addresses should be unique and not overlap with any machine IPs in the environment.| - -
- - -#### MAAS Account Information - -|**Parameter**| **Description**| -|-------------|----------------| -| **API Endpoint** |Enter the MAAS API endpoint (syntax is important). This can be a domain or IP address. Example: ``http://10.11.12.13:5240/MAAS``.| -| **API Key** |Enter an active MAAS API key to use for authentication.| - -
- -1. When the installer prompts you, select the appropriate option for each of the following items to define which machines should be selected on the MAAS server for deployment as a PCG: - - - Domain - - Availability Zone - - Resource Pool - - One node (no HA) or three nodes (HA) - -
- - :::caution - - Ensure the MAAS server has one or more machines in the **Ready** state for the chosen availability zone - and resource pool combination. - - ::: - -When you have entered all the configuration values, the installer saves the gateway configuration file to disk and prints its location before proceeding with the installation. For example: - -``/tmp/install-user-defined-MaaS-Gateway_Name-20210805155034/pcg.yaml`` - -
- -:::info - -The **/opt/spectrocloud** folder is volume mapped to the installer's **/tmp** folder. - -::: - -The installer then requests available bare metal machines in your MAAS environment on which to install the gateway. The ``password`` and ``API key`` values in the ``pcg.yaml`` are encrypted and cannot be manually updated. To change these values, copy the code snippet in step **6** to rerun the installer. - -If the deployment fails due to misconfiguration, update the gateway configuration file and rerun the installer. Refer to the **Edit PCG Config** tab above. - -If you need assistance, please visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. - -
- -### Validate - -Once installed, the gateway registers itself with Palette. To verify the gateway is registered, navigate to **Tenant Settings > Private Cloud Gateways** and ensure the gateway is listed on the **Manage Private Cloud Gateways** page. - -When you install the gateway, a cloud account is auto-created. To verify the cloud account is created, go to **Tenant Settings > Cloud Accounts** and locate **MAAS** in the table. Verify your MAAS account is listed. - - - - -### Edit PCG Configuration File - -Use the following steps if you want to edit the PCG configuration file directly. - -
- -1. Copy the ``pcg.yaml`` file out of ``/tmp/install-user-defined-MaaS-Gateway_Name-20210805155034/pcg.yaml`` and into ``/tmp`` as follows. - - -```bash -cp /tmp/install-User-define-MaaS-Gateway-Name-20210805155034/pcg.yaml /tmp -``` - - -2. Make the necessary changes to the configuration file. - - -3. Before you redeploy the gateway, do the following: - -
- - - Ensure the pairing code in the configuration file is the same as the pairing code displayed in the installation instructions in Palette. To verify the pairing code, click the **Create Private Cloud Gateway** button and select **MAAS**. Note the pairing code and verify it is the same code in the configuration file. - -
- - - If the codes do not match, modify the code in the configuration file so it matches the code displayed in Palette. - -
- -:::caution - -Issues can occur with the PCG installation if the pairing code in Palette changes during the time it takes to modify the configuration file. Ensure pairing codes in Palette and the configuration file match before you redeploy the gateway. - -If you stop the installation or it fails due to mismatched pairing codes, the gateway might display as **Pending (unnamed)** on the **Private Cloud Gateways** page. If this happens, delete the gateway and ensure pairing codes in Palette and the configuration file match before redeploying the gateway. - -::: - -
- -4. To redeploy the gateway, copy the following code snippet to your terminal and provide the gateway configuration file as input. - - -```bash -docker run -it –rm \ -–net-host \ --v /var/run/docker.sock:/var/run/docker.sock \ --v /tmp:/opt/spectrocloud \ -gcr.io/spectro-images-public/release/spectro-installer:1.0.12 \ --s true \ --c /opt/spectrocloud/pcg.yaml -``` - -The installer requests available bare metal machines in your MAAS environment on which to install the gateway. - -If you need assistance, please visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. - - - -
- - - - - - - ## Update and Manage the PCG Palette maintains the Operating System (OS) image and all configurations for the PCG. Periodically, the OS images, configurations, and other components need to be updated to resolve security or functionality issues. Palette releases updates when required, and informs you with an update notification when you click on the gateway in the **Manage Cloud Gateways** page. diff --git a/docs/docs-content/clusters/data-center/openstack.md b/docs/docs-content/clusters/data-center/openstack.md index 0f381537b7..6cb27eb58a 100644 --- a/docs/docs-content/clusters/data-center/openstack.md +++ b/docs/docs-content/clusters/data-center/openstack.md @@ -357,14 +357,14 @@ The following prerequisites must be met before deploying a Kubernetes clusters i ## Installing Private Cloud Gateway - OpenStack -Use the following steps to install a PCG cluster in your OpenStack environment. You can use the [Palette CLI](../../palette-cli/palette-cli.md) or the PCG Installer Image to deploy a PCG cluster. Review the prerequisites for each option to help you identify the correct installation method. +Use the following steps to install a PCG cluster in your OpenStack environment. The [Palette CLI](../../palette-cli/palette-cli.md) will facilitate the deployment of a PCG cluster. +:::caution -
+Use the latest version of the Palette CLI that matches the version of your Palette or Palette VerteX instance. You can find the newest version of the Palette CLI on the [Downloads](../../spectro-downloads.md#palette-cli) page. - +::: - ### Prerequisites @@ -563,139 +563,6 @@ To change the PCG install values, restart the installation process using the `pa palette pcg install --config-file /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml ``` - - - - - - - - - - -## PCG Installer Image - -### Prerequisites - -The following system requirements are required to deploy a PCG cluster. - -- Palette version 3.4.X or older. - -- A Linux environment with a Docker daemon installed and a connection to Palette and the OpenStack environment. The installer must be invoked on an up-to-date Linux system with an x86-64 architecture. ARM architecture is currently not supported. - - -- Private Cloud Gateway IP requirements: - * One IP address for a single-node PCG or three IP addresses for a three-node PCG cluster. - * One IP address for the Kubernetes control plane. - - -### Generate pairing code - -Navigate to the Private Cloud Gateway page under Administration and Create a new OpenStack gateway. Copy the pairing code displayed on the page. This will be used in subsequent steps. - -### Generate gateway config - -Invoke the gateway installer in interactive mode to generate the gateway configuration file. Follow the prompts to provide the Palette Management, OpenStack cloud account, Environment and Placement information as requested. - -```bash -docker run -it --rm \ - --net=host \ - -v /var/run/docker.sock:/var/run/docker.sock \ - -v /tmp:/opt/spectrocloud \ - gcr.io/spectro-images-public/release/spectro-installer:1.0.12 \ - -o true -``` - -#### Enter Palette Management Information: - -|**Parameter**| **Description**| -|----------------------------------------|:----------------| -|**Palette Console** | Management Console endpoint e.g. https://console.spectrocloud.com| -|**Palette Username** | Login email address
e.g. user1@company.com| -|**Palette Password** | Login password| -|**Private Cloud Gateway pairing code**| The unique authentication code
generated in the previous step.| - -#### Enter Environment Configuration: - -| **Parameter** | **Description** | - |------------------------------------|----------------| - |**HTTPS Proxy(--https_proxy)**|The endpoint for the HTTPS proxy server. This setting will be
propagated to all the nodes launched in the proxy network.
e.g., http://USERNAME:PASSWORD@PROXYIP:PROXYPORT| - |**HTTP Proxy(--http_proxy)**|The endpoint for the HTTP proxy server. This setting will be
propagated to all the nodes launched in the proxy network.
e.g., http://USERNAME:PASSWORD@PROXYIP:PROXYPORT| - |**No Proxy(--no_proxy)** |A comma-separated list of local network CIDRs, hostnames,
domain names that should be excluded from proxying.
This setting will be propagated to all the nodes to bypass the proxy server.
e.g., maas.company.com,10.10.0.0/16| - |**Pod CIDR (--pod_cidr)**|The CIDR pool is used to assign IP addresses to pods in the cluster.
This setting will be used to assign IP
addresses to pods in Kubernetes clusters.
The pod IP addresses should be unique and
should notoverlap with any
Virtual Machine IPs in the environment.| - |**Service IP Range (--svc_ip_range)**|The IP address that will be assigned to
services created on Kubernetes. This setting will be used
to assign IP addresses to services in Kubernetes clusters.
The service IP addresses should be unique and not
overlap with any virtual machine IPs in the environment.| - -#### Enter OpenStack Account Information: - -|**Parameter** | **Description**| -|-----------------------------------------|----------------| -|**OpenStack Identity Endpoint** | OpenStack Identity endpoint. Domain or IP address.
e.g. https://openstack.mycompany.com/identity| -|**OpenStack Account Username** | OpenStack account username| -|**OpenStack Account Password** | OpenStack account password| -|**Default Domain** | Default OpenStack domain. e.g. Default| -|**Default Region** | Default OpenStack region. e.g. RegionOne| -|**Default Project** | Default OpenStack project. e.g. dev| - - -#### Enter OpenStack cluster configuration for the Private Cloud Gateway: - -1. Verify the following parameters: - * Default Domain - * Default Region - * Default Project - - -2. Enter the values for: - -|**Parameter** | **Description**| -|-----------------------------------------|----------------| - | **SSH Key** | Select a key.| - | **Placement option as Static or Dynamic** | For static placement, VMs are placed into existing
networks whereas, for dynamic placement, new network is created.| - | **Network** | Select an existing network. | - | **Sub Network** | Select a sub network.| - -#### Enter OpenStack Machine configuration for the Private Cloud Gateway: - -* Select the availability zone -* Choose flavor -* Number of nodes: Choose between **1** and **3** - -After this step, a new gateway configuration file is generated and its location is displayed on the console. -e.g.: Config created:/opt/spectrocloud//install-pcg-ar-dev-os-gw-02-aug-01-20210802062349/pcg.yaml - - -## Copy Configuration File - -Copy the pcg.yaml file to a known location for easy access and updates. - - -```bash -cp /tmp/install-pcg-xxx/pcg.yaml /tmp -``` - - -## Deploy Private Cloud Gateway - -Invoke the gateway installer in *silent mode*, providing the gateway config file as input to deploy the gateway. New VM(s) will be launched in your OpenStack environment and a gateway will be installed on those VM(s). If deployment fails due to misconfiguration, update the gateway configuration file and rerun the command. - -```bash -docker run -it --rm \ - --net=host \ - -v /var/run/docker.sock:/var/run/docker.sock \ - -v /tmp:/opt/spectrocloud \ - gcr.io/spectro-images-public/release/spectro-installer:1.0.12 \ - -s true \ - -c //opt/spectrocloud/pcg.yaml -``` - - - - - - - - - ## Upgrade PCG Palette maintains the OS image and all configurations for the PCG. Periodically, the OS images, configurations, or other components need to be upgraded to resolve security or functionality issues. Palette releases such upgrades when required and in an upgrade notification on the PCG. diff --git a/docs/docs-content/clusters/data-center/vmware.md b/docs/docs-content/clusters/data-center/vmware.md index b425c9589c..73ebd628d8 100644 --- a/docs/docs-content/clusters/data-center/vmware.md +++ b/docs/docs-content/clusters/data-center/vmware.md @@ -596,15 +596,18 @@ Palette downloads images and Open Virtual Appliance (OVA) files to the spectro-t ## Create VMware Cloud Gateway - + -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. +Use the Palette CLI to deploy a PCG cluster. Review the prerequisites for each option to help you identify the correct installation method. - +:::caution + +Use the latest version of the Palette CLI that matches the version of your Palette or Palette VerteX instance. You can find the newest version of the Palette CLI on the [Downloads](../../spectro-downloads.md#palette-cli) page. + +::: - ### Prerequisites @@ -838,145 +841,6 @@ To change the PCG install values, restart the installation process using the `pa palette pcg install --config-file /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml ``` - - - - - - -## PCG Install With OVA/OVF - - -The following points give an overview of what you will do to set up the PCG: - -
- - - Initiate the installation from the tenant portal. - - - - Deploy the gateway installer VM in VMware vSphere. - - - - Launch the cloud gateway from the tenant portal. - -:::info - -Self-hosted Palette installations provide a system gateway out-of-the-box and typically do not require a PCG. However, you can create additional gateways as needed to support provisioning into remote data centers that do not have a direct incoming connection from the management console. - -::: - - - - - -### Prerequisites - - -- Palette version 3.4.X or older. - - -- 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. - - 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. - -### Install PCG - -1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. - - -2. Navigate to the left **Main Menu** and select **Tenant Settings** > **Private Cloud Gateway**. - - -3. Click the **Create Private Cloud Gateway** button and select **VMware**. Private Gateway installation instructions are displayed. - - -4. Copy the gateway-installer link. Alternatively, you can download the OVA and upload it to an accessible location and import it as a local file. - - -### vSphere - Deploy Gateway Installer - -1. Deploy a new OVF template by providing the link to the installer OVA as the URL. - - -2. Proceed through the OVF deployment wizard, selecting the desired Name, Placement, Compute, Storage, and Network options. - - -3. At the **Customize Template** step, specify Palette properties as follows: - -
- -| **Parameter** | **Value** | **Description** | -|---|---|---| -|**Installer Name** | Desired Palette Gateway Name. | The name will be used to identify the gateway instance. Typical environments may only require a single gateway to be deployed. However, multiple gateways may be required to manage clusters across multiple vCenters. We recommend choosing a name that readily identifies the environment for which this gateway instance is being configured.| -| **Console endpoint** | URL to Palette management platform portal. | Default: https://console.spectrocloud.com | -|**Pairing Code** | PIN displayed on the Palette management platform portal's 'Create a new gateway' dialogue. | | -| **SSH Public Key** | Optional key for troubleshooting purposes. | We recommended having an SSH key, as it enables SSH access to the VM as 'ubuntu' user. | -| **Pod CIDR** | Optional IP range exclusive to pods. | This range should be different to prevent an overlap with your network CIDR. | -| **Service cluster IP range** | Optional IP range in the CIDR format exclusive to the service clusters. | This range also must not overlap with either the pod CIDR or your network CIDR. | - - -Proxy environments require additional property settings. Each of the proxy properties may or may not have the same value but all the three properties are required. - - -| **Parameter** | **Value** | **Remarks** | -|---|---|---| -|HTTP PROXY | Endpoint for the HTTP proxy server. | This setting will be propagated to all the nodes launched in the proxy network. For example: `http://USERNAME:PASSWORD@PROXYIP:PROXYPORT` | -| HTTPS PROXY | Endpoint for the HTTPS proxy server. | This setting will be propagated to all the nodes launched in the proxy network. For example: `http://USERNAME:PASSWORD@PROXYIP:PROXYPORT` | -| NO Proxy | A comma-separated list of vCenter server, local network CIDR, hostnames, and domain names that should be excluded from proxying. | This setting will be propagated to all the nodes to bypass the proxy server. For example: `vcenter.company.com`, `.company.org`, and `10.10.0.0/16` | -| Certificate | The base64-encoded value of the proxy server's certificate OR the base64-encoded root and issuing certificate authority (CA) certificates used to sign the proxy server's certificate. | Depending on how the certificate is decoded, an additional `=` character may appear at the end of the value. You can use this command to properly encode the certificate: `base64 -w0 | sed "s/=$//"`. - -4. Complete the OVF deployment wizard and wait for the OVA to be imported and the Virtual Machine (VM) to be deployed. - - -5. Power on the VM. - - -## Tenant Portal - Launch Cloud Gateway - -1. Close the **Create New Gateway** installation instructions and navigate to the Private Cloud Gateway page under **Tenant Settings** if you have navigated away or logged out. - - -2. Wait for a gateway widget to display on the page and for the **Configure** option to become available. The IP address of the installer VM will be displayed on the gateway widget. This may take a few minutes after the VM is powered on. Failure of the installer to register with Palette within 10 minutes of powering on the Virtual Machine on vSphere might indicate an error. Follow steps in [Troubleshooting](../../troubleshooting/pcg.md) to identify and resolve the issue. - - -3. Click on the **Configure** button to invoke the Palette Configuration dialogue. Provide vCenter credentials and proceed to the next configuration step. - - -4. Choose the desired values for the Data Center, Compute Cluster, Datastore, Network, Resource pool, and Folder. Optionally, provide one or more SSH Keys or NTP server addresses. - -
- - Virtual machine port groups and distributed port groups are listed with their names. NSX-T distributed virtual port groups that exist in vSphere will be listed with their name and segment IDs. - - -5. Choose the IP Allocation Scheme - Static IP or DHCP. Selecting static IP enables the option to create an IP pool. To create an IP pool, provide an IP range or a subnet. The IP addresses from the IP pool will be assigned to the gateway cluster. By default, the IP pool is available for use by other tenant clusters. You can prevent this by toggling on the **Restrict to a single cluster** option. - - - - -6. Click on **Confirm** to initiate gateway cluster provisioning. Cluster status should change to **Provisioning** and eventually to **Running**, when the gateway cluster is fully provisioned. This process can take about 10 minutes. - - You can click on the Cloud Gateway widget in the UI to view a detailed provisioning sequence on the **Cluster Details** page. If gateway cluster provisioning results in errors or gets stuck, you can view the details on the **Summary** tab or the **Events** tab of the **Cluster Details** page. - - In certain cases where provisioning of the gateway cluster is stuck or failed due to invalid configuration, you can reset the process from the Cloud Gateway widget. - - -7. When the Gateway transitions to the **Running** state, it is fully provisioned and ready to bootstrap tenant cluster requests. - - -8. Power off the installer OVA that you initially imported at the start of this installation process. - -:::info - -A Gateway cluster installation automatically creates a cloud account using the credentials entered at the time the gateway cluster is deployed. You can use this account to provision clusters across all tenant projects. - -::: - - - - - --- ## Upgrade PCG diff --git a/docs/docs-content/palette-cli/commands/pcg.md b/docs/docs-content/palette-cli/commands/pcg.md index 7163a8e8e7..730f9bb9ba 100644 --- a/docs/docs-content/palette-cli/commands/pcg.md +++ b/docs/docs-content/palette-cli/commands/pcg.md @@ -32,6 +32,14 @@ Use the `install` subcommand to install a PCG cluster in the following environme | `-i` | `--inspect-only` | Validate prerequisites for environment. Do not proceed with installation. | boolean | +:::caution + +Use the latest version of the Palette CLI that matches the version of your Palette or Palette VerteX instance. You can find the newest version of the Palette CLI on the [Downloads](../../spectro-downloads.md#palette-cli) page. + +::: + + + ### Supported Environments You can use the `install` subcommand to install a PCG cluster in the following environments.