Update README (#486 )

Ignore gob files (#488 )
* Ignore gob files * Remove `*.db` from `.gitignore`
2026-03-14 15:41:48 +00:00 · 2021-11-21 14:09:21 +02:00 · 2021-11-21 09:29:01 +03:00 · 2021-11-21 09:12:51 +03:00 · 2021-11-19 18:57:19 +03:00
6 changed files with 25 additions and 26 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -15,7 +15,6 @@
 # vendor/
 .idea/
 build
-*.db

 # Mac OS
 .DS_Store
@@ -32,3 +31,4 @@ pprof/*

 # Database Files
 *.bin
+*.gob
--- a/6
+++ b/6
@@ -42,8 +42,8 @@ RUN go build -ldflags="-s -w \
     -X 'mizuserver/pkg/version.SemVer=${SEM_VER}'" -o mizuagent .

 # Download Basenine executable, verify the sha1sum and move it to a directory in $PATH
-ADD https://github.com/up9inc/basenine/releases/download/v0.2.9/basenine_linux_amd64 ./basenine_linux_amd64
-ADD https://github.com/up9inc/basenine/releases/download/v0.2.9/basenine_linux_amd64.sha256 ./basenine_linux_amd64.sha256
+ADD https://github.com/up9inc/basenine/releases/download/v0.2.10/basenine_linux_amd64 ./basenine_linux_amd64
+ADD https://github.com/up9inc/basenine/releases/download/v0.2.10/basenine_linux_amd64.sha256 ./basenine_linux_amd64.sha256
 RUN shasum -a 256 -c basenine_linux_amd64.sha256
 RUN chmod +x ./basenine_linux_amd64

@@ -52,7 +52,7 @@ RUN cd .. && /bin/bash build_extensions.sh

 FROM alpine:3.14

-RUN apk add bash libpcap-dev tcpdump
+RUN apk add bash libpcap-dev

 WORKDIR /app

--- a/README.md
+++ b/README.md
@@ -11,7 +11,12 @@ Think TCPDump and Chrome Dev Tools combined.
 ## Features

 - Simple and powerful CLI
- Real-time view of all HTTP requests, REST and gRPC API calls
+- Monitoring network traffic in real-time. Supported protocols:
+  - [HTTP/1.1](https://datatracker.ietf.org/doc/html/rfc2616)
+  - [HTTP/2](https://datatracker.ietf.org/doc/html/rfc7540) (gRPC)
+  - [AMQP](https://www.rabbitmq.com/amqp-0-9-1-reference.html) (RabbitMQ, Apache Qpid, etc.)
+  - [Apache Kafka](https://kafka.apache.org/protocol)
+  - [Redis](https://redis.io/topics/protocol)
 - No installation or code instrumentation
 - Works completely on premises

@@ -44,15 +49,6 @@ SHA256 checksums are available on the [Releases](https://github.com/up9inc/mizu/
 ### Development (unstable) Build
 Pick one from the [Releases](https://github.com/up9inc/mizu/releases) page

-## Kubeconfig & Permissions
-While `mizu`most often works out of the box, you can influence its behavior:
-
-1. [OPTIONAL] Set `KUBECONFIG` environment variable to your Kubernetes configuration. If this is not set, Mizu assumes that configuration is at `${HOME}/.kube/config`
-2. `mizu` assumes user running the command has permissions to create resources (such as pods, services, namespaces) on your Kubernetes cluster (no worries - `mizu` resources are cleaned up upon termination)
-
-For detailed list of k8s permissions see [PERMISSIONS](docs/PERMISSIONS.md) document
-
-
 ## How to Run

 1. Find pods you'd like to tap to in your Kubernetes cluster
@@ -135,21 +131,22 @@ $ mizu clean # mizu will continue running in cluster until clean is executed

 ## Configuration

-Mizu can work with config file which should be stored in ${HOME}/.mizu/config.yaml (macOS: ~/.mizu/config.yaml) <br />
-In case no config file found, defaults will be used <br />
+Mizu can optionally work with a config file that can be provided as a CLI argument (using `--set config-path=<PATH>`) or if not provided, will be stored at ${HOME}/.mizu/config.yaml 
 In case of partial configuration defined, all other fields will be used with defaults <br />
 You can always override the defaults or config file with CLI flags

 To get the default config params run `mizu config` <br />
 To generate a new config file with default values use `mizu config -r`

-### Telemetry
-
-By default, mizu reports usage telemetry. It can be disabled by adding a line of `telemetry: false` in the `${HOME}/.mizu/config.yaml` file
-

 ## Advanced Usage

+### Kubeconfig
+
+It is possible to change the kubeconfig path using `KUBECONFIG` environment variable or the command like flag
+with `--set kube-config-path=<PATH>`. </br >
+If both are not set - Mizu assumes that configuration is at `${HOME}/.kube/config`
+
 ### Namespace-Restricted Mode

 Some users have permission to only manage resources in one particular namespace assigned to them
@@ -163,6 +160,8 @@ using the `--namespace` flag or by setting `tap.namespaces` in the config file

 Setting `mizu-resources-namespace=mizu` resets Mizu to its default behavior

+For detailed list of k8s permissions see [PERMISSIONS](docs/PERMISSIONS.md) document
+
 ### User agent filtering

 User-agent filtering (like health checks) - can be configured using command-line options:
--- a/agent/go.mod
+++ b/agent/go.mod
@@ -16,7 +16,7 @@ require (
 	github.com/op/go-logging v0.0.0-20160315200505-970db520ece7
 	github.com/orcaman/concurrent-map v0.0.0-20210106121528-16402b402231
 	github.com/patrickmn/go-cache v2.1.0+incompatible
-	github.com/up9inc/basenine/client/go v0.0.0-20211114204315-4d028da5fda5
+	github.com/up9inc/basenine/client/go v0.0.0-20211118123155-7ed075f85c73
 	github.com/up9inc/mizu/shared v0.0.0
 	github.com/up9inc/mizu/tap v0.0.0
 	github.com/up9inc/mizu/tap/api v0.0.0
--- a/agent/go.sum
+++ b/agent/go.sum
@@ -450,8 +450,8 @@ github.com/ugorji/go v1.1.7 h1:/68gy2h+1mWMrwZFeD1kQialdSzAb432dtpeJ42ovdo=
 github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
 github.com/ugorji/go/codec v1.1.7 h1:2SvQaVZ1ouYrrKKwoSk2pzd4A9evlKJb9oTL+OaLUSs=
 github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=
-github.com/up9inc/basenine/client/go v0.0.0-20211114204315-4d028da5fda5 h1:JbLairDLEJpAC8bwmFuOAB+LYpY/oQbzGRSWRpkF7PQ=
-github.com/up9inc/basenine/client/go v0.0.0-20211114204315-4d028da5fda5/go.mod h1:SvJGPoa/6erhUQV7kvHBwM/0x5LyO6XaG2lUaCaKiUI=
+github.com/up9inc/basenine/client/go v0.0.0-20211118123155-7ed075f85c73 h1:FJUM7w7E0jRGFPcSMa7cVy+jr5zcpbyT6qA30dEtGGI=
+github.com/up9inc/basenine/client/go v0.0.0-20211118123155-7ed075f85c73/go.mod h1:SvJGPoa/6erhUQV7kvHBwM/0x5LyO6XaG2lUaCaKiUI=
 github.com/vektah/gqlparser v1.1.2/go.mod h1:1ycwN7Ij5njmMkPPAOaRFY4rET2Enx7IkVv3vaXspKw=
 github.com/vishvananda/netns v0.0.0-20210104183010-2eb08e3e575f h1:p4VB7kIXpOQvVn1ZaTIVp+3vuYAXFe3OJEvjbUYJLaA=
 github.com/vishvananda/netns v0.0.0-20210104183010-2eb08e3e575f/go.mod h1:DD4vA1DwXk04H54A1oHXtwZmA0grkVMdPxx/VGLCah0=
--- a/debug.Dockerfile
+++ b/debug.Dockerfile
@@ -37,8 +37,8 @@ COPY agent .
 RUN go build -gcflags="all=-N -l" -o mizuagent .

 # Download Basenine executable, verify the sha1sum and move it to a directory in $PATH
-ADD https://github.com/up9inc/basenine/releases/download/v0.2.9/basenine_linux_amd64 ./basenine_linux_amd64
-ADD https://github.com/up9inc/basenine/releases/download/v0.2.9/basenine_linux_amd64.sha256 ./basenine_linux_amd64.sha256
+ADD https://github.com/up9inc/basenine/releases/download/v0.2.10/basenine_linux_amd64 ./basenine_linux_amd64
+ADD https://github.com/up9inc/basenine/releases/download/v0.2.10/basenine_linux_amd64.sha256 ./basenine_linux_amd64.sha256
 RUN shasum -a 256 -c basenine_linux_amd64.sha256
 RUN chmod +x ./basenine_linux_amd64

@@ -48,7 +48,7 @@ RUN cd .. && /bin/bash build_extensions_debug.sh

 FROM golang:1.16-alpine

-RUN apk add bash libpcap-dev tcpdump
+RUN apk add bash libpcap-dev

 WORKDIR /app
Author	SHA1	Message	Date
gadotroee	2635964a28	Update README (#486 )	2021-11-21 14:09:21 +02:00
M. Mert Yıldıran	a16faca5fb	Ignore gob files (#488 ) * Ignore gob files * Remove `*.db` from `.gitignore`	2021-11-21 09:29:01 +03:00
M. Mert Yıldıran	8cf6f56a3c	Remove unnecessary `tcpdump` dependency from `Dockerfile` (#491 )	2021-11-21 09:12:51 +03:00
M. Mert Yıldıran	a849aae94c	Upgrade Basenine version from `0.2.9` to `0.2.10` (#484 ) * Upgrade Basenine version from `0.2.9` to `0.2.10` Fixes the issues in `limit` and `rlimit` helpers that occur when they are on the left operand of a binary expression. * Upgrade the client hash to latest	2021-11-19 18:57:19 +03:00