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

allowed-namespaces docs improvements #88

Merged
merged 1 commit into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,10 @@ Kubetail can be configured using a configuration file written in YAML, JSON, TOM
| ------------------------------------- | -------- | ---------------------------------------------------- | ---------------------- |
| addr | string | Host address to bind to | ":4000" |
| auth-mode | string | Auth mode (token, cluster, local) | "token" |
| allowed-namespaces | []string | If populated, restricts namespace access | [] |
| base-path | string | URL path prefix | "/" |
| gin-mode | string | Gin mode (release, debug) | "release" |
| kube-config | string | Kubectl config file path | "${HOME}/.kube/config" |
| base-path | string | URL path prefix | "/" |
| csrf.enabled | bool | Enable CSRF protection | true |
| csrf.field-name | string | CSRF token name in forms | "csrf_token" |
| csrf.secret | string | CSRF hash key | "" |
Expand Down
6 changes: 2 additions & 4 deletions backend/hack/server.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,9 @@ gin-mode: debug

# App options
auth-mode: local
kube-config: ${HOME}/.kube/config
allowed-namespaces: []
base-path: /
allowed-namespaces:
- kubernetes-dashboard
- kube-system
kube-config: ${HOME}/.kube/config

session:
secret: REPLACEME
Expand Down
32 changes: 16 additions & 16 deletions hack/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ addr: :4000
#
auth-mode: token

## allowed-namespaces ##
#
# If non-empty, restricts queries to allowed namespaces
#
# Default value: []
#
allowed-namespaces: []

## base-path ##
#
# Sets the url path prefix (useful for deploying on a sub-path behind a reverse proxy)
#
# Default value: /
#
base-path: /

## gin-mode ##
#
# Sets the mode for the Gin framework
Expand All @@ -42,22 +58,6 @@ gin-mode: release
#
kube-config: ${HOME}/.kube/config

## base-path ##
#
# Sets the url path prefix (useful for deploying on a sub-path behind a reverse proxy)
#
# Default value: /
#
base-path: /

## allowed-namespaces ##
#
# If non-empty, restricts queries to allowed namespaces
#
# Default value: []
#
allowed-namespaces: []

## csrf ##
#
csrf:
Expand Down
Loading