docs: local-cluster: Add local cluster usage tutorial #4126
Conversation
k8s-ci-robot
added
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: illume The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
added
the
size/L
Co-authored-by: William Case <williamcase@microsoft.com>
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for Headlamp's new Local Cluster feature, which enables users to create and manage Kubernetes clusters locally through the Headlamp UI without requiring prior cluster setup or cloud infrastructure.
Key Changes:
- Added complete user guide covering local cluster creation, management, and deletion workflows
- Included step-by-step tutorials with screenshots demonstrating cluster creation, application deployment, and cluster lifecycle operations
- Documented key capabilities, FAQ section, and future roadmap for the Local Cluster feature
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Developers testing apps before deploying to production | ||
| - Students and learners exploring Kubernetes for the first time | ||
|
|
||
| Whether you\'re deploying a sample app or just curious about how Kubernetes works, Headlamp now gives you a one-click experience to get started locally. |
There was a problem hiding this comment.
Escaped apostrophe should be a plain apostrophe in Markdown.
| Whether you\'re deploying a sample app or just curious about how Kubernetes works, Headlamp now gives you a one-click experience to get started locally. | |
| Whether you're deploying a sample app or just curious about how Kubernetes works, Headlamp now gives you a one-click experience to get started locally. |
| - **Install and use plugins** such as Prometheus for metrics or the AI | ||
| Assistant for natural language queries | ||
|
|
||
| These capabilities make Headlamp a powerful tool for working with Kubernetes locally, whether you\'re exploring how things work or building something new. |
There was a problem hiding this comment.
Escaped apostrophe should be a plain apostrophe in Markdown.
| <img alt="Headlamp cluster creation information showing the cluster has been created" src="https://github.com/user-attachments/assets/73251819-cc8f-457d-80d0-3b05e1e59575" /> | ||
|
|
||
|
|
||
| The cluster has been created. How do you access it from the command line? If you use kubectl on the command line you can access your cluster with that. The .kube/config file has been modified with the new cluster added. |
There was a problem hiding this comment.
The file path .kube/config should be formatted as code using backticks for better readability and consistency with other technical references in the document.
| The cluster has been created. How do you access it from the command line? If you use kubectl on the command line you can access your cluster with that. The .kube/config file has been modified with the new cluster added. | |
| The cluster has been created. How do you access it from the command line? If you use kubectl on the command line you can access your cluster with that. The `.kube/config` file has been modified with the new cluster added. |
|
|
||
| ### Delete cluster (Step 1) - select action menu for cluster you want to delete | ||
|
|
||
| <img alt="Image" src="https://github.com/user-attachments/assets/38acc668-5879-4d56-a27c-7991107af09b" /> |
There was a problem hiding this comment.
The alt text 'Image' is not descriptive. It should describe what the image shows, such as 'Cluster action menu with delete option highlighted' to improve accessibility and documentation clarity.
| <img alt="Image" src="https://github.com/user-attachments/assets/38acc668-5879-4d56-a27c-7991107af09b" /> | |
| <img alt="Cluster action menu with delete option highlighted" src="https://github.com/user-attachments/assets/38acc668-5879-4d56-a27c-7991107af09b" /> |
|
|
||
| Go to the Overview Home page, and you'll see a start and stop button. | ||
|
|
||
| <img alt="Image" src="https://github.com/user-attachments/assets/853ccb1b-32c4-4636-a335-baad0a4cfddf" /> |
There was a problem hiding this comment.
The alt text 'Image' is not descriptive. It should describe what the image shows, such as 'Cluster overview page showing start and stop buttons' to improve accessibility and documentation clarity.
| <img alt="Image" src="https://github.com/user-attachments/assets/853ccb1b-32c4-4636-a335-baad0a4cfddf" /> | |
| <img alt="Cluster overview page showing start and stop buttons" src="https://github.com/user-attachments/assets/853ccb1b-32c4-4636-a335-baad0a4cfddf" /> |
|
|
||
| <img alt="Image" src="https://github.com/user-attachments/assets/853ccb1b-32c4-4636-a335-baad0a4cfddf" /> | ||
|
|
||
| <img alt="Image" src="https://github.com/user-attachments/assets/04bbf860-1fe7-4ae3-88f2-fd3c2278ad16" /> |
There was a problem hiding this comment.
The alt text 'Image' is not descriptive. It should describe what the image shows to improve accessibility and documentation clarity.
| <img alt="Image" src="https://github.com/user-attachments/assets/04bbf860-1fe7-4ae3-88f2-fd3c2278ad16" /> | |
| <img alt="Headlamp Overview Home page showing start and stop cluster buttons" src="https://github.com/user-attachments/assets/04bbf860-1fe7-4ae3-88f2-fd3c2278ad16" /> |
2 participants
Was written here originally: