From 7575d5a5707519a56ef97e99a26e9639bb1e42d9 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Wed, 18 Dec 2024 16:35:05 +0000 Subject: [PATCH 01/22] docs: SSH usernames draft --- .../architecture/ssh-usernames.md | 54 +++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/docs-content/architecture/ssh-usernames.md diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md new file mode 100644 index 0000000000..81cd60f41b --- /dev/null +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -0,0 +1,54 @@ +--- +sidebar_label: "SSH Usernames" +title: "SSH Usernames" +description: "A list of the Secure Shell (SSH) usernames created for each provider type on Kubernetes nodes." +icon: "" +hide_table_of_contents: false +sidebar_position: 60 +--- + +This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and operating +system. + +These user names are relevant when deploying [SSH key pairs](../clusters/cluster-management/ssh-keys.md) to your +Kubernetes cluster through Palette. + +## Public Clouds + +### Infrastructure Provider + +| Provider | Operating System | SSH Username | +| -------------- | ---------------- | ------------ | +| **AWS IaaS** | TBC | TBC | +| **Azure IaaS** | TBC | TBC | +| **GCP IaaS** | TBC | TBC | + +### Managed Kubernetes + +| Provider | Operating System | SSH Username | +| ----------------- | ------------------------------------ | ------------ | +| **AWS EKS** | **Amazon EKS optimized Linux 1.0.0** | `ec2-user` | +| **Azure AKS** | **Linux 22.04** | `azureuser` | +| **GCP GKE** | **Container-Optimized OS** | TBC | +| **TKE** (Tencent) | TBC | TBC | + +## Data Center + +| Provider | Operating System | SSH Username | +| -------------- | ---------------- | ------------ | +| MAAS | TBC | TBC | +| Openstack | TBC | TBC | +| VMware vSphere | TBC | `spectro` | + +## Edge + +| Provider | SSH Username | +| ----------- | ------------ | --- | +| Edge Native | TBC | TBC | + +## Resources + +- [SSH key pairs](../clusters/cluster-management/ssh-keys.md) +- [Deploy a Cluster (Public Cloud)](../clusters/public-cloud/deploy-k8s-cluster.md) +- [Data Center Clusters](../clusters/data-center/data-center.md) +- [Create Cluster Definition (Edge)](../clusters/edge/site-deployment/cluster-deployment.md) From d4305c8272598c06d423e0e7802ad91c1a0487c6 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Wed, 18 Dec 2024 19:25:47 +0000 Subject: [PATCH 02/22] docs: GCP GKE addition --- docs/docs-content/architecture/ssh-usernames.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md index 81cd60f41b..e4c5de1201 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -29,9 +29,21 @@ Kubernetes cluster through Palette. | ----------------- | ------------------------------------ | ------------ | | **AWS EKS** | **Amazon EKS optimized Linux 1.0.0** | `ec2-user` | | **Azure AKS** | **Linux 22.04** | `azureuser` | -| **GCP GKE** | **Container-Optimized OS** | TBC | +| **GCP GKE** | **Container-Optimized OS** | N/A | | **TKE** (Tencent) | TBC | TBC | +:::info + +It is not possible to configure GCP GKE clusters with an SSH key during cluster creation. If SSH access to your GCP GKE nodes is critical, consider one of the following options: + +- Configure project or node-level metadata to include your SSH key. Refer to [Predefined and custom metadata keys](https://cloud.google.com/compute/docs/metadata/overview#predefined-and-custom-metadata-keys) for guidance. + +- Enable OS Login and associate your SSH key with your IAM identity. Refer to [How OS Login works](https://cloud.google.com/compute/docs/oslogin#how_os_login_works) for guidance. + +- Customize startup scripts or metadata to add your SSH key during node creation in a managed instance group. Refer to [Using startup scripts on Linux VMs](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) for guidance. + +::: + ## Data Center | Provider | Operating System | SSH Username | From 396864e10748a31214eee4c3c71d85c69ea1b086 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Thu, 19 Dec 2024 15:23:08 +0000 Subject: [PATCH 03/22] docs: update based on packs JSON --- .../architecture/ssh-usernames.md | 40 ++++++++++--------- 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md index e4c5de1201..178dd083e0 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -17,22 +17,26 @@ Kubernetes cluster through Palette. ### Infrastructure Provider -| Provider | Operating System | SSH Username | +| Provider | Operating System Pack | SSH Username | | -------------- | ---------------- | ------------ | -| **AWS IaaS** | TBC | TBC | -| **Azure IaaS** | TBC | TBC | -| **GCP IaaS** | TBC | TBC | +| **AWS IaaS** | **Ubuntu** | `ubuntu` | +| **AWS IaaS** | **CentOS** | `centos` | +| **Azure IaaS** | **Ubuntu** | `ubuntu` | +| **Azure IaaS** | **CentOS** | `centos` | +| **GCP IaaS** | **Ubuntu** | `ubuntu` | +| **GCP IaaS** | **CentOS** | `centos` | ### Managed Kubernetes -| Provider | Operating System | SSH Username | +| Provider | Operating System Pack | SSH Username | | ----------------- | ------------------------------------ | ------------ | -| **AWS EKS** | **Amazon EKS optimized Linux 1.0.0** | `ec2-user` | -| **Azure AKS** | **Linux 22.04** | `azureuser` | +| **AWS EKS** | **Amazon EKS optimized Linux** | `ec2-user` | +| **Azure AKS** | **Linux** | `azureuser` | | **GCP GKE** | **Container-Optimized OS** | N/A | -| **TKE** (Tencent) | TBC | TBC | +| **TKE** (Tencent) | **TKE Managed OS** (Ubuntu) | `ubuntu` | +| **TKE** (Tencent) | **TKE Managed OS** (CentOS) | `centos` or `root` | -:::info +#### SSH Configuration on GCP GKE It is not possible to configure GCP GKE clusters with an SSH key during cluster creation. If SSH access to your GCP GKE nodes is critical, consider one of the following options: @@ -42,21 +46,21 @@ It is not possible to configure GCP GKE clusters with an SSH key during cluster - Customize startup scripts or metadata to add your SSH key during node creation in a managed instance group. Refer to [Using startup scripts on Linux VMs](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) for guidance. -::: - ## Data Center -| Provider | Operating System | SSH Username | +| Provider | Operating System Pack | SSH Username | | -------------- | ---------------- | ------------ | -| MAAS | TBC | TBC | -| Openstack | TBC | TBC | -| VMware vSphere | TBC | `spectro` | +| MAAS | **Ubuntu** | `ubuntu` | +| Openstack | **Ubuntu** | `ubuntu` | +| VMware vSphere | **Ubuntu** | `ubuntu` | +| VMware vSphere | **CentOS** | `centos` | ## Edge -| Provider | SSH Username | -| ----------- | ------------ | --- | -| Edge Native | TBC | TBC | +This is dependent on the operating system you provide for your edge hosts. This is achieved by using one of the following methods: + +- [Agent Mode](../deployment-modes/agent-mode/agent-mode.md) +- [Provider images](../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md) ## Resources From 2a2e4b2d6c4f0b2e6f7137229b8e30ba3bfb880a Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Thu, 2 Jan 2025 11:34:40 +0000 Subject: [PATCH 04/22] docs: remove tencent --- .../architecture/ssh-usernames.md | 58 +++++++++++-------- 1 file changed, 33 insertions(+), 25 deletions(-) diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md index 178dd083e0..49451ff159 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -1,7 +1,9 @@ --- sidebar_label: "SSH Usernames" title: "SSH Usernames" -description: "A list of the Secure Shell (SSH) usernames created for each provider type on Kubernetes nodes." +description: + "A list of the Secure Shell (SSH) usernames created on Kubernetes nodes for each provider and operating system pack + available in Palette." icon: "" hide_table_of_contents: false sidebar_position: 60 @@ -18,46 +20,52 @@ Kubernetes cluster through Palette. ### Infrastructure Provider | Provider | Operating System Pack | SSH Username | -| -------------- | ---------------- | ------------ | -| **AWS IaaS** | **Ubuntu** | `ubuntu` | -| **AWS IaaS** | **CentOS** | `centos` | -| **Azure IaaS** | **Ubuntu** | `ubuntu` | -| **Azure IaaS** | **CentOS** | `centos` | -| **GCP IaaS** | **Ubuntu** | `ubuntu` | -| **GCP IaaS** | **CentOS** | `centos` | +| -------------- | --------------------- | ------------ | +| **AWS IaaS** | **Ubuntu** | `ubuntu` | +| **AWS IaaS** | **CentOS** | `centos` | +| **Azure IaaS** | **Ubuntu** | `ubuntu` | +| **Azure IaaS** | **CentOS** | `centos` | +| **GCP IaaS** | **Ubuntu** | `ubuntu` | +| **GCP IaaS** | **CentOS** | `centos` | ### Managed Kubernetes -| Provider | Operating System Pack | SSH Username | -| ----------------- | ------------------------------------ | ------------ | -| **AWS EKS** | **Amazon EKS optimized Linux** | `ec2-user` | -| **Azure AKS** | **Linux** | `azureuser` | -| **GCP GKE** | **Container-Optimized OS** | N/A | -| **TKE** (Tencent) | **TKE Managed OS** (Ubuntu) | `ubuntu` | -| **TKE** (Tencent) | **TKE Managed OS** (CentOS) | `centos` or `root` | +| Provider | Operating System Pack | SSH Username | +| ------------- | ------------------------------ | ------------ | +| **AWS EKS** | **Amazon EKS optimized Linux** | `ec2-user` | +| **Azure AKS** | **Linux** | `azureuser` | +| **GCP GKE** | **Container-Optimized OS** | N/A | #### SSH Configuration on GCP GKE -It is not possible to configure GCP GKE clusters with an SSH key during cluster creation. If SSH access to your GCP GKE nodes is critical, consider one of the following options: +It is not possible to configure GCP GKE clusters with an SSH key during cluster creation. If SSH access to your GCP GKE +nodes is critical, consider one of the following options: -- Configure project or node-level metadata to include your SSH key. Refer to [Predefined and custom metadata keys](https://cloud.google.com/compute/docs/metadata/overview#predefined-and-custom-metadata-keys) for guidance. +- Configure project or node-level metadata to include your SSH key. Refer to + [Predefined and custom metadata keys](https://cloud.google.com/compute/docs/metadata/overview#predefined-and-custom-metadata-keys) + for guidance. -- Enable OS Login and associate your SSH key with your IAM identity. Refer to [How OS Login works](https://cloud.google.com/compute/docs/oslogin#how_os_login_works) for guidance. +- Enable OS Login and associate your SSH key with your IAM identity. Refer to + [How OS Login works](https://cloud.google.com/compute/docs/oslogin#how_os_login_works) for guidance. -- Customize startup scripts or metadata to add your SSH key during node creation in a managed instance group. Refer to [Using startup scripts on Linux VMs](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) for guidance. +- Customize startup scripts or metadata to add your SSH key during node creation in a managed instance group. Refer to + [Using startup scripts on Linux VMs](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) for + guidance. ## Data Center | Provider | Operating System Pack | SSH Username | -| -------------- | ---------------- | ------------ | -| MAAS | **Ubuntu** | `ubuntu` | -| Openstack | **Ubuntu** | `ubuntu` | -| VMware vSphere | **Ubuntu** | `ubuntu` | -| VMware vSphere | **CentOS** | `centos` | +| -------------- | --------------------- | ------------ | +| MAAS | **Ubuntu** | `ubuntu` | +| Openstack | **Ubuntu** | `ubuntu` | +| VMware vSphere | **Ubuntu** | `ubuntu` | +| VMware vSphere | **CentOS** | `centos` | ## Edge -This is dependent on the operating system you provide for your edge hosts. This is achieved by using one of the following methods: +This is dependent on the operating system you provide for your edge hosts and cannot be predetermined. + +Your edge hosts are built by using one of the following methods: - [Agent Mode](../deployment-modes/agent-mode/agent-mode.md) - [Provider images](../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md) From d9747b779ade29c7e475cd6cdf3ff14fcb50e3cb Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Thu, 2 Jan 2025 11:52:37 +0000 Subject: [PATCH 05/22] docs: miss bold providers --- docs/docs-content/architecture/ssh-usernames.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md index 49451ff159..b83c85e503 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -54,12 +54,12 @@ nodes is critical, consider one of the following options: ## Data Center -| Provider | Operating System Pack | SSH Username | -| -------------- | --------------------- | ------------ | -| MAAS | **Ubuntu** | `ubuntu` | -| Openstack | **Ubuntu** | `ubuntu` | -| VMware vSphere | **Ubuntu** | `ubuntu` | -| VMware vSphere | **CentOS** | `centos` | +| Provider | Operating System Pack | SSH Username | +| ------------------ | --------------------- | ------------ | +| **MAAS** | **Ubuntu** | `ubuntu` | +| **Openstack** | **Ubuntu** | `ubuntu` | +| **VMware vSphere** | **Ubuntu** | `ubuntu` | +| **VMware vSphere** | **CentOS** | `centos` | ## Edge From 3be4f6b420a5c0b0ca628611432848a4687c0803 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Thu, 2 Jan 2025 11:59:50 +0000 Subject: [PATCH 06/22] docs: clean up edge description --- docs/docs-content/architecture/ssh-usernames.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md index b83c85e503..826106db1a 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -63,12 +63,9 @@ nodes is critical, consider one of the following options: ## Edge -This is dependent on the operating system you provide for your edge hosts and cannot be predetermined. - -Your edge hosts are built by using one of the following methods: - -- [Agent Mode](../deployment-modes/agent-mode/agent-mode.md) -- [Provider images](../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md) +This is dependent on the operating system you provide for your edge hosts using either +[Agent Mode](../deployment-modes/agent-mode/agent-mode.md) or +[Provider images](../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). ## Resources From 38f5d86bd9707711806136236a9aaaf5fd1da166 Mon Sep 17 00:00:00 2001 From: Ben Radstone <56587332+benradstone@users.noreply.github.com> Date: Thu, 2 Jan 2025 13:47:27 +0000 Subject: [PATCH 07/22] docs: code review suggestions Co-authored-by: caroldelwing --- docs/docs-content/architecture/ssh-usernames.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md index 826106db1a..bf32126ffc 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -12,10 +12,9 @@ sidebar_position: 60 This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and operating system. -These user names are relevant when deploying [SSH key pairs](../clusters/cluster-management/ssh-keys.md) to your -Kubernetes cluster through Palette. +These user names are relevant when using [SSH key pairs](../clusters/cluster-management/ssh-keys.md) with your Palette host clusters. -## Public Clouds +## Public Cloud ### Infrastructure Provider @@ -65,11 +64,11 @@ nodes is critical, consider one of the following options: This is dependent on the operating system you provide for your edge hosts using either [Agent Mode](../deployment-modes/agent-mode/agent-mode.md) or -[Provider images](../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). +[EdgeForge](../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). ## Resources -- [SSH key pairs](../clusters/cluster-management/ssh-keys.md) +- [SSH Keys](../clusters/cluster-management/ssh-keys.md) - [Deploy a Cluster (Public Cloud)](../clusters/public-cloud/deploy-k8s-cluster.md) - [Data Center Clusters](../clusters/data-center/data-center.md) - [Create Cluster Definition (Edge)](../clusters/edge/site-deployment/cluster-deployment.md) From 57632ce74059eb7c296587ead58232f194f8ba84 Mon Sep 17 00:00:00 2001 From: benradstone Date: Thu, 2 Jan 2025 13:50:52 +0000 Subject: [PATCH 08/22] ci: auto-formatting prettier issues --- docs/docs-content/architecture/ssh-usernames.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/architecture/ssh-usernames.md index bf32126ffc..7e2302c60b 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/architecture/ssh-usernames.md @@ -12,7 +12,8 @@ sidebar_position: 60 This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and operating system. -These user names are relevant when using [SSH key pairs](../clusters/cluster-management/ssh-keys.md) with your Palette host clusters. +These user names are relevant when using [SSH key pairs](../clusters/cluster-management/ssh-keys.md) with your Palette +host clusters. ## Public Cloud From 3741c469382a1ff1b5e3fbb8788dc5dcb0486459 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Thu, 2 Jan 2025 15:05:32 +0000 Subject: [PATCH 09/22] docs: move article to new location --- .../deploy-cluster-azure-crossplane.md | 2 +- .../crossplane/deploy-cluster-gcp-crossplane.md | 2 +- .../cluster-management/ssh-keys/_category_.json | 3 +++ .../{ => ssh-keys}/ssh-keys.md | 5 +++-- .../ssh-keys}/ssh-usernames.md | 16 ++++++++-------- .../vmware/create-manage-vmware-clusters.md | 2 +- .../clusters/public-cloud/azure/aks.md | 2 +- .../public-cloud/azure/create-azure-cluster.md | 2 +- .../clusters/public-cloud/deploy-k8s-cluster.md | 4 ++-- .../public-cloud/gcp/create-gcp-iaas-cluster.md | 2 +- .../getting-started/azure/deploy-k8s-cluster.md | 2 +- .../cluster-deployment/pcg/deploy-app-pcg.md | 2 +- .../public-cloud/deploy-k8s-cluster.md | 6 +++--- .../update-maintain/update-k8s-cluster.md | 2 +- 14 files changed, 28 insertions(+), 24 deletions(-) create mode 100644 docs/docs-content/clusters/cluster-management/ssh-keys/_category_.json rename docs/docs-content/clusters/cluster-management/{ => ssh-keys}/ssh-keys.md (88%) rename docs/docs-content/{architecture => clusters/cluster-management/ssh-keys}/ssh-usernames.md (81%) diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md index d649a2b09d..294989257d 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md @@ -18,7 +18,7 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in Azure. API key. - A public [Azure](https://learn.microsoft.com/en-us/training/modules/create-an-azure-account) cloud account with the required [permissions](../../clusters/public-cloud/azure/required-permissions.md). -- An SSH key pair available. Check out the [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys.md) +- An SSH key pair available. Check out the [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. - The Azure account must be registered in Palette. Follow the [Register and Manage Azure Cloud Account](../../clusters/public-cloud/azure/azure-cloud.md) guide to register your diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md index 8a4801ea00..7613fd551e 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md @@ -18,7 +18,7 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in GCP. API key. - A public [GCP](https://cloud.google.com/iam/docs/creating-managing-service-accounts) service account with the required [roles](../../clusters/public-cloud/gcp/add-gcp-accounts.md#prerequisites). -- An SSH key pair available. Check out the [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys.md) +- An SSH key pair available. Check out the [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. - The GCP account must be registered in Palette. Follow the [Register and Manage GCP Accounts](../../clusters/public-cloud/gcp/add-gcp-accounts.md) guide to register your account diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/_category_.json b/docs/docs-content/clusters/cluster-management/ssh-keys/_category_.json new file mode 100644 index 0000000000..094470741d --- /dev/null +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/_category_.json @@ -0,0 +1,3 @@ +{ + "position": 10 +} diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-keys.md similarity index 88% rename from docs/docs-content/clusters/cluster-management/ssh-keys.md rename to docs/docs-content/clusters/cluster-management/ssh-keys/ssh-keys.md index bf22c290be..0373cc2e88 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-keys.md @@ -12,7 +12,7 @@ describes creating and managing SSH Keys in the Palette Management Console. ## Scope of SSH Key -Palette groups clusters for logical separation into [Projects](../../tenant-settings/projects/projects.md). Users and +Palette groups clusters for logical separation into [Projects](../../../tenant-settings/projects/projects.md). Users and teams can be assigned roles within a project for granular control over permissions within the project scope. SSH key authentication is scoped to a project. Multiple users can gain access to a single project. To access a cluster with SSH, you need a public SSH key registered in Palette. @@ -26,8 +26,9 @@ you need a public SSH key registered in Palette. ## Create and Upload an SSH Key + ## Validate You can validate that the SSH public key is available in Palette by attempting to deploy a host cluster. During the host cluster creation wizard, you will be able to assign the SSH key to the cluster. Refer to the -[Deploy a Cluster](../public-cloud/deploy-k8s-cluster.md) tutorial for additional guidance. +[Deploy a Cluster](../../public-cloud/deploy-k8s-cluster.md) tutorial for additional guidance. diff --git a/docs/docs-content/architecture/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md similarity index 81% rename from docs/docs-content/architecture/ssh-usernames.md rename to docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index 7e2302c60b..63b4f3f18c 100644 --- a/docs/docs-content/architecture/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -6,13 +6,13 @@ description: available in Palette." icon: "" hide_table_of_contents: false -sidebar_position: 60 +sidebar_position: 11 --- This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and operating system. -These user names are relevant when using [SSH key pairs](../clusters/cluster-management/ssh-keys.md) with your Palette +These user names are relevant when using [SSH key pairs](./ssh-keys.md) with your Palette host clusters. ## Public Cloud @@ -64,12 +64,12 @@ nodes is critical, consider one of the following options: ## Edge This is dependent on the operating system you provide for your edge hosts using either -[Agent Mode](../deployment-modes/agent-mode/agent-mode.md) or -[EdgeForge](../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). +[Agent Mode](../../../deployment-modes/agent-mode/agent-mode.md) or +[EdgeForge](../../../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). ## Resources -- [SSH Keys](../clusters/cluster-management/ssh-keys.md) -- [Deploy a Cluster (Public Cloud)](../clusters/public-cloud/deploy-k8s-cluster.md) -- [Data Center Clusters](../clusters/data-center/data-center.md) -- [Create Cluster Definition (Edge)](../clusters/edge/site-deployment/cluster-deployment.md) +- [SSH Keys](./ssh-keys.md) +- [Deploy a Cluster (Public Cloud)](../../public-cloud/deploy-k8s-cluster.md) +- [Data Center Clusters](../../data-center/data-center.md) +- [Create Cluster Definition (Edge)](../../edge/site-deployment/cluster-deployment.md) diff --git a/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md index 0ad82fee15..34ddb81005 100644 --- a/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md +++ b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md @@ -95,7 +95,7 @@ Before you begin, ensure that you have the following prerequisites: | **Deployment Folder** | The folder in the datacenter where the cluster and its nodes will be deployed. Check the box **Append cluster name** if you want the cluster name appended to the folder name. | Yes | | **Image Template Folder** | The folder in the datacenter where the image templates are stored. This is typically in the **spectro-templates** folder. | Yes | | **Network Type** | The network type to use for the cluster. Select **Static IP** if you want to use static IP addresses. Select **DHCP** if you want to use Dynamic Host Configuration Protocol (DHCP). | Yes | - | **SSH Key** | The SSH key to use for the cluster. Check out the [Create and Upload an SSH Key](../../cluster-management/ssh-keys.md#create-and-upload-an-ssh-key) guide to learn how to upload an SSH key to Palette. | No | + | **SSH Key** | The SSH key to use for the cluster. Check out the [Create and Upload an SSH Key](../../cluster-management/ssh-keys/ssh-keys.md#create-and-upload-an-ssh-key) guide to learn how to upload an SSH key to Palette. | No | | **NTP Servers** | The Network Time Protocol (NTP) servers to use for the cluster. | No | :::warning diff --git a/docs/docs-content/clusters/public-cloud/azure/aks.md b/docs/docs-content/clusters/public-cloud/azure/aks.md index 28bcbd3333..ab96b3aee3 100644 --- a/docs/docs-content/clusters/public-cloud/azure/aks.md +++ b/docs/docs-content/clusters/public-cloud/azure/aks.md @@ -16,7 +16,7 @@ explains how you can create an Azure AKS cluster managed by Palette. [Register and Manage Azure Cloud Account](./azure-cloud.md) for guidance. - A Secure Shell (SSH) key that you have pre-configured in your Azure environment. Refer to the - [SSH Keys](../../cluster-management/ssh-keys.md) guide for more information about creating and managing SSH keys in + [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH keys in Palette. - An infrastructure cluster profile for Azure. Review diff --git a/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md b/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md index f1a988bad4..7246340009 100644 --- a/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md +++ b/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md @@ -28,7 +28,7 @@ to create an IaaS Kubernetes cluster in Azure that Palette manages. - Palette integration with Azure account. Review [Register and Manage Azure Cloud Account](azure-cloud.md) for guidance. - A Secure Shell (SSH) key pre-configured in your Azure environment. Refer to the - [SSH Keys](../../cluster-management/ssh-keys.md) guide for more information about creating and managing SSH keys in + [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH keys in Palette. - An infrastructure cluster profile for Azure. Review diff --git a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md index 19c51433f2..6dfd1ebafe 100644 --- a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md @@ -71,7 +71,7 @@ To complete this tutorial, you will need the following.
-- An SSH Key Pair. Use the [Create and Upload an SSH Key](../cluster-management/ssh-keys.md) guide to learn how to +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the @@ -350,7 +350,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster config** section allows you to select the **Subscription**, **Region**, **Resource Group**, **Storage account**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../cluster-management/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key.
diff --git a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md index c0f9c415d5..7ddcb491b4 100644 --- a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md +++ b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md @@ -69,7 +69,7 @@ Ensure the following requirements are met before you attempt to deploy a cluster | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Project** | The project to which the cluster belongs. | | **Region** | Choose the desired GCP region to deploy the cluster. | - | **SSH Key** | Choose the desired SSH key. Refer to the [SSH Keys](../../cluster-management/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to Palette. | + | **SSH Key** | Choose the desired SSH key. Refer to the [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to Palette. | | **Static Placement** | Check the **Static Placement** box to deploy resources into a pre-existing VPC. Review the [Static Placement](#static-placement) table below to learn more about the required input fields. | #### Static Placement diff --git a/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md b/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md index dcdeba215f..fc5cc1251c 100644 --- a/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md +++ b/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md @@ -64,7 +64,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster Config** section allows you to select the **Subscription**, **Region**, **Resource Group**, **Storage account**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../../clusters/cluster-management/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key. When you are done selecting a **Subscription**, **Region**, **Resource Group**, **Storage account** and **SSH Key**, click on **Next**. diff --git a/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md b/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md index 4d155d27db..7f419ed522 100644 --- a/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md +++ b/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md @@ -46,7 +46,7 @@ To complete this tutorial, you will need the following prerequisites in place. - A Palette API key. Refer to the [Create API Key](../../../user-management/authentication/api-key/create-api-key.md) page for instructions on how to create an API key. - A [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) user account with the [required permissions](../../../clusters/data-center/vmware/permissions.md). - A Linux x86-64 machine with access to a terminal and Internet, as well as connection to both Palette and VMware vSphere. - - An SSH key pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys.md) guide to learn how to create an SSH key and upload it to Palette. + - An SSH key pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload it to Palette. - The following IP address requirements must be met in your VMware vSphere environment: - One IP address available for the single-node PCG deployment. Refer to the [PCG Sizing](../../../clusters/pcg/manage-pcg/scale-pcg-nodes.md) section for more information on sizing. - One IP address reserved for cluster repave operations. diff --git a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md index bcbedb2aa3..db84cff65f 100644 --- a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md @@ -69,7 +69,7 @@ To complete this tutorial, you will need the following.
-- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys.md) guide to +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the @@ -348,7 +348,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster config** section allows you to select the **Subscription**, **Region**, **Resource Group**, **Storage account**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../../../clusters/cluster-management/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key.
@@ -515,7 +515,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster config** section allows you to select the **Project**, **Region**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../../../clusters/cluster-management/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key.
diff --git a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md index c807595c25..412cb8b2de 100644 --- a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md @@ -49,7 +49,7 @@ complete it, you will need the following items. - [Register and Manage Azure Cloud Accounts](../../../clusters/public-cloud/azure/azure-cloud.md) - [Register and Manage GCP Accounts](../../../clusters/public-cloud/gcp/add-gcp-accounts.md) -- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys.md) guide to +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the From 93984475e1ad9d6eddf390f6dc9c10c807c26992 Mon Sep 17 00:00:00 2001 From: benradstone Date: Thu, 2 Jan 2025 15:08:51 +0000 Subject: [PATCH 10/22] ci: auto-formatting prettier issues --- .../crossplane/deploy-cluster-azure-crossplane.md | 4 ++-- .../crossplane/deploy-cluster-gcp-crossplane.md | 4 ++-- .../cluster-management/ssh-keys/ssh-usernames.md | 3 +-- .../vmware/create-manage-vmware-clusters.md | 14 +++++++------- .../clusters/public-cloud/azure/aks.md | 4 ++-- .../public-cloud/azure/create-azure-cluster.md | 4 ++-- .../clusters/public-cloud/deploy-k8s-cluster.md | 4 ++-- .../public-cloud/gcp/create-gcp-iaas-cluster.md | 2 +- .../public-cloud/deploy-k8s-cluster.md | 4 ++-- .../update-maintain/update-k8s-cluster.md | 4 ++-- 10 files changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md index 294989257d..39d57838c0 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md @@ -18,8 +18,8 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in Azure. API key. - A public [Azure](https://learn.microsoft.com/en-us/training/modules/create-an-azure-account) cloud account with the required [permissions](../../clusters/public-cloud/azure/required-permissions.md). -- An SSH key pair available. Check out the [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) - page for guidance. +- An SSH key pair available. Check out the + [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. - The Azure account must be registered in Palette. Follow the [Register and Manage Azure Cloud Account](../../clusters/public-cloud/azure/azure-cloud.md) guide to register your account in Palette. diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md index 7613fd551e..1debde60c2 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md @@ -18,8 +18,8 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in GCP. API key. - A public [GCP](https://cloud.google.com/iam/docs/creating-managing-service-accounts) service account with the required [roles](../../clusters/public-cloud/gcp/add-gcp-accounts.md#prerequisites). -- An SSH key pair available. Check out the [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) - page for guidance. +- An SSH key pair available. Check out the + [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. - The GCP account must be registered in Palette. Follow the [Register and Manage GCP Accounts](../../clusters/public-cloud/gcp/add-gcp-accounts.md) guide to register your account in Palette. diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index 63b4f3f18c..3073d3936f 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -12,8 +12,7 @@ sidebar_position: 11 This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and operating system. -These user names are relevant when using [SSH key pairs](./ssh-keys.md) with your Palette -host clusters. +These user names are relevant when using [SSH key pairs](./ssh-keys.md) with your Palette host clusters. ## Public Cloud diff --git a/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md index 34ddb81005..f55631d392 100644 --- a/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md +++ b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md @@ -89,14 +89,14 @@ Before you begin, ensure that you have the following prerequisites: 8. Fill out the VMware vSphere configuration details for the cluster. Refer to the table below to learn more about each option. Click **Next** to proceed. - | Field Name | Description | Required | - | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | - | **Datacenter** | The VMware vSphere datacenter where the cluster and its nodes will be deployed. | Yes | - | **Deployment Folder** | The folder in the datacenter where the cluster and its nodes will be deployed. Check the box **Append cluster name** if you want the cluster name appended to the folder name. | Yes | - | **Image Template Folder** | The folder in the datacenter where the image templates are stored. This is typically in the **spectro-templates** folder. | Yes | - | **Network Type** | The network type to use for the cluster. Select **Static IP** if you want to use static IP addresses. Select **DHCP** if you want to use Dynamic Host Configuration Protocol (DHCP). | Yes | + | Field Name | Description | Required | + | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | + | **Datacenter** | The VMware vSphere datacenter where the cluster and its nodes will be deployed. | Yes | + | **Deployment Folder** | The folder in the datacenter where the cluster and its nodes will be deployed. Check the box **Append cluster name** if you want the cluster name appended to the folder name. | Yes | + | **Image Template Folder** | The folder in the datacenter where the image templates are stored. This is typically in the **spectro-templates** folder. | Yes | + | **Network Type** | The network type to use for the cluster. Select **Static IP** if you want to use static IP addresses. Select **DHCP** if you want to use Dynamic Host Configuration Protocol (DHCP). | Yes | | **SSH Key** | The SSH key to use for the cluster. Check out the [Create and Upload an SSH Key](../../cluster-management/ssh-keys/ssh-keys.md#create-and-upload-an-ssh-key) guide to learn how to upload an SSH key to Palette. | No | - | **NTP Servers** | The Network Time Protocol (NTP) servers to use for the cluster. | No | + | **NTP Servers** | The Network Time Protocol (NTP) servers to use for the cluster. | No | :::warning diff --git a/docs/docs-content/clusters/public-cloud/azure/aks.md b/docs/docs-content/clusters/public-cloud/azure/aks.md index ab96b3aee3..14c064533b 100644 --- a/docs/docs-content/clusters/public-cloud/azure/aks.md +++ b/docs/docs-content/clusters/public-cloud/azure/aks.md @@ -16,8 +16,8 @@ explains how you can create an Azure AKS cluster managed by Palette. [Register and Manage Azure Cloud Account](./azure-cloud.md) for guidance. - A Secure Shell (SSH) key that you have pre-configured in your Azure environment. Refer to the - [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH keys in - Palette. + [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH + keys in Palette. - An infrastructure cluster profile for Azure. Review [Create an Infrastructure Profile](../../../profiles/cluster-profiles/create-cluster-profiles/create-infrastructure-profile.md) diff --git a/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md b/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md index 7246340009..d01e80cdfc 100644 --- a/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md +++ b/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md @@ -28,8 +28,8 @@ to create an IaaS Kubernetes cluster in Azure that Palette manages. - Palette integration with Azure account. Review [Register and Manage Azure Cloud Account](azure-cloud.md) for guidance. - A Secure Shell (SSH) key pre-configured in your Azure environment. Refer to the - [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH keys in - Palette. + [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH + keys in Palette. - An infrastructure cluster profile for Azure. Review [Create an Infrastructure Profile](../../../profiles/cluster-profiles/create-cluster-profiles/create-infrastructure-profile.md) diff --git a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md index 6dfd1ebafe..b3c22eb874 100644 --- a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md @@ -71,8 +71,8 @@ To complete this tutorial, you will need the following.
-- An SSH Key Pair. Use the [Create and Upload an SSH Key](../cluster-management/ssh-keys/ssh-keys.md) guide to learn how to - create an SSH key and upload it to Palette. +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../cluster-management/ssh-keys/ssh-keys.md) guide to learn how + to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the [Create EC2 SSH Key Pair](https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html) diff --git a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md index 7ddcb491b4..2e3c75d9fd 100644 --- a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md +++ b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md @@ -69,7 +69,7 @@ Ensure the following requirements are met before you attempt to deploy a cluster | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Project** | The project to which the cluster belongs. | | **Region** | Choose the desired GCP region to deploy the cluster. | - | **SSH Key** | Choose the desired SSH key. Refer to the [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to Palette. | + | **SSH Key** | Choose the desired SSH key. Refer to the [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to Palette. | | **Static Placement** | Check the **Static Placement** box to deploy resources into a pre-existing VPC. Review the [Static Placement](#static-placement) table below to learn more about the required input fields. | #### Static Placement diff --git a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md index db84cff65f..b2a74f4fd3 100644 --- a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md @@ -69,8 +69,8 @@ To complete this tutorial, you will need the following.
-- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide to - learn how to create an SSH key and upload it to Palette. +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) + guide to learn how to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the [Create EC2 SSH Key Pair](https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html) diff --git a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md index 412cb8b2de..9294aa10eb 100644 --- a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md @@ -49,8 +49,8 @@ complete it, you will need the following items. - [Register and Manage Azure Cloud Accounts](../../../clusters/public-cloud/azure/azure-cloud.md) - [Register and Manage GCP Accounts](../../../clusters/public-cloud/gcp/add-gcp-accounts.md) -- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide to - learn how to create an SSH key and upload it to Palette. +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) + guide to learn how to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the [Create EC2 SSH Key Pair](https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html) From a37fcc4ee9b2499de9d1b66ae363ec2aea50c674 Mon Sep 17 00:00:00 2001 From: Ben Radstone <56587332+benradstone@users.noreply.github.com> Date: Thu, 2 Jan 2025 15:13:39 +0000 Subject: [PATCH 11/22] docs: fix legacy spelling mistakes --- .../automation/crossplane/deploy-cluster-azure-crossplane.md | 2 +- .../automation/crossplane/deploy-cluster-gcp-crossplane.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md index 39d57838c0..abc61371c1 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md @@ -19,7 +19,7 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in Azure. - A public [Azure](https://learn.microsoft.com/en-us/training/modules/create-an-azure-account) cloud account with the required [permissions](../../clusters/public-cloud/azure/required-permissions.md). - An SSH key pair available. Check out the - [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. + [Create and Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. - The Azure account must be registered in Palette. Follow the [Register and Manage Azure Cloud Account](../../clusters/public-cloud/azure/azure-cloud.md) guide to register your account in Palette. diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md index 1debde60c2..5d8252f683 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md @@ -19,7 +19,7 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in GCP. - A public [GCP](https://cloud.google.com/iam/docs/creating-managing-service-accounts) service account with the required [roles](../../clusters/public-cloud/gcp/add-gcp-accounts.md#prerequisites). - An SSH key pair available. Check out the - [Create an Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. + [Create and Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. - The GCP account must be registered in Palette. Follow the [Register and Manage GCP Accounts](../../clusters/public-cloud/gcp/add-gcp-accounts.md) guide to register your account in Palette. From f8a01bc5e53ebdc8cdad0592fd34d5a27ca1b22c Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Thu, 2 Jan 2025 17:06:32 +0000 Subject: [PATCH 12/22] docs: root username for BYO-OS --- .../ssh-keys/ssh-usernames.md | 44 +++++++++++-------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index 3073d3936f..fafe7ef6e6 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -18,22 +18,25 @@ These user names are relevant when using [SSH key pairs](./ssh-keys.md) with you ### Infrastructure Provider -| Provider | Operating System Pack | SSH Username | -| -------------- | --------------------- | ------------ | -| **AWS IaaS** | **Ubuntu** | `ubuntu` | -| **AWS IaaS** | **CentOS** | `centos` | -| **Azure IaaS** | **Ubuntu** | `ubuntu` | -| **Azure IaaS** | **CentOS** | `centos` | -| **GCP IaaS** | **Ubuntu** | `ubuntu` | -| **GCP IaaS** | **CentOS** | `centos` | +| Provider | Operating System Pack | SSH Username | +| -------------- | ------------------------------ | ------------ | +| **AWS IaaS** | **Ubuntu** | `ubuntu` | +| **AWS IaaS** | **CentOS** | `centos` | +| **AWS IaaS** | **Bring Your Own OS (BYO-OS)** | `root` | +| **Azure IaaS** | **Ubuntu** | `ubuntu` | +| **Azure IaaS** | **CentOS** | `centos` | +| **Azure IaaS** | **Bring Your Own OS (BYO-OS)** | `root` | +| **GCP IaaS** | **Ubuntu** | `ubuntu` | +| **GCP IaaS** | **CentOS** | `centos` | +| **GCP IaaS** | **Bring Your Own OS (BYO-OS)** | `root` | ### Managed Kubernetes -| Provider | Operating System Pack | SSH Username | -| ------------- | ------------------------------ | ------------ | -| **AWS EKS** | **Amazon EKS optimized Linux** | `ec2-user` | -| **Azure AKS** | **Linux** | `azureuser` | -| **GCP GKE** | **Container-Optimized OS** | N/A | +| Provider | Operating System Pack | SSH Username | +| ------------- | ------------------------------ | ----------------------------------------------------------------------------------- | +| **AWS EKS** | **Amazon EKS optimized Linux** | `ec2-user` | +| **Azure AKS** | **Linux** | `azureuser` | +| **GCP GKE** | **Container-Optimized OS** | Refer to the [SSH Configuration on GCP GKE](#ssh-configuration-on-gcp-gke) section. | #### SSH Configuration on GCP GKE @@ -53,12 +56,15 @@ nodes is critical, consider one of the following options: ## Data Center -| Provider | Operating System Pack | SSH Username | -| ------------------ | --------------------- | ------------ | -| **MAAS** | **Ubuntu** | `ubuntu` | -| **Openstack** | **Ubuntu** | `ubuntu` | -| **VMware vSphere** | **Ubuntu** | `ubuntu` | -| **VMware vSphere** | **CentOS** | `centos` | +| Provider | Operating System Pack | SSH Username | +| ------------------ | ------------------------------ | ------------ | +| **MAAS** | **Ubuntu** | `ubuntu` | +| **MAAS** | **Bring Your Own OS (BYO-OS)** | `root` | +| **Openstack** | **Ubuntu** | `ubuntu` | +| **Openstack** | **Bring Your Own OS (BYO-OS)** | `root` | +| **VMware vSphere** | **Ubuntu** | `ubuntu` | +| **VMware vSphere** | **CentOS** | `centos` | +| **VMware vSphere** | **Bring Your Own OS (BYO-OS)** | `root` | ## Edge From b604b1c286f3a5e85ae6993e948d10ef2190dfde Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Thu, 2 Jan 2025 17:40:17 +0000 Subject: [PATCH 13/22] docs: remove script workaround for GCP GKE --- .../clusters/cluster-management/ssh-keys/ssh-usernames.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index fafe7ef6e6..9b51a48109 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -50,10 +50,6 @@ nodes is critical, consider one of the following options: - Enable OS Login and associate your SSH key with your IAM identity. Refer to [How OS Login works](https://cloud.google.com/compute/docs/oslogin#how_os_login_works) for guidance. -- Customize startup scripts or metadata to add your SSH key during node creation in a managed instance group. Refer to - [Using startup scripts on Linux VMs](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) for - guidance. - ## Data Center | Provider | Operating System Pack | SSH Username | From 85d17e1944f015a4f0f35ef3041c640a8dd9f8d2 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Wed, 8 Jan 2025 12:45:50 +0000 Subject: [PATCH 14/22] docs: update based on recent testing --- .../ssh-keys/ssh-usernames.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index 9b51a48109..eba1d8d1da 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -22,13 +22,10 @@ These user names are relevant when using [SSH key pairs](./ssh-keys.md) with you | -------------- | ------------------------------ | ------------ | | **AWS IaaS** | **Ubuntu** | `ubuntu` | | **AWS IaaS** | **CentOS** | `centos` | -| **AWS IaaS** | **Bring Your Own OS (BYO-OS)** | `root` | | **Azure IaaS** | **Ubuntu** | `ubuntu` | | **Azure IaaS** | **CentOS** | `centos` | -| **Azure IaaS** | **Bring Your Own OS (BYO-OS)** | `root` | | **GCP IaaS** | **Ubuntu** | `ubuntu` | | **GCP IaaS** | **CentOS** | `centos` | -| **GCP IaaS** | **Bring Your Own OS (BYO-OS)** | `root` | ### Managed Kubernetes @@ -55,12 +52,9 @@ nodes is critical, consider one of the following options: | Provider | Operating System Pack | SSH Username | | ------------------ | ------------------------------ | ------------ | | **MAAS** | **Ubuntu** | `ubuntu` | -| **MAAS** | **Bring Your Own OS (BYO-OS)** | `root` | | **Openstack** | **Ubuntu** | `ubuntu` | -| **Openstack** | **Bring Your Own OS (BYO-OS)** | `root` | -| **VMware vSphere** | **Ubuntu** | `ubuntu` | -| **VMware vSphere** | **CentOS** | `centos` | -| **VMware vSphere** | **Bring Your Own OS (BYO-OS)** | `root` | +| **VMware vSphere** | **Ubuntu** | `spectro` | +| **VMware vSphere** | **CentOS** | `spectro` | ## Edge @@ -68,6 +62,16 @@ This is dependent on the operating system you provide for your edge hosts using [Agent Mode](../../../deployment-modes/agent-mode/agent-mode.md) or [EdgeForge](../../../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). +## Bring Your Own OS (BYO-OS) + +You can select **Bring Your Own OS (BYO-OS)** as the operating system (os) pack for your cluster in Palette. The default SSH username will depend on the operating system image that you have built. Refer to [Bring Your Own OS (BYOOS)](../../../byoos/byoos.md) for further guidance on building custom images. + +- For images built using the [Kubernetes Image Builder](../../../byoos/image-builder/build-image.md), the SSH username is defined as the value for `ssh_username` in the corresponding operating system JSON file. For example, the [Amazon Linux 2 JSON](https://github.com/kubernetes-sigs/image-builder/blob/main/images/capi/packer/ami/amazon-2.json#L11) sets the `ssh_username` value as `ec2-user`. + + If `ssh_username` is not defined in the operating system JSON, then `root` is set by default. + +- For images built for VMware vSphere, the `ssh_username` is set to `spectro`. + ## Resources - [SSH Keys](./ssh-keys.md) From 7ab244158f6a2dbfc26277485b355ecdec307127 Mon Sep 17 00:00:00 2001 From: benradstone Date: Wed, 8 Jan 2025 12:49:23 +0000 Subject: [PATCH 15/22] ci: auto-formatting prettier issues --- .../ssh-keys/ssh-usernames.md | 37 +++++++++++-------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index eba1d8d1da..14cb54f314 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -18,14 +18,14 @@ These user names are relevant when using [SSH key pairs](./ssh-keys.md) with you ### Infrastructure Provider -| Provider | Operating System Pack | SSH Username | -| -------------- | ------------------------------ | ------------ | -| **AWS IaaS** | **Ubuntu** | `ubuntu` | -| **AWS IaaS** | **CentOS** | `centos` | -| **Azure IaaS** | **Ubuntu** | `ubuntu` | -| **Azure IaaS** | **CentOS** | `centos` | -| **GCP IaaS** | **Ubuntu** | `ubuntu` | -| **GCP IaaS** | **CentOS** | `centos` | +| Provider | Operating System Pack | SSH Username | +| -------------- | --------------------- | ------------ | +| **AWS IaaS** | **Ubuntu** | `ubuntu` | +| **AWS IaaS** | **CentOS** | `centos` | +| **Azure IaaS** | **Ubuntu** | `ubuntu` | +| **Azure IaaS** | **CentOS** | `centos` | +| **GCP IaaS** | **Ubuntu** | `ubuntu` | +| **GCP IaaS** | **CentOS** | `centos` | ### Managed Kubernetes @@ -49,12 +49,12 @@ nodes is critical, consider one of the following options: ## Data Center -| Provider | Operating System Pack | SSH Username | -| ------------------ | ------------------------------ | ------------ | -| **MAAS** | **Ubuntu** | `ubuntu` | -| **Openstack** | **Ubuntu** | `ubuntu` | -| **VMware vSphere** | **Ubuntu** | `spectro` | -| **VMware vSphere** | **CentOS** | `spectro` | +| Provider | Operating System Pack | SSH Username | +| ------------------ | --------------------- | ------------ | +| **MAAS** | **Ubuntu** | `ubuntu` | +| **Openstack** | **Ubuntu** | `ubuntu` | +| **VMware vSphere** | **Ubuntu** | `spectro` | +| **VMware vSphere** | **CentOS** | `spectro` | ## Edge @@ -64,9 +64,14 @@ This is dependent on the operating system you provide for your edge hosts using ## Bring Your Own OS (BYO-OS) -You can select **Bring Your Own OS (BYO-OS)** as the operating system (os) pack for your cluster in Palette. The default SSH username will depend on the operating system image that you have built. Refer to [Bring Your Own OS (BYOOS)](../../../byoos/byoos.md) for further guidance on building custom images. +You can select **Bring Your Own OS (BYO-OS)** as the operating system (os) pack for your cluster in Palette. The default +SSH username will depend on the operating system image that you have built. Refer to +[Bring Your Own OS (BYOOS)](../../../byoos/byoos.md) for further guidance on building custom images. -- For images built using the [Kubernetes Image Builder](../../../byoos/image-builder/build-image.md), the SSH username is defined as the value for `ssh_username` in the corresponding operating system JSON file. For example, the [Amazon Linux 2 JSON](https://github.com/kubernetes-sigs/image-builder/blob/main/images/capi/packer/ami/amazon-2.json#L11) sets the `ssh_username` value as `ec2-user`. +- For images built using the [Kubernetes Image Builder](../../../byoos/image-builder/build-image.md), the SSH username + is defined as the value for `ssh_username` in the corresponding operating system JSON file. For example, the + [Amazon Linux 2 JSON](https://github.com/kubernetes-sigs/image-builder/blob/main/images/capi/packer/ami/amazon-2.json#L11) + sets the `ssh_username` value as `ec2-user`. If `ssh_username` is not defined in the operating system JSON, then `root` is set by default. From 83d0e095eca644a6704c4b59652206b222a3c053 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Wed, 8 Jan 2025 13:31:18 +0000 Subject: [PATCH 16/22] docs: clarify what sets vSphere username --- .../clusters/cluster-management/ssh-keys/ssh-usernames.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index 14cb54f314..7c4632efe8 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -75,7 +75,7 @@ SSH username will depend on the operating system image that you have built. Refe If `ssh_username` is not defined in the operating system JSON, then `root` is set by default. -- For images built for VMware vSphere, the `ssh_username` is set to `spectro`. +- For images built for VMware vSphere, the SSH username is set to `spectro` by Palette. ## Resources From 5a72c7f57a2af80e8d16cba82d9995b0f6502c1e Mon Sep 17 00:00:00 2001 From: Ben Radstone <56587332+benradstone@users.noreply.github.com> Date: Wed, 8 Jan 2025 18:53:29 +0000 Subject: [PATCH 17/22] docs: code review suggestions Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> --- .../cluster-management/ssh-keys/ssh-usernames.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index 7c4632efe8..fefc887d20 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -9,8 +9,7 @@ hide_table_of_contents: false sidebar_position: 11 --- -This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and operating -system. +This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and Operating System (OS). These user names are relevant when using [SSH key pairs](./ssh-keys.md) with your Palette host clusters. @@ -62,10 +61,10 @@ This is dependent on the operating system you provide for your edge hosts using [Agent Mode](../../../deployment-modes/agent-mode/agent-mode.md) or [EdgeForge](../../../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). -## Bring Your Own OS (BYO-OS) +## Bring Your Own OS -You can select **Bring Your Own OS (BYO-OS)** as the operating system (os) pack for your cluster in Palette. The default -SSH username will depend on the operating system image that you have built. Refer to +You can select **Bring Your Own OS (BYOOS)** as the OS pack for your cluster in Palette. The default +SSH username will depend on the OS image that you have built. Refer to [Bring Your Own OS (BYOOS)](../../../byoos/byoos.md) for further guidance on building custom images. - For images built using the [Kubernetes Image Builder](../../../byoos/image-builder/build-image.md), the SSH username @@ -73,7 +72,7 @@ SSH username will depend on the operating system image that you have built. Refe [Amazon Linux 2 JSON](https://github.com/kubernetes-sigs/image-builder/blob/main/images/capi/packer/ami/amazon-2.json#L11) sets the `ssh_username` value as `ec2-user`. - If `ssh_username` is not defined in the operating system JSON, then `root` is set by default. + If `ssh_username` is not defined in the operating system JSON, then `root` is set by the **Bring Your Own OS (BYOOS)** pack. - For images built for VMware vSphere, the SSH username is set to `spectro` by Palette. From 0fddf8ce9d57d445cb67f62f2db5708ce5cd9bb8 Mon Sep 17 00:00:00 2001 From: benradstone Date: Wed, 8 Jan 2025 18:56:40 +0000 Subject: [PATCH 18/22] ci: auto-formatting prettier issues --- .../cluster-management/ssh-keys/ssh-usernames.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index fefc887d20..b306e95494 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -9,7 +9,8 @@ hide_table_of_contents: false sidebar_position: 11 --- -This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and Operating System (OS). +This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and Operating +System (OS). These user names are relevant when using [SSH key pairs](./ssh-keys.md) with your Palette host clusters. @@ -61,18 +62,19 @@ This is dependent on the operating system you provide for your edge hosts using [Agent Mode](../../../deployment-modes/agent-mode/agent-mode.md) or [EdgeForge](../../../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). -## Bring Your Own OS +## Bring Your Own OS -You can select **Bring Your Own OS (BYOOS)** as the OS pack for your cluster in Palette. The default -SSH username will depend on the OS image that you have built. Refer to -[Bring Your Own OS (BYOOS)](../../../byoos/byoos.md) for further guidance on building custom images. +You can select **Bring Your Own OS (BYOOS)** as the OS pack for your cluster in Palette. The default SSH username will +depend on the OS image that you have built. Refer to [Bring Your Own OS (BYOOS)](../../../byoos/byoos.md) for further +guidance on building custom images. - For images built using the [Kubernetes Image Builder](../../../byoos/image-builder/build-image.md), the SSH username is defined as the value for `ssh_username` in the corresponding operating system JSON file. For example, the [Amazon Linux 2 JSON](https://github.com/kubernetes-sigs/image-builder/blob/main/images/capi/packer/ami/amazon-2.json#L11) sets the `ssh_username` value as `ec2-user`. - If `ssh_username` is not defined in the operating system JSON, then `root` is set by the **Bring Your Own OS (BYOOS)** pack. + If `ssh_username` is not defined in the operating system JSON, then `root` is set by the **Bring Your Own OS (BYOOS)** + pack. - For images built for VMware vSphere, the SSH username is set to `spectro` by Palette. From 1132d39c7834f6f8821c78b838be772eedf458c3 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Wed, 8 Jan 2025 19:05:58 +0000 Subject: [PATCH 19/22] docs: resolving content comments --- .../ssh-keys/ssh-usernames.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md index b306e95494..5e70357738 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md @@ -2,7 +2,7 @@ sidebar_label: "SSH Usernames" title: "SSH Usernames" description: - "A list of the Secure Shell (SSH) usernames created on Kubernetes nodes for each provider and operating system pack + "A list of the Secure Shell (SSH) usernames created on Kubernetes nodes for each provider and operating system (OS) pack available in Palette." icon: "" hide_table_of_contents: false @@ -16,9 +16,11 @@ These user names are relevant when using [SSH key pairs](./ssh-keys.md) with you ## Public Cloud +Public Cloud includes both Infrastructure as a Service (IaaS) and Managed Kubernetes. + ### Infrastructure Provider -| Provider | Operating System Pack | SSH Username | +| Provider | OS Pack | SSH Username | | -------------- | --------------------- | ------------ | | **AWS IaaS** | **Ubuntu** | `ubuntu` | | **AWS IaaS** | **CentOS** | `centos` | @@ -29,7 +31,7 @@ These user names are relevant when using [SSH key pairs](./ssh-keys.md) with you ### Managed Kubernetes -| Provider | Operating System Pack | SSH Username | +| Provider | OS Pack | SSH Username | | ------------- | ------------------------------ | ----------------------------------------------------------------------------------- | | **AWS EKS** | **Amazon EKS optimized Linux** | `ec2-user` | | **Azure AKS** | **Linux** | `azureuser` | @@ -49,7 +51,7 @@ nodes is critical, consider one of the following options: ## Data Center -| Provider | Operating System Pack | SSH Username | +| Provider | OS Pack | SSH Username | | ------------------ | --------------------- | ------------ | | **MAAS** | **Ubuntu** | `ubuntu` | | **Openstack** | **Ubuntu** | `ubuntu` | @@ -58,10 +60,12 @@ nodes is critical, consider one of the following options: ## Edge -This is dependent on the operating system you provide for your edge hosts using either +This is dependent on the OS you provide for your edge hosts using either [Agent Mode](../../../deployment-modes/agent-mode/agent-mode.md) or [EdgeForge](../../../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). +If using EdgeForge, you can also create custom users and assign SSH keys to them using cloud-init stages. Refer to [Cloud Init Stages](../../edge/edge-configuration/cloud-init.md#assign-an-ssh-key) for an example. + ## Bring Your Own OS You can select **Bring Your Own OS (BYOOS)** as the OS pack for your cluster in Palette. The default SSH username will @@ -69,12 +73,11 @@ depend on the OS image that you have built. Refer to [Bring Your Own OS (BYOOS)] guidance on building custom images. - For images built using the [Kubernetes Image Builder](../../../byoos/image-builder/build-image.md), the SSH username - is defined as the value for `ssh_username` in the corresponding operating system JSON file. For example, the + is defined as the value for `ssh_username` in the corresponding OS JSON file. For example, the [Amazon Linux 2 JSON](https://github.com/kubernetes-sigs/image-builder/blob/main/images/capi/packer/ami/amazon-2.json#L11) sets the `ssh_username` value as `ec2-user`. - If `ssh_username` is not defined in the operating system JSON, then `root` is set by the **Bring Your Own OS (BYOOS)** - pack. + If `ssh_username` is not defined in the OS JSON, then `root` is set by the **Bring Your Own OS (BYOOS)** pack. - For images built for VMware vSphere, the SSH username is set to `spectro` by Palette. From 989ab2a3038846bf187937322e98941dd71d2df3 Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Wed, 8 Jan 2025 19:31:30 +0000 Subject: [PATCH 20/22] docs: index page for SSH --- .../deploy-cluster-azure-crossplane.md | 2 +- .../deploy-cluster-gcp-crossplane.md | 2 +- .../{ssh-keys => ssh}/_category_.json | 0 .../{ssh-keys => ssh}/ssh-keys.md | 3 +- .../{ssh-keys => ssh}/ssh-usernames.md | 39 ++++++++++--------- .../clusters/cluster-management/ssh/ssh.md | 19 +++++++++ .../vmware/create-manage-vmware-clusters.md | 16 ++++---- .../clusters/public-cloud/azure/aks.md | 4 +- .../azure/create-azure-cluster.md | 4 +- .../public-cloud/deploy-k8s-cluster.md | 6 +-- .../gcp/create-gcp-iaas-cluster.md | 2 +- .../azure/deploy-k8s-cluster.md | 2 +- .../cluster-deployment/pcg/deploy-app-pcg.md | 2 +- .../public-cloud/deploy-k8s-cluster.md | 8 ++-- .../update-maintain/update-k8s-cluster.md | 4 +- 15 files changed, 66 insertions(+), 47 deletions(-) rename docs/docs-content/clusters/cluster-management/{ssh-keys => ssh}/_category_.json (100%) rename docs/docs-content/clusters/cluster-management/{ssh-keys => ssh}/ssh-keys.md (86%) rename docs/docs-content/clusters/cluster-management/{ssh-keys => ssh}/ssh-usernames.md (73%) create mode 100644 docs/docs-content/clusters/cluster-management/ssh/ssh.md diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md index abc61371c1..d8313ff9c1 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-azure-crossplane.md @@ -19,7 +19,7 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in Azure. - A public [Azure](https://learn.microsoft.com/en-us/training/modules/create-an-azure-account) cloud account with the required [permissions](../../clusters/public-cloud/azure/required-permissions.md). - An SSH key pair available. Check out the - [Create and Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. + [Create and Upload an SSH Key](../../clusters/cluster-management/ssh/ssh-keys.md) page for guidance. - The Azure account must be registered in Palette. Follow the [Register and Manage Azure Cloud Account](../../clusters/public-cloud/azure/azure-cloud.md) guide to register your account in Palette. diff --git a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md index 5d8252f683..090781fb84 100644 --- a/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md +++ b/docs/docs-content/automation/crossplane/deploy-cluster-gcp-crossplane.md @@ -19,7 +19,7 @@ how to use Crossplane to deploy a Palette-managed Kubernetes cluster in GCP. - A public [GCP](https://cloud.google.com/iam/docs/creating-managing-service-accounts) service account with the required [roles](../../clusters/public-cloud/gcp/add-gcp-accounts.md#prerequisites). - An SSH key pair available. Check out the - [Create and Upload an SSH Key](../../clusters/cluster-management/ssh-keys/ssh-keys.md) page for guidance. + [Create and Upload an SSH Key](../../clusters/cluster-management/ssh/ssh-keys.md) page for guidance. - The GCP account must be registered in Palette. Follow the [Register and Manage GCP Accounts](../../clusters/public-cloud/gcp/add-gcp-accounts.md) guide to register your account in Palette. diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/_category_.json b/docs/docs-content/clusters/cluster-management/ssh/_category_.json similarity index 100% rename from docs/docs-content/clusters/cluster-management/ssh-keys/_category_.json rename to docs/docs-content/clusters/cluster-management/ssh/_category_.json diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-keys.md b/docs/docs-content/clusters/cluster-management/ssh/ssh-keys.md similarity index 86% rename from docs/docs-content/clusters/cluster-management/ssh-keys/ssh-keys.md rename to docs/docs-content/clusters/cluster-management/ssh/ssh-keys.md index 0373cc2e88..6978c4733d 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-keys.md +++ b/docs/docs-content/clusters/cluster-management/ssh/ssh-keys.md @@ -7,8 +7,7 @@ sidebar_position: 10 tags: ["clusters", "cluster management"] --- -Palette supports SSH (Secure Shell) to establish, administer, and communicate with remote clusters. This section -describes creating and managing SSH Keys in the Palette Management Console. +This section describes creating and managing SSH Keys in the Palette Management Console. ## Scope of SSH Key diff --git a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md b/docs/docs-content/clusters/cluster-management/ssh/ssh-usernames.md similarity index 73% rename from docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md rename to docs/docs-content/clusters/cluster-management/ssh/ssh-usernames.md index 5e70357738..c7a8239dee 100644 --- a/docs/docs-content/clusters/cluster-management/ssh-keys/ssh-usernames.md +++ b/docs/docs-content/clusters/cluster-management/ssh/ssh-usernames.md @@ -2,11 +2,11 @@ sidebar_label: "SSH Usernames" title: "SSH Usernames" description: - "A list of the Secure Shell (SSH) usernames created on Kubernetes nodes for each provider and operating system (OS) pack - available in Palette." + "A list of the Secure Shell (SSH) usernames created on Kubernetes nodes for each provider and operating system (OS) + pack available in Palette." icon: "" hide_table_of_contents: false -sidebar_position: 11 +sidebar_position: 20 --- This page lists the Secure Shell (SSH) user names created on Kubernetes nodes, which vary by provider and Operating @@ -20,18 +20,18 @@ Public Cloud includes both Infrastructure as a Service (IaaS) and Managed Kubern ### Infrastructure Provider -| Provider | OS Pack | SSH Username | -| -------------- | --------------------- | ------------ | -| **AWS IaaS** | **Ubuntu** | `ubuntu` | -| **AWS IaaS** | **CentOS** | `centos` | -| **Azure IaaS** | **Ubuntu** | `ubuntu` | -| **Azure IaaS** | **CentOS** | `centos` | -| **GCP IaaS** | **Ubuntu** | `ubuntu` | -| **GCP IaaS** | **CentOS** | `centos` | +| Provider | OS Pack | SSH Username | +| -------------- | ---------- | ------------ | +| **AWS IaaS** | **Ubuntu** | `ubuntu` | +| **AWS IaaS** | **CentOS** | `centos` | +| **Azure IaaS** | **Ubuntu** | `ubuntu` | +| **Azure IaaS** | **CentOS** | `centos` | +| **GCP IaaS** | **Ubuntu** | `ubuntu` | +| **GCP IaaS** | **CentOS** | `centos` | ### Managed Kubernetes -| Provider | OS Pack | SSH Username | +| Provider | OS Pack | SSH Username | | ------------- | ------------------------------ | ----------------------------------------------------------------------------------- | | **AWS EKS** | **Amazon EKS optimized Linux** | `ec2-user` | | **Azure AKS** | **Linux** | `azureuser` | @@ -51,12 +51,12 @@ nodes is critical, consider one of the following options: ## Data Center -| Provider | OS Pack | SSH Username | -| ------------------ | --------------------- | ------------ | -| **MAAS** | **Ubuntu** | `ubuntu` | -| **Openstack** | **Ubuntu** | `ubuntu` | -| **VMware vSphere** | **Ubuntu** | `spectro` | -| **VMware vSphere** | **CentOS** | `spectro` | +| Provider | OS Pack | SSH Username | +| ------------------ | ---------- | ------------ | +| **MAAS** | **Ubuntu** | `ubuntu` | +| **Openstack** | **Ubuntu** | `ubuntu` | +| **VMware vSphere** | **Ubuntu** | `spectro` | +| **VMware vSphere** | **CentOS** | `spectro` | ## Edge @@ -64,7 +64,8 @@ This is dependent on the OS you provide for your edge hosts using either [Agent Mode](../../../deployment-modes/agent-mode/agent-mode.md) or [EdgeForge](../../../clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md). -If using EdgeForge, you can also create custom users and assign SSH keys to them using cloud-init stages. Refer to [Cloud Init Stages](../../edge/edge-configuration/cloud-init.md#assign-an-ssh-key) for an example. +If using EdgeForge, you can also create custom users and assign SSH keys to them using cloud-init stages. Refer to +[Cloud Init Stages](../../edge/edge-configuration/cloud-init.md#assign-an-ssh-key) for an example. ## Bring Your Own OS diff --git a/docs/docs-content/clusters/cluster-management/ssh/ssh.md b/docs/docs-content/clusters/cluster-management/ssh/ssh.md new file mode 100644 index 0000000000..603e684986 --- /dev/null +++ b/docs/docs-content/clusters/cluster-management/ssh/ssh.md @@ -0,0 +1,19 @@ +--- +sidebar_label: "SSH" +title: "SSH" +description: + "Learn how to use Palette to manage your Secure Shell (SSH) keys and the usernames created when deploying clusters." +icon: "" +hide_table_of_contents: false +sidebar_position: 1 +--- + +Palette supports SSH (Secure Shell) to establish, administer, and communicate with remote clusters. + +You can deploy SSH keys to your cluster nodes using Palette. The SSH username used for key deployment depends on your +provider and operating system. + +## Resources + +- [SSH Keys](./ssh-keys.md) +- [SSH Usernames](./ssh-usernames.md) diff --git a/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md index f55631d392..2decac2057 100644 --- a/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md +++ b/docs/docs-content/clusters/data-center/vmware/create-manage-vmware-clusters.md @@ -89,14 +89,14 @@ Before you begin, ensure that you have the following prerequisites: 8. Fill out the VMware vSphere configuration details for the cluster. Refer to the table below to learn more about each option. Click **Next** to proceed. - | Field Name | Description | Required | - | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | - | **Datacenter** | The VMware vSphere datacenter where the cluster and its nodes will be deployed. | Yes | - | **Deployment Folder** | The folder in the datacenter where the cluster and its nodes will be deployed. Check the box **Append cluster name** if you want the cluster name appended to the folder name. | Yes | - | **Image Template Folder** | The folder in the datacenter where the image templates are stored. This is typically in the **spectro-templates** folder. | Yes | - | **Network Type** | The network type to use for the cluster. Select **Static IP** if you want to use static IP addresses. Select **DHCP** if you want to use Dynamic Host Configuration Protocol (DHCP). | Yes | - | **SSH Key** | The SSH key to use for the cluster. Check out the [Create and Upload an SSH Key](../../cluster-management/ssh-keys/ssh-keys.md#create-and-upload-an-ssh-key) guide to learn how to upload an SSH key to Palette. | No | - | **NTP Servers** | The Network Time Protocol (NTP) servers to use for the cluster. | No | + | Field Name | Description | Required | + | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | + | **Datacenter** | The VMware vSphere datacenter where the cluster and its nodes will be deployed. | Yes | + | **Deployment Folder** | The folder in the datacenter where the cluster and its nodes will be deployed. Check the box **Append cluster name** if you want the cluster name appended to the folder name. | Yes | + | **Image Template Folder** | The folder in the datacenter where the image templates are stored. This is typically in the **spectro-templates** folder. | Yes | + | **Network Type** | The network type to use for the cluster. Select **Static IP** if you want to use static IP addresses. Select **DHCP** if you want to use Dynamic Host Configuration Protocol (DHCP). | Yes | + | **SSH Key** | The SSH key to use for the cluster. Check out the [Create and Upload an SSH Key](../../cluster-management/ssh/ssh-keys.md#create-and-upload-an-ssh-key) guide to learn how to upload an SSH key to Palette. | No | + | **NTP Servers** | The Network Time Protocol (NTP) servers to use for the cluster. | No | :::warning diff --git a/docs/docs-content/clusters/public-cloud/azure/aks.md b/docs/docs-content/clusters/public-cloud/azure/aks.md index 14c064533b..2c0e38a65f 100644 --- a/docs/docs-content/clusters/public-cloud/azure/aks.md +++ b/docs/docs-content/clusters/public-cloud/azure/aks.md @@ -16,8 +16,8 @@ explains how you can create an Azure AKS cluster managed by Palette. [Register and Manage Azure Cloud Account](./azure-cloud.md) for guidance. - A Secure Shell (SSH) key that you have pre-configured in your Azure environment. Refer to the - [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH - keys in Palette. + [SSH Keys](../../cluster-management/ssh/ssh-keys.md) guide for more information about creating and managing SSH keys + in Palette. - An infrastructure cluster profile for Azure. Review [Create an Infrastructure Profile](../../../profiles/cluster-profiles/create-cluster-profiles/create-infrastructure-profile.md) diff --git a/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md b/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md index d01e80cdfc..146368585d 100644 --- a/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md +++ b/docs/docs-content/clusters/public-cloud/azure/create-azure-cluster.md @@ -28,8 +28,8 @@ to create an IaaS Kubernetes cluster in Azure that Palette manages. - Palette integration with Azure account. Review [Register and Manage Azure Cloud Account](azure-cloud.md) for guidance. - A Secure Shell (SSH) key pre-configured in your Azure environment. Refer to the - [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide for more information about creating and managing SSH - keys in Palette. + [SSH Keys](../../cluster-management/ssh/ssh-keys.md) guide for more information about creating and managing SSH keys + in Palette. - An infrastructure cluster profile for Azure. Review [Create an Infrastructure Profile](../../../profiles/cluster-profiles/create-cluster-profiles/create-infrastructure-profile.md) diff --git a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md index b3c22eb874..6d8b115e19 100644 --- a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md @@ -71,8 +71,8 @@ To complete this tutorial, you will need the following.
-- An SSH Key Pair. Use the [Create and Upload an SSH Key](../cluster-management/ssh-keys/ssh-keys.md) guide to learn how - to create an SSH key and upload it to Palette. +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../cluster-management/ssh/ssh-keys.md) guide to learn how to + create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the [Create EC2 SSH Key Pair](https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html) @@ -350,7 +350,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster config** section allows you to select the **Subscription**, **Region**, **Resource Group**, **Storage account**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../cluster-management/ssh/ssh-keys.md) guide for information about uploading an SSH key.
diff --git a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md index 2e3c75d9fd..79d03a18ef 100644 --- a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md +++ b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md @@ -69,7 +69,7 @@ Ensure the following requirements are met before you attempt to deploy a cluster | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Project** | The project to which the cluster belongs. | | **Region** | Choose the desired GCP region to deploy the cluster. | - | **SSH Key** | Choose the desired SSH key. Refer to the [SSH Keys](../../cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to Palette. | + | **SSH Key** | Choose the desired SSH key. Refer to the [SSH Keys](../../cluster-management/ssh/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to Palette. | | **Static Placement** | Check the **Static Placement** box to deploy resources into a pre-existing VPC. Review the [Static Placement](#static-placement) table below to learn more about the required input fields. | #### Static Placement diff --git a/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md b/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md index fc5cc1251c..c9011415b3 100644 --- a/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md +++ b/docs/docs-content/getting-started/azure/deploy-k8s-cluster.md @@ -64,7 +64,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster Config** section allows you to select the **Subscription**, **Region**, **Resource Group**, **Storage account**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../../clusters/cluster-management/ssh/ssh-keys.md) guide for information about uploading an SSH key. When you are done selecting a **Subscription**, **Region**, **Resource Group**, **Storage account** and **SSH Key**, click on **Next**. diff --git a/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md b/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md index 7f419ed522..558877466b 100644 --- a/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md +++ b/docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md @@ -46,7 +46,7 @@ To complete this tutorial, you will need the following prerequisites in place. - A Palette API key. Refer to the [Create API Key](../../../user-management/authentication/api-key/create-api-key.md) page for instructions on how to create an API key. - A [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) user account with the [required permissions](../../../clusters/data-center/vmware/permissions.md). - A Linux x86-64 machine with access to a terminal and Internet, as well as connection to both Palette and VMware vSphere. - - An SSH key pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide to learn how to create an SSH key and upload it to Palette. + - An SSH key pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh/ssh-keys.md) guide to learn how to create an SSH key and upload it to Palette. - The following IP address requirements must be met in your VMware vSphere environment: - One IP address available for the single-node PCG deployment. Refer to the [PCG Sizing](../../../clusters/pcg/manage-pcg/scale-pcg-nodes.md) section for more information on sizing. - One IP address reserved for cluster repave operations. diff --git a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md index b2a74f4fd3..32f1c85acf 100644 --- a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md @@ -69,8 +69,8 @@ To complete this tutorial, you will need the following.
-- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) - guide to learn how to create an SSH key and upload it to Palette. +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh/ssh-keys.md) guide to + learn how to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the [Create EC2 SSH Key Pair](https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html) @@ -348,7 +348,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster config** section allows you to select the **Subscription**, **Region**, **Resource Group**, **Storage account**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../../../clusters/cluster-management/ssh/ssh-keys.md) guide for information about uploading an SSH key.
@@ -515,7 +515,7 @@ pack contains a set of default values. You can change the manifest values if nee The **Cluster config** section allows you to select the **Project**, **Region**, and **SSH Key** to apply to the host cluster. All clusters require you to assign an SSH key. Refer to the -[SSH Keys](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) guide for information about uploading an SSH key. +[SSH Keys](../../../clusters/cluster-management/ssh/ssh-keys.md) guide for information about uploading an SSH key.
diff --git a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md index 9294aa10eb..22b876a9be 100644 --- a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md @@ -49,8 +49,8 @@ complete it, you will need the following items. - [Register and Manage Azure Cloud Accounts](../../../clusters/public-cloud/azure/azure-cloud.md) - [Register and Manage GCP Accounts](../../../clusters/public-cloud/gcp/add-gcp-accounts.md) -- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh-keys/ssh-keys.md) - guide to learn how to create an SSH key and upload it to Palette. +- An SSH Key Pair. Use the [Create and Upload an SSH Key](../../../clusters/cluster-management/ssh/ssh-keys.md) guide to + learn how to create an SSH key and upload it to Palette. - AWS users must create an AWS Key pair before starting the tutorial. If you need additional guidance, check out the [Create EC2 SSH Key Pair](https://docs.aws.amazon.com/ground-station/latest/ug/create-ec2-ssh-key-pair.html) From f0039c0a62de7aab6c7c1677bc7891f3acf2633e Mon Sep 17 00:00:00 2001 From: Ben Radstone Date: Wed, 8 Jan 2025 19:53:34 +0000 Subject: [PATCH 21/22] docs: fix redirect and lingering broken links --- .../clusters/public-cloud/deploy-k8s-cluster.md | 2 +- .../clusters/public-cloud/gcp/create-gcp-iaas-cluster.md | 2 +- redirects.js | 7 +++++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md index 6d8b115e19..096eba1c1e 100644 --- a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md @@ -515,7 +515,7 @@ pack contains a set of default values. You can change the manifest values if nee #### Cluster Configuration The **Cluster config** section allows you to select the **Project**, **Region**, and **SSH Key** to apply to the host -cluster. All clusters require you to assign an SSH key. Refer to the [SSH Keys](/clusters/cluster-management/ssh-keys) +cluster. All clusters require you to assign an SSH key. Refer to the [SSH Keys](../cluster-management/ssh/ssh-keys.md) guide for information about uploading an SSH key.
diff --git a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md index 79d03a18ef..47c7c36dbb 100644 --- a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md +++ b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md @@ -23,7 +23,7 @@ Ensure the following requirements are met before you attempt to deploy a cluster for guidance. - An SSH Key that is uploaded to Palette and available for usage. Refer to the - [SSH Keys](/clusters/cluster-management/ssh-keys) guide to learn how to create an SSH key and upload the public key to + [SSH Keys](../../cluster-management/ssh/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to Palette. - Palette creates compute, network, and storage resources while provisioning Kubernetes clusters. Ensure there is diff --git a/redirects.js b/redirects.js index c24a4c3619..c37ae6392a 100644 --- a/redirects.js +++ b/redirects.js @@ -133,8 +133,11 @@ let redirects = [ to: `/devx/`, }, { - from: `/clusters/cluster-management/.ssh/`, - to: `/clusters/cluster-management/ssh-keys/`, + from: [ + `/clusters/cluster-management/.ssh/`, + `/clusters/cluster-management/ssh-keys/`, + ], + to: `/clusters/cluster-management/ssh/ssh-keys`, }, { from: `/clusters/edge/install/installer-image/`, From 88dd1ddfab87ca751befddea87fd0b43a19edf37 Mon Sep 17 00:00:00 2001 From: benradstone Date: Wed, 8 Jan 2025 19:57:24 +0000 Subject: [PATCH 22/22] ci: auto-formatting prettier issues --- .../clusters/public-cloud/gcp/create-gcp-iaas-cluster.md | 4 ++-- redirects.js | 5 +---- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md index 47c7c36dbb..a421617049 100644 --- a/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md +++ b/docs/docs-content/clusters/public-cloud/gcp/create-gcp-iaas-cluster.md @@ -23,8 +23,8 @@ Ensure the following requirements are met before you attempt to deploy a cluster for guidance. - An SSH Key that is uploaded to Palette and available for usage. Refer to the - [SSH Keys](../../cluster-management/ssh/ssh-keys.md) guide to learn how to create an SSH key and upload the public key to - Palette. + [SSH Keys](../../cluster-management/ssh/ssh-keys.md) guide to learn how to create an SSH key and upload the public key + to Palette. - Palette creates compute, network, and storage resources while provisioning Kubernetes clusters. Ensure there is sufficient capacity in the preferred GCP region to create the following resources: diff --git a/redirects.js b/redirects.js index c37ae6392a..3bd8425330 100644 --- a/redirects.js +++ b/redirects.js @@ -133,10 +133,7 @@ let redirects = [ to: `/devx/`, }, { - from: [ - `/clusters/cluster-management/.ssh/`, - `/clusters/cluster-management/ssh-keys/`, - ], + from: [`/clusters/cluster-management/.ssh/`, `/clusters/cluster-management/ssh-keys/`], to: `/clusters/cluster-management/ssh/ssh-keys`, }, {