Mizu install mode (#566)

This commit is contained in:
RoyUP9
2021-12-28 15:44:37 +02:00
committed by GitHub
parent b039c2abad
commit de046c65b0
18 changed files with 207 additions and 449 deletions

View File

@@ -38,8 +38,6 @@ Please make sure to use full option name (`tap.dry-run` as opposed to `dry-run`
* `all-namespaces` - special flag indicating whether Mizu should search and tap pods, matching the regex, in all namespaces. Default is `false`. Please use with caution, tapping too many pods can affect resource consumption.
* `daemon` - instructs Mizu whether to run daemon mode (where CLI command exits after launch, and tapper & api-server pods in Kubernetes continue to run without controlling CLI). Typically supplied as command-line option `--daemon`. Default valie is `false`
* `dry-run` - if true, Mizu will print list of pods matching the supplied (or default) regex and exit without actually tapping the traffic. Default value is `false`. Typically supplied as command-line option `--dry-run`
* `proxy-host` - IP address on which proxy to Mizu API service is launched; should be accessible at `proxy-host:gui-port`. Default value is `127.0.0.1`

View File

@@ -1,22 +1,16 @@
# Mizu daemon mode
# Mizu install standalone
Mizu can be run detached from the cli using the daemon flag: `mizu tap --daemon`. This type of mizu instance will run
Mizu can be run detached from the cli using the install command: `mizu install`. This type of mizu instance will run
indefinitely in the cluster.
Please note that daemon mode requires you to have RBAC creation permissions, see the [permissions](PERMISSIONS.md)
Please note that install standalone requires you to have RBAC creation permissions, see the [permissions](PERMISSIONS.md)
doc for more details.
```bash
$ mizu tap "^ca.*" --daemon
Mizu will store up to 200MB of traffic, old traffic will be cleared once the limit is reached.
Tapping pods in namespaces "sock-shop"
Waiting for mizu to be ready... (may take a few minutes)
+carts-66c77f5fbb-fq65r
+catalogue-5f4cb7cf5-7zrmn
..
$ mizu install
```
## Stop mizu daemon
## Stop mizu install
To stop the detached mizu instance and clean all cluster side resources, run `mizu clean`

View File

@@ -57,11 +57,11 @@ Mizu needs following permissions on your Kubernetes cluster to run properly
- get
```
## Permissions required running with --daemon flag or (optional) for service / pod name resolving
## Permissions required running with install command or (optional) for service / pod name resolving
Mandatory permissions for running with `--daemon` flag.
Mandatory permissions for running with install command.
Optional for service/pod name resolving in non daemon mode
Optional for service/pod name resolving in non install standalone
```yaml
- apiGroups: