Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-887: SSH usernames #5091

Merged
merged 29 commits into from
Jan 9, 2025
Merged
Changes from 8 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
7575d5a
docs: SSH usernames draft
benradstone Dec 18, 2024
a864c46
Merge branch 'master' into DOC-887
benradstone Dec 18, 2024
d4305c8
docs: GCP GKE addition
benradstone Dec 18, 2024
396864e
docs: update based on packs JSON
benradstone Dec 19, 2024
7151851
Merge branch 'master' into DOC-887
benradstone Jan 2, 2025
2a2e4b2
docs: remove tencent
benradstone Jan 2, 2025
d9747b7
docs: miss bold providers
benradstone Jan 2, 2025
3be4f6b
docs: clean up edge description
benradstone Jan 2, 2025
38f5d86
docs: code review suggestions
benradstone Jan 2, 2025
57632ce
ci: auto-formatting prettier issues
benradstone Jan 2, 2025
3741c46
docs: move article to new location
benradstone Jan 2, 2025
9398447
ci: auto-formatting prettier issues
benradstone Jan 2, 2025
a37fcc4
docs: fix legacy spelling mistakes
benradstone Jan 2, 2025
2243ea0
Merge branch 'master' into DOC-887
benradstone Jan 2, 2025
f8a01bc
docs: root username for BYO-OS
benradstone Jan 2, 2025
b604b1c
docs: remove script workaround for GCP GKE
benradstone Jan 2, 2025
17f9a7d
Merge branch 'master' into DOC-887
benradstone Jan 3, 2025
6fd34a9
Merge branch 'master' into DOC-887
benradstone Jan 7, 2025
85d17e1
docs: update based on recent testing
benradstone Jan 8, 2025
7ab2441
ci: auto-formatting prettier issues
benradstone Jan 8, 2025
83d0e09
docs: clarify what sets vSphere username
benradstone Jan 8, 2025
ca67ccd
Merge branch 'master' into DOC-887
benradstone Jan 8, 2025
5a72c7f
docs: code review suggestions
benradstone Jan 8, 2025
0fddf8c
ci: auto-formatting prettier issues
benradstone Jan 8, 2025
1132d39
docs: resolving content comments
benradstone Jan 8, 2025
989ab2a
docs: index page for SSH
benradstone Jan 8, 2025
f0039c0
docs: fix redirect and lingering broken links
benradstone Jan 8, 2025
5237f64
Merge branch 'master' into DOC-887
benradstone Jan 8, 2025
88dd1dd
ci: auto-formatting prettier issues
benradstone Jan 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions docs/docs-content/architecture/ssh-usernames.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
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
available in Palette."
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 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 | 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:

- 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 Pack | SSH Username |
| ------------------ | --------------------- | ------------ |
| **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 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

- [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)
Loading