diff --git a/docs/docs-content/clusters/data-center/vmware/vmware.md b/docs/docs-content/clusters/data-center/vmware/vmware.md index 92d4ea5e80..02b6b12902 100644 --- a/docs/docs-content/clusters/data-center/vmware/vmware.md +++ b/docs/docs-content/clusters/data-center/vmware/vmware.md @@ -7,7 +7,7 @@ sidebar_position: 30 tags: ["data center", "vmware"] --- -Palette supports usning VMware as a data center provider. With this, you can deploy and manage Kubernetes clusters on +Palette supports using VMware as a data center provider. With this, you can deploy and manage Kubernetes clusters on VMware virtual machines. For this to work, Palette uses a [Private Cloud Gateway (PCG)](../../pcg/architecture.md), which creates a secure connection from the internal network to the internet-accessible Palette instance, ultimately bypassing the need to create firewall rules or other network configurations allowing external connections to the diff --git a/docs/docs-content/integrations/hello-universe.md b/docs/docs-content/integrations/hello-universe.md index 2ca0db37be..d96bfa7dad 100644 --- a/docs/docs-content/integrations/hello-universe.md +++ b/docs/docs-content/integrations/hello-universe.md @@ -32,7 +32,7 @@ The three-tier application configuration is only supported by version 1.1.2 of t - + ## Prerequisites @@ -43,7 +43,10 @@ The three-tier application configuration is only supported by version 1.1.2 of t - A Palette cluster with port `:8080` available. If port 8080 is not available, you can set a different port in the **values.yaml** file. -- Ensure sufficient CPU resources within the cluster to allocate a minimum of 100 milliCPU and a maximum of 200 milliCPU +- If you are using the **Enable Hello Universe API** preset, you will need the `:3000` port available on your cluster + too. Check out the [Usage](#usage) section for further details. + +- Ensure sufficient CPU resources within the cluster to allocate a minimum of 500 milliCPU and a maximum of 500 milliCPU per replica. ## Parameters @@ -51,23 +54,36 @@ The three-tier application configuration is only supported by version 1.1.2 of t The following parameters are applied to the **hello-universe.yaml** manifest through the **values.yaml** file. Users do not need to take any additional actions regarding these parameters. -| **Parameter** | **Description** | **Default Value** | **Required** | -| --------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------- | ------------ | -| `manifests.namespace` | The namespace in which the application will be deployed. | `hello-universe` | No | -| `manifests.images.hello-universe` | The application image that will be utilized to create the containers. | `ghcr.io/spectrocloud/hello-universe:1.1.1` | No | -| `manifests.port` | The cluster port number on which the service will listen for incoming traffic. | `8080` | No | -| `manifests.replicas` | The number of Pods to be created. | `1` | No | +| **Parameter** | **Description** | **Default Value** | **Required** | +| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------ | +| `manifests.namespace` | The namespace in which the application will be deployed. | `hello-universe` | Yes | +| `manifests.images.hellouniverse` | The [`hello-universe`](https://github.com/spectrocloud/hello-universe) application image that will be utilized to create the front-end containers. | `ghcr.io/spectrocloud/hello-universe:1.1.2`/ `ghcr.io/spectrocloud/hello-universe:1.1.2-proxy` | Yes | +| `manifests.images.hellouniverseapi` | The [`hello-universe-api`](https://github.com/spectrocloud/hello-universe-api) application image that will be utilized to create the API containers. | `ghcr.io/spectrocloud/hello-universe-api:1.0.12` | No | +| `manifests.images.hellouniversedb` | The [`hello-universe-db`](https://github.com/spectrocloud/hello-universe-db) application image that will be utilized to create the database containers. | `ghcr.io/spectrocloud/hello-universe-db:1.0.2` | No | +| `manifests.apiEnabled` | The flag that indicates whether to deploy the UI application as standalone or together with the API server. | `false` | Yes | +| `manifests.port` | The cluster port number on which the service will listen for incoming traffic. | `8080` | Yes | +| `manifests.replicas` | The number of Pods to be created. | `1` | Yes | +| `manifests.dbPassword` | The base64 encoded database password to connect to the API database. | `REPLACE_ME` | No | +| `manifests.authToken` | The base64 encoded auth token for the API connection. | `REPLACE_ME` | No | ## Usage +The Hello Universe pack has two presets that you can select: + +- **Disable Hello Universe API** configures Hello Universe as a standalone frontend application. This is the default + configuration of the pack. +- **Enable Hello Universe API** configures Hello Universe as a three-tier application with a frontend, API server, and + Postgres database. + To utilize the Hello Universe pack, create either a -[full Palette cluster profile](../profiles/cluster-profiles/create-cluster-profiles/create-full-profile.md) or an -[add-on Palette cluster profile](../profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/create-addon-profile.md) -and add the pack to your profile. +[full Palette cluster profile](https://docs.spectrocloud.com/profiles/cluster-profiles/create-cluster-profiles/create-full-profile) +or an +[add-on Palette cluster profile](https://docs.spectrocloud.com/profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/) +and add the pack to your profile. You can select the preset you wish to deploy on the cluster profile creation page. If your infrastructure provider does not offer a native load balancer solution, such as VMware and MAAS, the -[MetalLB](./metallb.md) pack must be included to the cluster profile to help the LoadBalancer service specified in the -manifest obtain an IP address. +[MetalLB](https://docs.spectrocloud.com/integrations/metallb) pack must be included to the cluster profile to help the +LoadBalancer service specified in the manifest obtain an IP address. After defining the cluster profile, use it to deploy a new cluster or attach it as an add-on profile to an existing cluster. @@ -85,14 +101,14 @@ data "spectrocloud_registry" "community_registry" { } data "spectrocloud_pack" "hellouniverse" { name = "hello-universe" - version = "1.1.1" + version = "1.1.2" registry_uid = data.spectrocloud_registry.community_registry.id } ``` - + ## Prerequisites @@ -103,10 +119,7 @@ data "spectrocloud_pack" "hellouniverse" { - A Palette cluster with port `:8080` available. If port 8080 is not available, you can set a different port in the **values.yaml** file. -- If you are using the **Enable Hello Universe API** preset, you will need the `:3000` port available on your cluster - too. Check out the [Usage](#usage) section for further details. - -- Ensure sufficient CPU resources within the cluster to allocate a minimum of 500 milliCPU and a maximum of 500 milliCPU +- Ensure sufficient CPU resources within the cluster to allocate a minimum of 100 milliCPU and a maximum of 200 milliCPU per replica. ## Parameters @@ -114,36 +127,23 @@ data "spectrocloud_pack" "hellouniverse" { The following parameters are applied to the **hello-universe.yaml** manifest through the **values.yaml** file. Users do not need to take any additional actions regarding these parameters. -| **Parameter** | **Description** | **Default Value** | **Required** | -| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------ | --- | --- | -| `manifests.namespace` | The namespace in which the application will be deployed. | `hello-universe` | Yes | -| `manifests.images.hellouniverse` | The [`hello-universe`](https://github.com/spectrocloud/hello-universe) application image that will be utilized to create the front-end containers. | `ghcr.io/spectrocloud/hello-universe:1.1.2`/ `ghcr.io/spectrocloud/hello-universe:1.1.2-proxy` | Yes | -| `manifests.images.hellouniverseapi` | The [`hello-universe-api`](https://github.com/spectrocloud/hello-universe-api) application image that will be utilized to create the API containers. | `ghcr.io/spectrocloud/hello-universe-api:1.0.12` | No | -| `manifests.images.hellouniversedb` | The [`hello-universe-db`](https://github.com/spectrocloud/hello-universe-db) application image that will be utilized to create the database containers. | `ghcr.io/spectrocloud/hello-universe-db:1.0.2` | No | -| `manifests.apiEnabled` | The flag that indicates whether to deploy the UI application as standalone or together with the API server. | `false` | Yes | -| `manifests.port` | The cluster port number on which the service will listen for incoming traffic. | `8080` | Yes | -| `manifests.replicas` | The number of Pods to be created. | `1` | Yes | -| `manifests.dbPassword` | The base64 encoded database password to connect to the API database. | `REPLACE_ME` | No | -| `manifests.authToken` | The base64 encoded auth token for the API connection. | `REPLACE_ME` | No | | No | +| **Parameter** | **Description** | **Default Value** | **Required** | +| --------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------- | ------------ | +| `manifests.namespace` | The namespace in which the application will be deployed. | `hello-universe` | No | +| `manifests.images.hello-universe` | The application image that will be utilized to create the containers. | `ghcr.io/spectrocloud/hello-universe:1.1.1` | No | +| `manifests.port` | The cluster port number on which the service will listen for incoming traffic. | `8080` | No | +| `manifests.replicas` | The number of Pods to be created. | `1` | No | ## Usage -The Hello Universe pack has two presets that you can select: - -- **Disable Hello Universe API** configures Hello Universe as a standalone frontend application. This is the default - configuration of the pack. -- **Enable Hello Universe API** configures Hello Universe as a three-tier application with a frontend, API server, and - Postgres database. - To utilize the Hello Universe pack, create either a -[full Palette cluster profile](https://docs.spectrocloud.com/profiles/cluster-profiles/create-cluster-profiles/create-full-profile) -or an -[add-on Palette cluster profile](https://docs.spectrocloud.com/profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/) -and add the pack to your profile. You can select the preset you wish to deploy on the cluster profile creation page. +[full Palette cluster profile](../profiles/cluster-profiles/create-cluster-profiles/create-full-profile.md) or an +[add-on Palette cluster profile](../profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/create-addon-profile.md) +and add the pack to your profile. If your infrastructure provider does not offer a native load balancer solution, such as VMware and MAAS, the -[MetalLB](https://docs.spectrocloud.com/integrations/metallb) pack must be included to the cluster profile to help the -LoadBalancer service specified in the manifest obtain an IP address. +[MetalLB](./metallb.md) pack must be included to the cluster profile to help the LoadBalancer service specified in the +manifest obtain an IP address. After defining the cluster profile, use it to deploy a new cluster or attach it as an add-on profile to an existing cluster. @@ -161,7 +161,7 @@ data "spectrocloud_registry" "community_registry" { } data "spectrocloud_pack" "hellouniverse" { name = "hello-universe" - version = "1.1.2" + version = "1.1.1" registry_uid = data.spectrocloud_registry.community_registry.id } ```