Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
小 白蛋
Headlamp
Commits
c474e0a3
Commit
c474e0a3
authored
4 years ago
by
Joaquim Rocha
Browse files
Options
Download
Email Patches
Plain Diff
README.md: Restructure and add media
parent
79dac04e
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+38
-17
README.md
with
38 additions
and
17 deletions
+38
-17
README.md
+
38
-
17
View file @
c474e0a3
# Headlamp
# Headlamp
<img align="right" width=384 src="docs/headlamp_light.svg">
A
n easy-to-use and
versatile dashboard for
Kubernetes.
Headlamp is a
n easy-to-use and
extensible
Kubernetes
web UI
.
*⚠️ IMPORTANT:*
This is an early version of Headlamp, which is under active
development and thus subject to frequent and, potentially, breaking changes.
## Introduction / Demo
Here is an introduction video with the motivation for creating headlamp
and a brief demo of it.
Headlamp was created to be a Kubernetes web UI that has the traditional functionality of other
web UIs/dashboards available (i.e. to list and view resources) as well as other features.
<div
align=
"center"
>
<a
href=
"https://www.youtube.com/watch?v=cZEcdTOwV-A&feature=youtu.be&t=21609"
target=
"_blank"
>
<img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/media/screenshots/yt_intro.png"
width=
"400px"
>
</a>
<img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/screenshots/videos/headlamp_quick_run.gif"
width=
"80%"
>
</div>
## Features
*
Vendor independent /
G
eneric
*
Common ops for Kubernetes clusters
*
Vendor independent /
g
eneric
Kubernetes UI
*
UI controls reflecting user roles (no deletion/update if not allowed)
*
Multi-cluster
*
Extensible
*
Clean / modern UI
*
Read-write (actions based on permissions)
*
Extensible through plugins
*
Clean & modern UI
*
Works in-cluster, or locally as a desktop app
*
Cancellable creation/update/deletion operations
*
Logs, exec, and resource editor with documentation
*
Read-write / interactive (actions based on permissions)
## Screenshots
<table>
<tr>
<td
width=
"33%"
><img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/screenshots/screenshots/cluster_overview.png"
></td>
<td
width=
"33%"
><img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/screenshots/screenshots/cluster_chooser.png"
></td>
</tr>
<tr>
<td
width=
"33%"
><img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/screenshots/screenshots/nodes.png"
></td>
<td
width=
"33%"
><img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/screenshots/screenshots/resource_edition.png"
></td>
</tr>
<tr>
<td
width=
"33%"
><img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/screenshots/screenshots/editor_documentation.png"
></td>
<td
width=
"33%"
><img
src=
"https://raw.githubusercontent.com/kinvolk/headlamp/screenshots/screenshots/terminal.png"
></td>
</tr>
</table>
## Quickstart
If you want to deploy Headlamp in your cluster, check out the instructions on running it
[
in-cluster
](
./docs/installation/in-cluster.md
)
.
If you have a kube config already, you can quickly try Headlamp locally as a
[
desktop application
](
./docs/installation/desktop/_index.md
)
.
**Make sure**
you have a kube config
set up with your favorite clusters and in the default path so Headlamp can use it.
## Get involved
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
Menu
Projects
Groups
Snippets
Help