From 6a351391e2ead778170759cbbf5e907baa2d67d1 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Wed, 19 Jul 2023 10:49:02 -0700 Subject: [PATCH] docs: added Palette CLI subcommand (#1421) * docs: added Palette CLI subcommand * docs: updated openstack and VMware * Apply suggestions from code review Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> * docs: updated the CLI steps * chore: updates * docs: updated MAAS section to include former method * docs: updated the VMware section * docs: minor touches * docs: PLT-452 updated install command * docs: final touches * Apply suggestions from code review Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> * docs: updated pr feedback * docs: vale feedback --------- Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> --- .../01-maas/05-install-manage-maas-pcg.md | 280 +++++++++++++++++- .../02-data-center/02-openstack.md | 264 ++++++++++++++++- .../04-clusters/02-data-center/03-vmware.md | 276 ++++++++++++++++- .../10-install-palette-cli.md | 10 +- content/docs/12.5-palette-cli/20-commands.md | 109 ++++++- 5 files changed, 882 insertions(+), 57 deletions(-) diff --git a/content/docs/04-clusters/02-data-center/01-maas/05-install-manage-maas-pcg.md b/content/docs/04-clusters/02-data-center/01-maas/05-install-manage-maas-pcg.md index 200a60206e..0f2889ecb2 100644 --- a/content/docs/04-clusters/02-data-center/01-maas/05-install-manage-maas-pcg.md +++ b/content/docs/04-clusters/02-data-center/01-maas/05-install-manage-maas-pcg.md @@ -21,13 +21,13 @@ At a high level, the following occurs during a successful MAAS PCG installation:
-- Start the PCG installer on a laptop, workstation, or Bastion host. +- Use the Palette CLI on a laptop, workstation, or Bastion host. -- Provide information to the installer so that it can connect both to a local MAAS installation and a Palette account. +- Provide information to the CLI so that it can connect to both a local MAAS installation and a Palette account. -- The installer uses MAAS to obtain machines and install a PCG on them. +- The installation process uses MAAS to obtain machines and install a PCG on them. - The PCG then facilitates all communication between Palette and MAAS, enabling Palette to create new clusters on machines that MAAS provides. @@ -43,18 +43,271 @@ As the following diagram shows, Palette provides an installer in the form of a D ![An architecture diagram of MaaS with PCG.](/clusters_maas_install-manage-mass-pcg_diagram-of-mass-with-pcg.png) +# Install PCG + +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 + + +- Palette version 4.0.X or greater. + + +- 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#palettecli) page and install the CLI. Refer to the [Palette CLI Install](/palette-cli/install-palette-cli) guide to learn more. + + +- A Palette API key. Refer to the [Create API Key](/user-management/user-authentication#apikey) page for guidance. + +
+ + + + The installation does not work with Single Sign-On (SSO) credentials. You must use an API key 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. + + + +- A Linux environment with a Docker daemon installed and a connection to Palette and the MAAS endpoint. The installation 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. + -The installer does not work on Apple Mac operating systems with Apple silicon chips. +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 exhaust the 60 GiB storage 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) 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. + + + +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 installation process first requests machines from MAAS and then must connect to them. To connect, the install process 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) + + +## Install + +The following steps will guide you on how to install a PCG cluster. +
+ +1. In an x86 Linux host, open up a terminal session. + + +2. Use the [Palette CLI](/palette-cli/install-palette-cli) `login` command to authenticate the CLI with Palette. When prompted, enter the information listed in the following table. + +
+ + ```shell + palette login + ``` + +
+ + |**Parameter** | **Description**| + |:-----------------------------|---------------| + |**Spectro Cloud Console** |Enter the Palette endpoint URL. When using the Palette SaaS service, enter ``https://console.spectrocloud.com``. When using a self-hosted instance of Palette, enter the URL for that instance. | + |**Allow Insecure Connection** |Enabling this option bypasses x509 verification. Enter `y` if you are using a self-hosted Palette instance with self-signed TLS certificates. Otherwise, enter `n`.| + |**Spectro Cloud API Key** |Enter your Palette API Key.| + |**Spectro Cloud Organization** |Enter your Palette Organization name.| + |**Spectro Cloud Project** |Enter your desired project name within the selected Organization.| + + +3. Once you have authenticated successfully, invoke the PCG installer by issuing the following command. When prompted, enter the information listed in each of the following tables. + +
+ + ```bash + palette pcg install + ``` + +
+ + |**Parameter** | **Description**| + |:-----------------------------|---------------| + |**Cloud Type**| Choose OpenStack.| + |**Private Cloud Gateway Name** | Enter a custom name for the PCG. Example: `openstack-pcg-1`.| + |**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.| + + + +4. Next, provide environment configurations for the cluster. Refer to the following table for information about each option. + +
+ + |**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``.| + |**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**|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``.| + |**Proxy CA Certificate Filepath**|The default is blank. You can provide the file path of a CA certificate on the installer host. If provided, this CA certificate will be copied to each host in the PCG cluster during deployment. The provided path will be used on the PCG cluster hosts. Example: `/usr/local/share/ca-certificates/ca.crt`.| + |**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**|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.|.| + +
+ + +5. After the environment options, the next set of prompts is for configuring the PCG cluster for the MAAS environment. The following table contains information about each prompt. + +
+ + |**Parameter**| **Description**| + |-------------|----------------| + | **MAAS API Endpoint** |Enter the MAAS API endpoint. This can be a domain or IP address. Example: `http://10.11.12.13:5240/MAAS`.| + | **MAAS API Key** |Enter an active MAAS API key to use for authentication.| + + + +6. Next, 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. + +
+ + |**Parameter**| **Description**| + |-------------|----------------| + | **Domain** | Select the MAAS domain. | + | **Patch OS on boot** | This parameter indicates whether or not to patch the OS of the PCG hosts on the first boot.| + | **Reboot nodes once OS patch is applied** | This parameter indicates whether or not to reboot PCG nodes after OS patches are applied.| + | **Availability Zone** | Select the availability zones for the PCG cluster. | + | **Resource Pool** | Select the MAAS resource pool. | + | **Cluster Size** | The number of nodes that will make up the cluster. Available options are **1** or **3** . Use three nodes for a High Availability (HA) cluster. | | + + + + Ensure the MAAS server has one or more machines in the **Ready** state for the chosen availability zone + and resource pool combination. + + + + +7. A new PCG configuration file is generated and its location is displayed on the console. You will receive an output similar to the following. + +
+ + ```bash hideClipboard + ==== PCG config saved ==== + Location: :/home/spectro/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + + The ``CloudAccount.apiKey`` and ``Mgmt.apiKey`` values in the **pcg.yaml** are encrypted and cannot be manually updated. To change these values, restart the installation process using the `palette pcg install` command. + + + + +The Palette CLI will now provision a PCG cluster in your OpenStack environment. +If the deployment fails due to misconfiguration, update the PCG configuration file and restart the install process. Refer to the Edit and Redeploy PCG section below. For additional assistance, visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. + +## Validate + +Once installed, the PCG registers itself with Palette. To verify the PCG is registered, use the following steps. + + +1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. + + +2. Navigate to the left **Main Menu** and select **Tenant Settings** + + +3. From the **Tenant Settings Menu** click on **Private Cloud Gateways**. Verify your PCG cluster is available from the list of PCG clusters displayed. + + +4. When you install the PCG, 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 and Redeploy PCG + +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. + +
+ +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. + +
+ + ```shell hideClipboard + ==== Create PCG reference config ==== + ==== PCG config saved ==== + Location: /Users/demo/.palette/pcg/pcg-20230717114807/pcg.yaml + ``` + + ```bash hideClipboard + vi /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + +2. To redeploy the PCG, use the `install` command with the flags `--silent` and `--config-file`. Provide the file path to the generated PCG config file that was generated and displayed in the output. + +
+ + ```bash hideClipboard + palette pcg install --silent --config-file /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + +
+ + + + ## 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. @@ -120,9 +373,9 @@ The diagram shows an example of using an external DNS server for servers that MA The following steps outline the overall process to install the PCG. -For detailed steps, refer to the **Install PCG** tab below, which describes a single-step installation that creates the PCG configuration file and installs 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** tab. +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.
@@ -147,9 +400,6 @@ If you have already installed the PCG and are experiencing issues that you want
- - - ## Install the PCG @@ -272,9 +522,7 @@ Once installed, the gateway registers itself with Palette. To verify the gateway 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 @@ -333,13 +581,17 @@ The installer requests available bare metal machines in your MAAS environment on If you need assistance, please visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. - -
-# Update and Manage the MAAS Gateway + + + + + + +# 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/content/docs/04-clusters/02-data-center/02-openstack.md b/content/docs/04-clusters/02-data-center/02-openstack.md index e71f9f94da..eb8dcb0f5a 100644 --- a/content/docs/04-clusters/02-data-center/02-openstack.md +++ b/content/docs/04-clusters/02-data-center/02-openstack.md @@ -16,13 +16,14 @@ import PointsOfInterest from 'shared/components/common/PointOfInterest'; Following are some highlights of OpenStack clusters provisioned by Palette: -1. Palette provides public cloud like experience to deploying clusters on OpenStack. +1. Palette enables the ability to use OpenStack as an application platform for engineering team. -2. In order to facilitate communication between the Palette management platform and the OpenStack controllers installed in the private data center, a Private Cloud Gateway needs to be set up within the environment. +2. To facilitate communication between Palette and the OpenStack controllers installed in the private data center, a Private Cloud Gateway (PCG) must be set up within the environment. -3. Private Cloud Gateway(PCG) is Palette's on-premesis component to enable support for isolated private cloud or data center environments. Palette Gateway, once installed on-premesis registers itself with Palette's SaaS portal and enables secure communication between the SaaS portal and private cloud environment. The gateway enables installation and end-to-end lifecycle management of Kubernetes clusters in private cloud environments from Palette's SaaS portal. + +3. Private Cloud Gateway (PCG) is Palette's self-hosted component to support isolated private cloud or data center environments. Once installed, the PCG registers itself with Palette's SaaS portal and enables secure communication between the SaaS portal and the private cloud environment. The PCG enables installation and end-to-end lifecycle management of Kubernetes clusters in private cloud environments from Palette's SaaS portal. ![openstack_cluster_architecture.png](/openstack_cluster_architecture.png) @@ -46,7 +47,7 @@ The following prerequisites must be met before deploying a Kubernetes clusters i 5. You should have an Infrastructure cluster profile created in Palette for OpenStack. -6. You should install a Private Cloud Gateway for OpenStack as described in the "**Installing Private Cloud Gateway - OpenStack**" section below. Installing the Private Cloud Gateway will automatically register a cloud account for OpenStack in Palette. You can register your additional OpenStack cloud accounts in Palette as described in the "**Creating a OpenStack Cloud account**" section below. +6. Install a Private Cloud Gateway for OpenStack as described in the **Installing Private Cloud Gateway - OpenStack** section below. Installing the Private Cloud Gateway will automatically register a cloud account for OpenStack in Palette. You can register your additional OpenStack cloud accounts in Palette as described in the **Creating a OpenStack Cloud account** section below. 7. Egress access to the internet (direct or via proxy): @@ -361,7 +362,30 @@ The following prerequisites must be met before deploying a Kubernetes clusters i # Installing Private Cloud Gateway - OpenStack - `video: title: "openstack-pcg-creation": /pcg-creation-video/openstack.mp4` + +Use the following steps to install a PCG cluster in your OpenStack 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 installation method. + + +
+ + + + + + +## Prerequisites + + +The following system prerequisites are required to install an OpenStack PCG. + +- Palette version 4.0.X or greater. + + +- A Palette API key. Refer to the [Create API Key](/user-management/user-authentication#apikey) page for guidance. + + +- Download the Palette CLI from the [Downloads](/spectro-downloads#palettecli) page and install the CLI. Refer to the [Palette CLI Install](/palette-cli/install-palette-cli) guide to learn more. + The following system requirements should be met in order to install a private cloud gateway for OpenStack: @@ -371,6 +395,206 @@ The following system requirements should be met in order to install a private cl Palette provides an installer in the form of a docker container. This installer can be run on any system that has docker daemon installed and has connectivity to the Palette Management console as well as OpenStack controller. + - One additional Kubernetes control plane IP address for rolling upgrades. + + +- A Linux x86-64 host with the Docker daemon installed. + + + + +## Install PCG + + +1. In an x86 Linux host, open up a terminal session. + + + +2. Use the Palette CLI `login` command to authenticate the CLI with Palette. When prompted, enter the information listed in the following table + +
+ + ```shell + palette login + ``` + +
+ + |**Parameter** | **Description**| + |:-----------------------------|---------------| + |**Spectro Cloud Console** |Enter the Palette endpoint URL. When using the Palette SaaS service, enter ``https://console.spectrocloud.com``. When using a self-hosted instance of Palette, enter the URL for that instance. | + |**Allow Insecure Connection** |Enabling this option bypasses x509 verification. Enter `y` if you are using a self-hosted Palette instance with self-signed TLS certificates. Otherwise, enter `n`.| + |**Spectro Cloud API Key** |Enter your Palette API Key.| + |**Spectro Cloud Organization** |Enter your Palette Organization name.| + |**Spectro Cloud Project** |Enter your desired project name within the selected Organization.| + + +3. Once you have authenticated successfully, invoke the PCG installer by issuing the following command. When prompted, enter the information listed in each of the following tables. + +
+ + ```bash + palette pcg install + ``` + +
+ + |**Parameter** | **Description**| + |:-----------------------------|---------------| + |**Cloud Type**| Choose OpenStack.| + |**Private Cloud Gateway Name** | Enter a custom name for the PCG. Example: `openstack-pcg-1`.| + |**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.| + + +4. Next, provide environment configurations for the cluster. Refer to the following table for information about each option. + +
+ + |**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`.| + |**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**|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: `my.company.com,10.10.0.0/16`.| + |**Proxy CA Certificate Filepath**|The default is blank. You can provide the file path of a CA certificate on the installer host. If provided, this CA certificate will be copied to each host in the PCG cluster during deployment. The provided path will be used on the PCG cluster hosts. Example: `/usr/local/share/ca-certificates/ca.crt`.| + |**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**|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.| + + + +5. After the environment options, the next set of prompts is for configuring the PCG cluster for the OpenStack environment. The following table contains information about each prompt. + +
+ + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + |**OpenStack Identity Endpoint** | OpenStack Identity endpoint. Domain or IP address.
Example: `https://openstack.mycompany.com/identity`.| + |**OpenStack Account Username** | OpenStack account username.| + |**OpenStack Account Password** | OpenStack account password.| + |**Allow Insecure Connection** |Enabling this option bypasses x509 verification. Enter `y` if you are using an OpenStack instance with self-signed TLS certificates. Otherwise, enter `n`.| + |**CA Certificate** |This is only required when using TLS, in which case you would provide a base64-encoded CA certificate for your OpenStack instance. | + +6. Next, fill out additional OpenStack configurations. + +
+ + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + | **Default Domain** | OpenStack Domain. Example: `Default`.| + | **Default Region** | OpenStack Region. Example: `RegionOne`.| + | **Default Project** | OpenStack Project. Example: `dev`.| + | **Placement Type** | Placement can be static or dynamic. For static placement, VMs are placed into existing networks. For dynamic placement, a new network is created.| + | **Network** | Select an existing network. This is only required for static placement.| + | **Subnet** | Select an existing subnet. This is only required for static placement.| + | **DNS Server(s)** | Enter a comma-separated list of DNS server IPs . This is only required for dynamic placement.| + | **Node CIDR** | Enter a node CIDR. This is only required for dynamic placement. Example: `10.55.0.0/24`.| + | **SSH Public Key** | Provide the public OpenSSH key for the PCG cluster. Use this key when establishing an SSH connection with the PCG cluster. This prompt will result in the default text editor for the Operating System to open. Vi is the more common text editor used in Linux environments.| + | **Patch OS on boot** | This parameter indicates whether or not to patch the OS of the PCG hosts on the first boot.| + | **Reboot nodes once OS patch is applied** | This parameter indicates whether or not to reboot PCG nodes after OS patches are complete. This only applies if the **Patch OS on boot** parameter is enabled.| + + +7. Configure the OpenStack PCG Machine by answering the following prompts. + +
+ + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + | **Availability Zone** | Select the availability zone. | + | **PCG Cluster Size** | Select the node size of the PCG cluster. You can choose between **1** node or **3** nodes for High Availability (HA). | + + +8. A new PCG configuration file is generated and its location is displayed on the console. You will receive an output similar to the following. + +
+ + ```bash hideClipboard + ==== PCG config saved ==== + Location: :/home/spectro/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + + The `CloudAccount.apiKey` and `Mgmt.apiKey` values in the **pcg.yaml** are encrypted and cannot be manually updated. To change these values, restart the installation process using the `palette pcg install` command. + + + +
+ +The Palette CLI will now provision a PCG cluster in your OpenStack environment. +If the deployment fails due to misconfiguration, update the PCG configuration file and rerun the installer. Refer to the [Edit and Redeploy PCG](/clusters/data-center/openstack#editandredeploypcg) section below. For additional assistance, visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. + + + +## Validate + +Once installed, the PCG registers itself with Palette. To verify the PCG is registered, use the following steps. + + +1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. + + +2. Navigate to the left **Main Menu** and select **Tenant Settings** + + +3. From the **Tenant Settings Menu** click on **Private Cloud Gateways**. Verify your PCG cluster is available from the list of PCG clusters displayed. + + +4. When you install the PCG, a cloud account is auto-created. To verify the cloud account is created, go to **Tenant Settings > Cloud Accounts** and locate **OpenStack** in the table. Verify your OpenStack account is listed. + + + +## Edit and Redeploy PCG + +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. + +
+ +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. + +
+ + ```shell hideClipboard + ==== Create PCG reference config ==== + ==== PCG config saved ==== + Location: /Users/demo/.palette/pcg/pcg-20230717114807/pcg.yaml + ``` + + ```bash hideClipboard + vi /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + +2. To redeploy the PCG, use the `install` command with the flags `--silent` and `--config-file`. Provide the file path to the generated PCG config file that was generated and displayed in the output. + +
+ + ```bash hideClipboard + palette pcg install --silent --config-file /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + + + + + + + `video: title: "openstack-pcg-creation": /pcg-creation-video/openstack.mp4` + + + +## 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 @@ -379,14 +603,14 @@ Navigate to the Private Cloud Gateway page under Administration and Create a new ## Generate gateway config -Invoke 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. +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.9 \ + gcr.io/spectro-images-public/release/spectro-installer:1.0.12 \ -o true ``` @@ -467,20 +691,28 @@ 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.9 \ + gcr.io/spectro-images-public/release/spectro-installer:1.0.12 \ -s true \ -c //opt/spectrocloud/pcg.yaml ``` -## Upgrading an OpenStack cloud gateway -Palette maintains the OS image and all configurations for the cloud gateway. 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 communication about the same is presented in the form of an upgrade notification on the gateway. + + + + + + + + +## 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. -Administrators should review the changes and apply them at a suitable time. Upgrading a cloud gateway does not result in any downtime for the tenant clusters. During the upgrade process, the provisioning of new clusters might be temporarily unavailable. New cluster requests are queued while the gateway is being upgraded, and are processed as soon as the gateway upgrade is complete. +Administrators should review the changes and apply them at a suitable time. Upgrading a PCG does not result in any downtime for the tenant clusters. During the upgrade process, the provisioning of new clusters might be temporarily unavailable. New cluster requests are queued while the PCG is being upgraded and are processed as soon as the PCG upgrade is complete. -## Deleting an OpenStack cloud gateway -The following steps need to be performed to delete a cloud gateway: +## Delete the PCG +The following steps need to be performed to delete a PCG: -1. As a Tenant administrator, navigate to the Private Cloud Gateway page under settings. +1. As a tenant admin, navigate to the Private Cloud Gateway page under settings. 2. Invoke the **Delete** action on the cloud gateway instance that needs to be deleted. @@ -495,8 +727,8 @@ The following steps need to be performed to delete a cloud gateway: The delete gateway operation deletes the gateway instance registered in the management console, however the gateway infrastructure such as Load Balancers, VMs, Networks (if dynamic provision was chosen), etc. need to be deleted on the OpenStack console -## Resizing an OpenStack gateway -A cloud gateway can be set up as a 1-node or a 3-node cluster. For production environments, it is recommended that 3 nodes are set up. A cloud gateway can be initially set up with 1 node and resized to 3 nodes at a later time. The following steps need to be performed to resize a 1-node cloud gateway cluster to a 3-node gateway cluster: +## Resize the PCG +You can set up the PCG as a single-node or three-node cluster for high availability (HA). For production environments, we recommend three nodes. A PCG can be initially set up with one node and resized to three nodes later. Use the following steps to resize a single-node PCG cluster to a three-node PCG cluster. 1. As a tenant administrator, navigate to the Private Cloud Gateway page under settings. diff --git a/content/docs/04-clusters/02-data-center/03-vmware.md b/content/docs/04-clusters/02-data-center/03-vmware.md index a33f14701d..f799962563 100644 --- a/content/docs/04-clusters/02-data-center/03-vmware.md +++ b/content/docs/04-clusters/02-data-center/03-vmware.md @@ -615,19 +615,244 @@ Palette downloads images and Open Virtual Appliance (OVA) files to the spectro-t `video: title: "vsphere-pcg-creation": /pcg-creation-video/vmware.mp4` +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. +
-You can set up the PCG as a single- or three-node cluster based on your requirements for high availability (HA). The minimum capacity required for a PCG are: + + + + + +## Prerequisites + + +- Palette version 4.0.X or greater. + + +- A Palette API key. Refer to the [Create API Key](/user-management/user-authentication#apikey) page for guidance. + + +- Download the Palette CLI from the [Downloads](/spectro-downloads#palettecli) page and install the CLI. Refer to the [Palette CLI Install](/palette-cli/install-palette-cli) guide to learn more. + +- 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. + +- Sufficient available IP addresses within the configured OpenStack subnets. + + + + +Self-hosted Palette installations provide a system 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 management console. + + + +## Install PCG + +1. In an x86 Linux host, open up a terminal session. + + +2. Use the Palette CLI `login` command to authenticate the CLI with Palette. When prompted, enter the information listed in the following table + +
+ + ```shell + palette login + ``` + +
+ + |**Parameter** | **Description**| + |:-----------------------------|---------------| + |**Spectro Cloud Console** |Enter the Palette endpoint URL. When using the Palette SaaS service, enter `https://console.spectrocloud.com`. When using a self-hosted instance of Palette, enter the URL for that instance. | + |**Allow Insecure Connection** |Enabling this option bypasses x509 verification. Enter `y` if you are using a self-hosted Palette instance with self-signed TLS certificates. Otherwise, enter `n`.| + |**Spectro Cloud API Key** |Enter your Palette API Key.| + |**Spectro Cloud Organization** |Enter your Palette Organization name.| + |**Spectro Cloud Project** |Enter your desired project name within the selected Organization.| + + + +3. Once you have authenticated successfully, invoke the PCG installer by issuing the following command. When prompted, enter the information listed in each of the following tables. + +
+ + ```bash + palette pcg install + ``` + +
+ + |**Parameter** | **Description**| + |:-----------------------------|---------------| + |**Cloud Type**| Choose OpenStack.| + |**Private Cloud Gateway Name** | Enter a custom name for the PCG. Example: ``openstack-pcg-1``.| + |**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.| + + +4. Next, provide environment configurations for the cluster. Refer to the following table for information about each option. +
+ |**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`.| + |**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**|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: `my.company.com,10.10.0.0/16`.| + |**Proxy CA Certificate Filepath**|The default is blank. You can provide the file path of a CA certificate on the installer host. If provided, this CA certificate will be copied to each host in the PCG cluster during deployment. The provided path will be used on the PCG cluster hosts. Example: `/usr/local/share/ca-certificates/ca.crt`.| + |**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**|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.| + + + + +5. After the environment options, the next set of prompts is for configuring the PCG cluster for the VMware environment. The following table contains information about each prompt. + +
+ + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + |**vSphere Endpoint** | vSphere endpoint: FQDN or IP address, without the HTTP scheme `https://` or `http://`.
Example: `vcenter.mycompany.com`| + |**vSphere Username** | vSphere account username.| + |**vSphere Password** | vSphere account password.| + |**Allow Insecure Connection** |Enabling this option bypasses x509 verification. Enter `y` if using a vSphere instance with self-signed TLS certificates. Otherwise, enter `n`.| + + +6. Next, fill out VMware account configurations. Specify values for the following properties. + +
+ + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + | **Datacenter** | The data center to target.| + | **Folder**| The folder to target.| + | **Fault Domains**| Specify any fault domains you would like to use.| + | **Cluster**| The compute cluster to use for the PCG deployment.| + | **Network**| The network the PCG cluster will use. | + | **Resource Pool** | The resource pool to target when deploying the PCG cluster.| + | **Storage Type**| Select the datastore and VM Storage policy to apply to the PCG cluster. | + | **NTP Servers**| Specify the IP address for any Network Time Protocol (NTP) servers the PCG cluster can reference.| + | **SSH Public Keys**| Provide the public OpenSSH key for the PCG cluster. Use this key when establishing an SSH connection with the PCG cluster. This prompt will result in the default text editor for the Operating System to open. Vi is the more common text editor used in Linux environments. | + | **Cluster Size** | The number of nodes that will make up the cluster. Available options are **1** or **3** . Use three nodes for a High Availability (HA) cluster. | + + + +7. Specify IP Pool configuration. You have the option to select a static placement or use Dynamic Domain Name Service (DDNS). With static placement, an IP pool is created and the VMs are assigned IP addresses from the selected pool. With DDNS, VMs are assigned IP addresses via DNS. Review the following tables to learn more about each parameter. + +
+ + ##### Static Placement Configuration + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + | **IP Start range** | Enter the first address in the PCG IP pool range.| + | **IP End range** | Enter the last address in the PCG IP pool range.| + | **Network Prefix** | Enter the network prefix for the IP pool range. Valid values are network CIDR subnet masks from the range `0 - 32`. Example: `18`.| + | **Gateway IP Address** | Enter the IP address of the static IP gateway.| + | **Name servers** | Comma-separated list of DNS name server IP addresses.| + | **Name server search suffixes (optional)** | Comma-separated list of DNS search domains.| + + ##### DDNS Placement Configuration + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + | **Search domains** | Comma-separated list of DNS search domains.| + + +8. Specify the cluster boot configuration. + +
+ + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + | **Patch OS on boot** | This parameter indicates whether or not to patch the OS of the PCG hosts on the first boot.| + | **Reboot nodes once OS patch is applied** | This parameter indicates whether or not to reboot PCG nodes after OS patches are complete. This only applies if the **Patch OS on boot** parameter is enabled.| + + + + +9. Enter the vSphere Machine configuration for the Private Cloud Gateway. + +
+ + |**Parameter** | **Description**| + |-----------------------------------------|----------------| + | **CPU** | The number of CPUs in the Virtual Machine. | + | **Memory** | The number of memory to allocate to the Virtual Machine.| + | **Storage** | The amount of storage to allocate to the Virtual Machine. | + +10. A new PCG configuration file is generated and its location is displayed on the console. You will receive an output similar to the following. + +
+ + ```bash hideClipboard + ==== PCG config saved ==== + Location: :/home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + + The ``CloudAccount.apiKey`` and ``Mgmt.apiKey`` values in the **pcg.yaml** are encrypted and cannot be manually updated. To change these values, restart the installation process using the `palette pcg install` command. + + + +The Palette CLI will now provision a PCG cluster in your VMware environment. +If the deployment fails due to misconfiguration, update the PCG configuration file and restart the installer. Refer to the [Edit and Redeploy PCG](/clusters/data-center/vmware#editandredeploypcg) section below. For additional assistance, visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. + + +## Validate + +Once installed, the PCG registers itself with Palette. To verify the PCG is registered, use the following steps. + + +1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. + + +2. Navigate to the left **Main Menu** and select **Tenant Settings** + + +3. From the **Tenant Settings Menu** click on **Private Cloud Gateways**. Verify your PCG cluster is available from the list of PCG clusters displayed. + + +## Edit and Redeploy PCG + +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. + +
+ +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. + +
+ + ```shell hideClipboard + ==== Create PCG reference config ==== + ==== PCG config saved ==== + Location: /Users/demo/.palette/pcg/pcg-20230717114807/pcg.yaml + ``` + + ```bash hideClipboard + vi /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + +2. To redeploy the PCG, use the `install` command with the flags `--silent` and `--config-file`. Provide the file path to the generated PCG config file that was generated and displayed in the output. + +
+ + ```bash hideClipboard + palette pcg install --silent --config-file /home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml + ``` + + + + + + + The following points give an overview of what you will do to set up the PCG: @@ -636,7 +861,7 @@ 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 vSphere. + - Deploy the gateway installer VM in VMware vSphere. - Launch the cloud gateway from the tenant portal. @@ -647,14 +872,26 @@ Self-hosted Palette installations provide a system gateway out-of-the-box and ty -
-## Tenant Portal - Initiate Install +`video: title: "vsphere-pcg-creation": /pcg-creation-video/vmware.mp4` + +## 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 **Tenant Settings** > **Private Cloud Gateway**. +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. @@ -663,8 +900,6 @@ Self-hosted Palette installations provide a system gateway out-of-the-box and ty 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. @@ -740,8 +975,18 @@ A Gateway cluster installation automatically creates a cloud account using the c + + + + + +
+ +--- + -### Upgrade VMware Cloud Gateway + +# Upgrade PCG Palette maintains the OS image and all configurations for the cloud gateway. 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 communication about the same is presented in the form of an upgrade notification on the gateway. @@ -757,19 +1002,18 @@ The following steps need to be performed to delete a cloud gateway: 1. As a Tenant Administrator, navigate to the **Private Cloud Gateway** page under **Settings**. -2. Invoke the **Delete** action on the cloud gateway instance that needs to be deleted. +2. Invoke the **Delete** action on the PCG instance you want to delete. -3. The system performs a validation to ensure there are no running tenant clusters associated with the gateway instance being deleted. If such instances are found, the system presents an error. Delete relevant running tenant clusters and retry the deletion of the cloud gateway. +3. The system performs a validation to ensure there are no running tenant clusters associated with the PCG instance being deleted. If such instances are found, an error is displayed. Delete any running tenant clusters and retry deleting the PCG. 4. Delete the Gateway Virtual Machines from vSphere.
-### Resize a VMware Cloud Gateway - -A cloud gateway can be set up as a 1-node or a 3-node cluster. For production environments, it is recommended that three (3) nodes are set up. A cloud gateway can be initially set up with one (1) node and resized to three (3) nodes at a later time. The following steps need to be performed to resize a 1-node cloud gateway cluster to a 3-node gateway cluster: +### Resize PCG +You can set up the PCG as a single-node cluster or as a three-node cluster for high availability (HA). For production environments, we recommend three nodes. A PCG can be initially set up with one node and resized to three nodes later. Use the following steps to resize a single-node PCG cluster to a three-node PCG cluster. 1. As a Tenant Administrator, navigate to the **Private Cloud Gateway** page under **Settings**. @@ -788,9 +1032,9 @@ Scaling a 3-node cluster down to a 1-node cluster is not permitted.

