note on container logs/secrets

deploy/deployment.yaml

@@ -24,6 +24,9 @@ spec:
         # uncomment the following line to enable pod logs
         # (disabled by default as they might consider sensitive information)
         # - "--show-container-logs"
+        # uncomment the following line to unhide secret data
+        # see also https://kube-web-view.readthedocs.io/en/latest/security.html
+        # - "--show-secrets"
         ports:
         - containerPort: 8080
         readinessProbe:

docs/getting-started.rst

@@ -19,6 +19,10 @@ Afterwards you can open "kube-web-view" via kubectl port-forward (you might need
 
 Now direct your browser to http://localhost:8080/
 
+Note that pod container logs and Kubernetes secrets are hidden by default for security reasons,
+you can enable them by uncommenting the respective CLI options in ``kube-web-view/deploy/deployment.yaml``.
+See also :ref:`security`.
+
 .. _Minikube: https://github.com/kubernetes/minikube
 .. _kind: https://kind.sigs.k8s.io/
 

docs/security.rst

@@ -1,3 +1,5 @@
+.. _security:
+
 =======================
 Security Considerations
 =======================