-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document Nutanix #1883
Document Nutanix #1883
Changes from 36 commits
11a6257
01ee6b3
2e4f27d
a5d36b4
37fb7a3
7e5c72b
cfaa0e4
eaf76ed
7c77935
e607f70
5496b2f
93a0ef7
62fa69a
cb7b12d
7340268
273ebe5
d740768
5aa677a
5815d3a
ae2f4b6
0445a83
da67125
ad98751
d40308c
ba1e2b0
ae76d6c
a817ff4
d850928
2ab9af8
1595456
fc21b90
2fdcba5
ab516ad
c3ce48f
c09def0
7eee76b
f8c06fc
dc7546f
87b348f
c221d32
a69d724
6c57131
7d15647
a9621fc
1eaab15
1f96517
a366079
4e8a8aa
af1dbd6
0e6d9df
9f2d989
f8766d0
03bb971
24da51c
04510cf
db6bdb3
3ea4a87
36e48d4
3551cbe
77674e8
05425cc
85c3c64
5bdae32
2273ccb
97f117f
cc268bc
512ea93
6c33388
ca24998
5ffe9be
ff8719e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
sidebar_label: "Add Nutanix Cloud Account" | ||
title: "Add Nutanix Cloud Account" | ||
description: "Learn how to add a Nutanix cloud account in Palette." | ||
hide_table_of_contents: false | ||
tags: ["data center", "nutanix"] | ||
--- | ||
|
||
Once the Private Cloud Gateway (PCG) is installed, the Nutanix cloud account must be added to Palette. The required fields to add the cloud are pre-defined by the system administrator during the cloud registration process. These cloud-specific fields vary based on the cloud type. | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Prerequisites | ||
|
||
- A Nutanix cloud that a system administrator has registered with Palette. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
|
||
- A PCG installed that connects the Nutanix cloud with Palette. For guidance, refer to [Install Private Cloud Gateway](install-pcg.md). | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Add Cloud Account | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com/) as a tenant administrator. | ||
|
||
2. From the **left Main Menu**, select **Tenant Settings**. | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
3. Next, select **Cloud Accounts** in the **Tenant Settings** menu. | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
4. Locate Nutanix and click **Add Nutanix Cloud**. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
|
||
5. Fill out the following input values and click on **Confirm** to continue. | ||
|
||
| **Field** | **Description** | | ||
|-----------|-----------------| | ||
| **Name**| A custom name for the account. | | ||
| **Private Cloud Gateway**| This name is auto-filled based on the name you provided when you installed the PCG.| | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| **NUTANIX_USER**| The Prism Central user name.| | ||
| **NUTANIX_PASSWORD** | The Prism Central user password.| | ||
| **NUTANIX_ENDPOINT** | The Prism Central IP address or the fully qualified domain name (FQDN) assigned to Prism.| | ||
| **NUTANIX_PORT** | Specify the default port you assigned in the ``cloudClusterTemplate.yaml`` file. The default value is `9440`. | | ||
| **NUTANIX_INSECURE** | Specify the SSL behavior you used in the ``cloudClusterTemplate.yaml`` file. The default behavior is `false`. | | ||
|
||
## Validate | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com/). | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
2. From the **left Main Menu**, select **Tenant Settings**. | ||
|
||
3. Next, select **Cloud Accounts** in the **Tenant Settings Menu**. | ||
|
||
4. Verify the account you added is listed and available. | ||
|
||
|
||
## Next Steps | ||
|
||
Now that you have added a Nutanix account to Palette, you can start deploying Kubernetes clusters to your Nutanix infrastructure. To learn how to get started deploying Kubernetes clusters to Nutanix, review the [Create and Manage Nutanix Cluster](/clusters/data-center/nutanix/create-manage-nutanix-cluster.md) guide. | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
sidebar_label: "Architecture" | ||
title: "Architecture" | ||
description: "Learn about the architecture used to support Nutanix in Palette." | ||
hide_table_of_contents: false | ||
sidebar_position: 0 | ||
tags: ["data center", "nutanix", "architecture"] | ||
--- | ||
|
||
|
||
[Nutanix](https://www.nutanix.com) is a private data center-based cloud that can be registered to Palette using Palette's generic framework built upon the open-source Cluster API (CAPI) initiative. Nutanix offers a hyper-converged infrastructure (HCI) that combines storage, compute, and networking into a single integrated system. | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Below are key architectural highlights of Nutanix clusters provisioned through Palette. | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Palette integrates with Nutanix through the Cloud Native Computing Foundation (CNCF) [Nutanix Cluster API infrastructure provider](https://github.com/nutanix-cloud-native/cluster-api-provider-nutanix). | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Nutanix Prism is a resource management platform that centralizes the monitoring and management of objects across Nutanix environments, whether hosted in your data center or a public cloud provider environment. Nutanix Prism has two main components: Prism Central (PC) and Prism Element (PE). | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Prism Central is a workspace in which you can register and manage Nutanix workload clusters. The Cluster API Provider Nutanix Cloud Infrastructure (CAPX) relies on Prism Central APIs to manage the Kubernetes cluster infrastructure resources. | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<!-- Prism Central is required. CAPI Provider Nutanix Cloud Infrastructure (CAPX) interacts with Prism Central APIs using a Prism Central user account. For more information, refer to the Nutanix [Credential Management](https://opendocs.nutanix.com/capx/latest/credential_management/) reference guide. --> | ||
|
||
- Prism Element is a localized cluster manager available for every deployed Nutanix cluster. Within Prism Element, you can configure a cluster, specifying its components such as the number of control plane and worker nodes, networking settings, and more. | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- The Kubernetes API Server endpoint is accessible through kube-vip, which is a load balancing solution for the cluster’s control plane. Kube-vip distributes API requests across control plane nodes and also has fail over capabilities. | ||
|
||
- A Private Cloud Gateway (PCG) is required to enable Palette to securely communicate with the Nutanix cloud. The direct communication channel allows Palette to create clusters within the Nutanix cloud. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
|
||
The following diagram illustrates the Nutanix architecture. | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
|
||
![Network flow from an architectural perspective of how Nutanix works with Palette.](/clusters_data-center_nutanix_architecture.png) | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
--- | ||
sidebar_label: "Create and Manage Nutanix Cluster" | ||
title: "Create and Manage Nutanix Cluster" | ||
description: "Learn how to create and manage Nutanix clusters in Palette." | ||
hide_table_of_contents: false | ||
tags: ["data center", "nutanix"] | ||
--- | ||
|
||
Palette supports creating and managing Kubernetes clusters deployed to a Nutanix infrastructure environment. This section guides you in creating a Kubernetes cluster in a Nutanix cloud managed by Palette. | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Prerequisites | ||
|
||
- A Nutanix Prism Central cloud account. For more information, review [Add Nutanix Cloud Account](add-nutanix-cloud-account.md). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- A Private Cloud Gateway (PCG) deployed. For guidance, review [Install Private Cloud Gateway](install-pcg.md). | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- The minimum supported CAPI version 1.5.3. Refer to the Nutanix [Validated Integrations](https://opendocs.nutanix.com/capx/v1.2.x/validated_integrations/#validated-versions) compatibility matrix. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- An infrastructure cluster profile created for the Nutanix cloud. For guidance on creating a profile, refer to [Create an Infrastructure Profile](../../../profiles/cluster-profiles/create-cluster-profiles/create-infrastructure-profile.md). At the **Cloud Type** step of profile creation, select **Nutanix** listed under the **Tech Preview**. Select the custom packs provided at the OS and Kubernetes layers. Out-of-the-box packs are provided for the network and storage profile layers. Additionally, Palette provides a Nutanix-specific storage pack. | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
## Deploy a Nutanix Cluster | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Use the following steps to deploy a Kubernetes cluster in Nutanix. | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. Log in to [Palette](https://console.spectrocloud.com/). | ||
|
||
2. From the left **Main Menu** select **Clusters**. | ||
|
||
3. Click on **Add New Cluster** and select **Deploy New Cluster** on the next page Palette displays. | ||
|
||
4. Select **Nutanix** and click the **Start Nutanix Configuration** button. | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
5. Fill out the following basic information, and click **Next** to continue. | ||
|
||
| **Field** | **Description** | | ||
|-----------|-----------------| | ||
| **Cluster Name**| A custom name for the cluster. | | ||
| **Description**| Use the description to provide context about the cluster.| | ||
| **Tags**| Assign any desired cluster tags. Tags on a cluster are propagated to the Virtual Machines (VMs) deployed to the target environments.| | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| **Cloud Account** | Select your Nutanix account from the **drop-down Menu**. If you have not yet added your account, select **Add New Account** and add your Nutanix account information. | | ||
|
||
6. Select the Nutanix cluster profile you created and click **Next**. Palette displays the profile layers. | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
7. Review profile layers and customize parameters as desired in the YAML files that display when you select a layer. Click **Next** when you are done. | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
8. In the Cluster configuration YAML file that Palette displays, edit the file to replace variables within curly braces listed in the table below with values that apply to your Nutanix cloud environment, and make any adjustments to configure your cluster. Click **Next** when you are done. | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
| **Variable** | **Description** | | ||
|--------------|-----------------| | ||
| `${CLUSTER_NAME}`| The name of the Nutanix workload cluster. | | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please add a comment that it must be the exact same name as the one created in palette in step 5 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added the text in bold: The name of the Nutanix workload cluster. Use the same cluster name you specified in step 5. Additionally, added the text in bold to the cluster Name description in step 5: |
||
| `${CONTROL_PLANE_ENDPOINT_IP}`| The host static IP address. | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `${CLUSTER_ENDPOINT}`| The cluster IP address. | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
:::caution | ||
|
||
The following applies when replacing variables within curly braces in the YAML configuration files. | ||
|
||
- All the variables must be resolved or have a default value. | ||
|
||
- Names you provide must match. Any names in the YAML files that do not match your Nutanix cluster configuration will result in unsuccessful cluster deployment. | ||
|
||
- Values that are passed as a string, such as names and keys, must be enclosed in quotes, for example `" "`. | ||
|
||
- When replacing values, remove the dollar sign and curly braces. | ||
|
||
- Verify the port specified in the YAM file. | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
::: | ||
|
||
9. In the Node pool configuration YAML files for the master and worker pools, edit the files to replace each occurrence of the variables within curly braces listed in the tables below with values that apply to your Nutanix cloud environment. You can configure scaling in the Palette UI by specifying the number of nodes in the pool. This corresponds to `replicas` in the YAML file. | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### Master Pool | ||
|
||
| **Variable** | **Description** | | ||
|--------------|-----------------| | ||
| `${CLUSTER_NAME}`| The name of the Nutanix workload cluster. | | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please add a comment that it must be the exact same name as the one created in palette in step 5 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Revised the description as: The name of the Nutanix workload cluster. Use the same cluster name you specified in step 5. |
||
| `${CONTROL_PLANE_ENDPOINT_IP}`| The Nutanix IP address. | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, that's the IP for the API endpoint (for Kube-VIP). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed |
||
| `${NUTANIX_SSH_AUTHORIZED_KEY}`| Provide your public SSH key. | | ||
| `${KUBERNETES_VERSION}`| Specify the Kubernetes version for your cluster, and precede the version number with `v`. For example `v.1.26.3` | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `${NUTANIX_PRISM_ELEMENT_CLUSTER_NAME}`| The name of your Nutanix Prism cluster. | | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `${NUTANIX_MACHINE_TEMPLATE_IMAGE_NAME}` | The name of your OS image. | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `${NUTANIX_SUBNET_NAME}` | The name of the subnet for your Nutanix Prism cluster. | | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### Worker-Pool | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
| **Variable** | **Description** | | ||
|--------------|-----------------| | ||
| `${NUTANIX_SSH_AUTHORIZED_KEY}`| Provide your public SSH key. | | ||
| `${KUBERNETES_VERSION}`| Specify the Kubernetes version for your cluster, and precede the version number with `v`. For example `v.1.26.3` | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `${NUTANIX_PRISM_ELEMENT_CLUSTER_NAME}`| The name of your Nutanix Prism cluster. | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `${NUTANIX_MACHINE_TEMPLATE_IMAGE_NAME}` | The name of your OS image. | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `${NUTANIX_SUBNET_NAME}` | The name of the subnet for your Nutanix Prism cluster. | | ||
ritawatson marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
10. Click **Next** when you are done. | ||
|
||
11. Review the options for OS patching schedule, scanning, backups, and RBAC. | ||
|
||
12. Click **Validate** and review the cluster configuration and settings summary. | ||
|
||
13. Click **Finish Configuration** to deploy the cluster. The cluster details page contains the status and details of the deployment. Use this page to track deployment progress. Provisioning clusters can take several minutes to complete. | ||
|
||
14. To edit node pool configurations, navigate to the cluster details page, click the **Nodes** tab, and select the node pool you want to edit. Click the **Edit** button and edit the YAML file that Palette displays. | ||
|
||
15. To edit cluster settings, from the cluster details page, click the **Settings** button and select **Cluster Configuration**. Edit the YAML file that Palette displays. | ||
|
||
|
||
## Validate | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com/). | ||
|
||
2. Navigate to the **left Main Menu** and select **Clusters**. The Clusters page displays a list of all available clusters that Palette manages. | ||
|
||
3. Click on the Nutanix cluster you created to view its details page. | ||
caroldelwing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
4. Ensure the **Cluster Status** field displays **Running**. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Nutanix'?