Skip to content

Commit

Permalink
add more docs and logo
Browse files Browse the repository at this point in the history
Signed-off-by: everettraven <everettraven@gmail.com>
  • Loading branch information
everettraven committed Dec 19, 2023
1 parent 0a29d09 commit 3481a27
Show file tree
Hide file tree
Showing 10 changed files with 121 additions and 13 deletions.
Binary file added .DS_Store
Binary file not shown.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# buoy

`buoy` is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window.
`buoy` is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON or YAML file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window.

> [!NOTE]
> This project is in the extremely early stages of development and is a hobby project. Use at your own risk.
Expand Down Expand Up @@ -55,12 +55,11 @@ The `test.json` file contains samples for each of the different panel types that

You can also specify a remote reference to a dashboard configuration file. It must be a valid URL and the response must be the raw YAML or JSON contents of the file.

## Controls
- `ctrl+c`, `q`, `esc` will quit the program and exit the tui
## General Controls
- `ctrl+c`, `q` will quit the program and exit the tui
- `tab` will switch the active tab to the one to the right of the currently active tab
- `shift+tab` will switch the active tab to the one to the left of the currently active tab
- up and down arrow keys and mouse scroll will move up and down in the active tab
- For tables you can use the left and right arrows to scroll horizontally
- `ctrl+h` will open a more detailed help menu


## Contributing
Expand Down
Binary file added docs/.DS_Store
Binary file not shown.
10 changes: 4 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# buoy

`buoy` is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window.
`buoy` is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON or YAML file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window.

!> This project is in the extremely early stages of development and is a hobby project. Use at your own risk

Expand Down Expand Up @@ -54,13 +54,11 @@ The `test.json` file contains samples for each of the different panel types that

You can also specify a remote reference to a dashboard configuration file. It must be a valid URL and the response must be the raw YAML or JSON contents of the file.

## Controls
- `ctrl+c`, `q`, `esc` will quit the program and exit the tui
## General Controls
- `ctrl+c`, `q` will quit the program and exit the tui
- `tab` will switch the active tab to the one to the right of the currently active tab
- `shift+tab` will switch the active tab to the one to the left of the currently active tab
- up and down arrow keys and mouse scroll will move up and down in the active tab
- For tables you can use the left and right arrows to scroll horizontally

- `ctrl+h` will open a more detailed help menu

## Contributing

Expand Down
14 changes: 14 additions & 0 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- _coverpage.md -->

![logo](_media/logo.png)

# buoy

> A declarative Kubernetes TUI dashboard
[GitHub](https://github.com/everettraven/buoy)
[Get Started](#buoy)

<!-- background color -->

![color](#ffffff)
Binary file added docs/_media/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@
- [Introduction](/)
- Panels
- [Table](panels/table.md)
- [Item](panels/item.md)
- [Logs](panels/logs.md)

2 changes: 2 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
name: 'buoy',
repo: 'https://github.com/everettraven/buoy',
loadSidebar: true,
coverpage: true,
subMaxLevel: 2,
}
</script>
<!-- Docsify v4 -->
Expand Down
1 change: 0 additions & 1 deletion docs/panels/item.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,3 @@ panels:

- Up and down arrow keys for navigating the viewport
- Page Up and Page Down for jumping up and down in the viewport
- `v` to toggle viewing the full YAML of the selected resource
96 changes: 95 additions & 1 deletion docs/panels/logs.md
Original file line number Diff line number Diff line change
@@ -1 +1,95 @@
# Logs
# Logs

The `logs` panel is great for following the logs of any resource that has a `spec.selector` field that maps
to a `Pod`. It can also be directly pointed to an individual `Pod` to stream that `Pod`s logs.

## Examples

### Getting logs from a `Deployment`

For this example, we are going to fetch some logs for a `Deployment` named `foo` in the `default` namespace

<!-- tabs:start -->

#### **JSON**
```json
{
"panels": [
{
"name": "Foo Logs",
"group": "apps",
"version": "v1",
"kind": "Deployment",
"type": "logs",
"key": {
"namespace": "default",
"name": "foo"
}
}
]
}
```

#### **YAML**
```yaml
panels:
- name: Foo Logs
group: apps
version: v1
kind: Deployment
type: logs
key:
namespace: default
name: foo
```

<!-- tabs:end -->

### Logs from a `Pod`

For this example, we are going to fetch some logs for a `Pod` named `foo` in the `default` namespace

<!-- tabs:start -->

#### **JSON**
```json
{
"panels": [
{
"name": "Foo Logs",
"group": "",
"version": "v1",
"kind": "Pod",
"type": "logs",
"key": {
"namespace": "default",
"name": "foo"
}
}
]
}
```

#### **YAML**
```yaml
panels:
- name: Foo Logs
group: ""
version: v1
kind: Pod
type: logs
key:
namespace: default
name: foo
```

<!-- tabs:end -->

## Controls

- Up and down arrow keys for navigating the viewport
- Page Up and Page Down for jumping up and down in the viewport
- `/` to enter a search mode. This will open a prompt for inputting a search query. When in search mode:
- `enter` / `return` executes the search query
- `ctrl+s` toggles between fuzzy and strict search. strict search will only match lines strictly containing your search term.
- `esc` will exit search mode and return to the full logs

0 comments on commit 3481a27

Please sign in to comment.