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.

Sign up for GitHub

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

Update README.md with ingress doc #44

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md with ingress doc #44

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbeea37
Update README.md with ingress doc
nodesocket Mar 21, 2024
abce8b6
Update README.md
nodesocket Mar 21, 2024
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
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ helm install kubetail kubetail/kubetail \

## Access

There are several ways to access the kubetail dashboard once the kubetail application is running in your cluster. For simplicity, we recommend using `kubectl proxy` if your kubetail deployment is using `auth-mode: cluster` and the `kubectl auth-proxy` plugin if it's using `auth-mode: token`.
There are several ways to access the kubetail dashboard once the kubetail application is running in your cluster. For simplicity, we recommend using `kubectl proxy` if your kubetail deployment is using `auth-mode: cluster` and the `kubectl auth-proxy` plugin if it's using `auth-mode: token`. If using the [Helm chart](https://github.com/kubetail-org/helm/) it has support for ingress and that is the preferred method of access.

### Option 1: kubectl proxy

Expand Down Expand Up @@ -102,6 +102,27 @@ kubectl auth-proxy -n kubetail http://kubetail.svc

Now your computer will automatically open a new browser tab pointing to the kubetail dashboard.

### Option 4: ingress with Helm chart

Set the following in your `values.yaml` replacing where applicable:

```yaml
ingress:
enabled: true
annotations:
traefik.ingress.kubernetes.io/router.entrypoints: websecure
traefik.ingress.kubernetes.io/router.tls: "true"
traefik.ingress.kubernetes.io/router.tls.certresolver: le
Comment on lines +113 to +115
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove these, not everyone uses traefik, may confuse inexperienced users :)

hosts:
- host: kubetail.mydomain.com
paths:
- path: /
pathType: Prefix
tls:
- hosts:
- kubetail.mydomain.com
```

## Configure

### CLI
Expand Down