A loa # IP Address Management -Palette supports DHCP as well as Static IP based allocation strategies for the VMs that are launched during cluster creation. IP Pools can be defined, using a range or a subnet. Administrators can define one or more IP pools linked to a private cloud gateway. +Palette supports both DHCP and Static IP-based allocation strategies for the VMs that are launched during cluster creation. IP Pools can be defined using a range or a subnet. Administrators can define one or more IP pools linked to a PCG. -Clusters created using a private cloud gateway can select from the IP pools linked to the corresponding private cloud gateway. By default, IP Pools are shared across multiple clusters, but can optionally be restricted to a cluster. +Clusters created using a PCG can select from the IP pools linked to the corresponding PCG. By default, IP Pools are shared across multiple clusters but can optionally be restricted to a cluster. The following is a description of various IP Pool properties: diff --git a/content/docs/12.5-palette-cli/10-install-palette-cli.md b/content/docs/12.5-palette-cli/10-install-palette-cli.md index cef94020d2..dc17609041 100644 --- a/content/docs/12.5-palette-cli/10-install-palette-cli.md +++ b/content/docs/12.5-palette-cli/10-install-palette-cli.md @@ -33,7 +33,7 @@ Use the following steps to install and set up the Palette CLI. 2. Open up a terminal session on your local system. -3. Navigate to your default download folder. For Mac and Linux environments the default location is **~/Downloads**. +3. Navigate to your default download folder. For Mac and Linux environments, the default location is **~/Downloads**. 4. Move the binary to a folder that is part of your system's `PATH` environment variable. Use the following command to move the binary to the **/usr/local/bin** folder. @@ -48,14 +48,6 @@ Use the following steps to install and set up the Palette CLI.
-5. If you will use Palette Dev Engine (PDE) complete this step. Otherwise you can skip to [Validation](/palette-cli/install-palette-cli/#validation). Log in to Palette by using the `login` command. Replace `` with your Palette API key. If you are using a Palette self-hosted instance, replace the `--console-url` with your custom Palette URL. - -
- - ```shell - palette pde login --api-key --console-url https://console.spectrocloud.com/ - ``` - ## Validate Verify the Palette CLI is part of your system path by issuing the Palette CLI `version` command. diff --git a/content/docs/12.5-palette-cli/20-commands.md b/content/docs/12.5-palette-cli/20-commands.md index 438fc11a52..99b8a1ccd1 100644 --- a/content/docs/12.5-palette-cli/20-commands.md +++ b/content/docs/12.5-palette-cli/20-commands.md @@ -25,7 +25,14 @@ The complete list of subcommands is: * `help` - Help with any command. - * `pde` - Palette Developer Experience. + * [`login`](#login) - Login to Palette. + + + * [`pcg`](#pcg) - Private Cloud Gateway installation & pre-validation. + + + * [`pde`](#pde) - Palette Developer Experience. + @@ -41,6 +48,104 @@ Palette CLI supports the following global flags. | `-w` | `--workspace` | Workspace location for staging runtime configurations and logs (default `$HOME/.palette`) | string | +# Login + +The `login` subcommand authenticates the Palette CLI with Palette. The `login` subcommand can be used in interactive mode, which prompts you for required values. Or, you can use flags to provide the subcommand with all the required values such as the API key, the organization ID, and the Palette URL. + +
+ +| Flag | Description | Type | | +|-----------------------|--------------------------------------------------------------------------------------|---------| +| `--api-key` | Palette API key (omit for interactive login). | string | +| `--cluster-group-name`| Palette Cluster Group name (optional). Specifies the active Cluster Group. | string | +| `--cluster-group-scope`| Palette Cluster Group scope. Required with `--cluster-group-name`. Allowed values are: `project`, `tenant` , and `system`. |string | +| `--console-url` | Palette URL (omit for interactive login). | string | +| `--help` | Help for the `login` subcommand. | - | +| `--insecure` | Skip Transport Layer Security (TLS) (bypass x509 verification). | - | +| `--org` | Palette Organization name (omit for interactive login). | string | +| `--project` | Palette Project name (optional). Specifies the active Project. | string | + + + +Example: + +
+ +```shell hideClipboard +palette login --api-key 123456789 --org demo-org --console-url https://console.spectrocloud.com +``` + +If you want to target a specific project when using the `login` command, use the `--project` flag. + +
+ +```shell hideClipboard +palette login \ + --api-key 123456789 \ + --org demo-org \ + --console-url https://console.spectrocloud.com \ + --project dev-team +``` + + +Upon successful login, a local configuration file named **palette.yaml** is created. This file contains the metadata for CLI operations and is created in your $HOME directory under the folder name **.palette**. The following output is an example of a **palette.yaml** configuration file. Sensitive values, such as passwords, tokens, and API keys are encrypted at rest. + +
+ +```yaml hideClipboard +paletteConfig: + organization: demo-org + scope: tenant + projectName: dev-team + projectUid: 6342eab2faa0813ead9082e0 + clusterGroupName: beehive + clusterGroupUid: 635669ba4583891d109fe6c0 + tenantUid: 40b8a9a7f724831be814e5734ea744ed + ubuntuConfig: + enablefips: false + token: "" + scarConfig: + scarLoc: "" + scarUsername: "" + scarPassword: "" + mgmt: + apikey: 2abVsxDfFcJpYZ08+6dNWhkk + endpoint: https://console.spectrocloud.com + insecure: false + pairingcode: "" +runLoc: /Users/demo/.palette/ +workspaceLoc: /Users/demo/.palette +``` + +# PCG + +The `pcg` subcommand supports Private Cloud Gateway (PCG) operations, such as installing a PCG cluster and validating its installation. A local [kind](https://kind.sigs.k8s.io/) cluster is created to facilitate creating the PCG cluster in the target environment. You do not need to install kind or any other dependencies, the CLI includes all the required dependencies to stand up the kind cluster. + + +The `pcg` command exposes the following subcommand. + +
+ + * `install` - Install a PCG through an interactive wizard. + + +
+ +## Install + +Use the `install` subcommand to install a PCG cluster in the following environments. + +
+ + +| Platform | Install Guide | +|---|---| +| MAAS | [Link](/clusters/data-center/maas/install-manage-maas-pcg#installpcg) | +| OpenStack | [Link](/clusters/data-center/openstack#installingprivatecloudgateway-openstack) | +| VMware | [Link](/clusters/data-center/vmware/#createvmwareprivatecloudgateway(pcg)) | + + +To learn more about installing a PCG cluster. Refer to each platform's respective PCG install guide. # PDE @@ -140,4 +245,4 @@ You can use the `virtual-cluster` command to manage virtual cluster resources. B -
\ No newline at end of file +