mirror of
https://github.com/kubeshark/kubeshark.git
synced 2025-06-22 14:32:35 +00:00
Update readme, add prerequisites section
This commit is contained in:
parent
765feafbcc
commit
38b58dba69
43
README.md
43
README.md
@ -26,6 +26,49 @@ SHA256 checksums are available on the [Releases](https://github.com/up9inc/mizu/
|
|||||||
### Development (unstable) build
|
### Development (unstable) build
|
||||||
Pick one from the [Releases](https://github.com/up9inc/mizu/releases) page.
|
Pick one from the [Releases](https://github.com/up9inc/mizu/releases) page.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
1. Set `KUBECONFIG` environment variable to your kubernetes configuration. If this is not set, mizu assumes that configuration is at `${HOME}/.kube/config`
|
||||||
|
2. mizu needs following permissions on your kubernetes cluster to run
|
||||||
|
```
|
||||||
|
- apiGroups:
|
||||||
|
- ""
|
||||||
|
- apps
|
||||||
|
resources:
|
||||||
|
- pods
|
||||||
|
- services
|
||||||
|
verbs:
|
||||||
|
- list
|
||||||
|
- get
|
||||||
|
- create
|
||||||
|
- delete
|
||||||
|
- apiGroups:
|
||||||
|
- ""
|
||||||
|
- apps
|
||||||
|
resources:
|
||||||
|
- daemonsets
|
||||||
|
verbs:
|
||||||
|
- list
|
||||||
|
- get
|
||||||
|
- create
|
||||||
|
- patch
|
||||||
|
- delete
|
||||||
|
```
|
||||||
|
3. Optionally, for resolving traffic ip to kubernetes service name, mizu needs below permissions
|
||||||
|
```
|
||||||
|
- apiGroups:
|
||||||
|
- ""
|
||||||
|
- apps
|
||||||
|
- "rbac.authorization.k8s.io"
|
||||||
|
resources:
|
||||||
|
- clusterroles
|
||||||
|
- clusterrolebindings
|
||||||
|
- serviceaccounts
|
||||||
|
verbs:
|
||||||
|
- get
|
||||||
|
- create
|
||||||
|
- delete
|
||||||
|
```
|
||||||
|
|
||||||
## How to run
|
## How to run
|
||||||
|
|
||||||
1. Find pod you'd like to tap to in your Kubernetes cluster
|
1. Find pod you'd like to tap to in your Kubernetes cluster
|
||||||
|
Loading…
Reference in New Issue
Block a user