From a866576cfcd45a7b5f810e06e1a9217c9d9f26c1 Mon Sep 17 00:00:00 2001 From: RamiBerm <54766858+RamiBerm@users.noreply.github.com> Date: Sun, 7 Nov 2021 12:23:15 +0200 Subject: [PATCH] TRA-3903 more docs (#438) * Update README.md and PERMISSIONS.md * Update PERMISSIONS.md * Update README.md * Update PERMISSIONS.md * Update PERMISSIONS.md --- README.md | 2 ++ docs/PERMISSIONS.md | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3eb1c87b0..3c31c489e 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,8 @@ and when changed it will support accessing by IP Mizu can be ran detached from the cli using the daemon flag: `mizu tap --daemon`. 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](docs/PERMISSIONS.md) doc for more details. + In order to access a daemon mizu you will have to run `mizu view` after running the `tap --daemon` command. To stop the detached mizu instance and clean all cluster side resources, run `mizu clean` diff --git a/docs/PERMISSIONS.md b/docs/PERMISSIONS.md index b65a58e7f..12eb69b8e 100644 --- a/docs/PERMISSIONS.md +++ b/docs/PERMISSIONS.md @@ -57,9 +57,11 @@ Mizu needs following permissions on your Kubernetes cluster to run properly - get ``` -## Permissions required for service / pod name resolving (opt) +## Permissions required running with --daemon flag or (optional) for service / pod name resolving -Optionally, for proper resolving of IP addresses to Kubernetes service name, Mizu needs below permissions: +Mandatory permissions for running with `--daemon` flag. + +Optional for service/pod name resolving in non daemon mode ```yaml - apiGroups: