From 22d0d2a2c17e1e6e51e55846e791b58a346e4a10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Fri, 16 Aug 2019 13:41:58 -0400 Subject: [PATCH] Remove verbose and debug mode sections from Readme --- README.md | 22 ---------------------- 1 file changed, 22 deletions(-) diff --git a/README.md b/README.md index 555135a..e8b8302 100644 --- a/README.md +++ b/README.md @@ -172,28 +172,6 @@ INFO[0000] Creating stack endpoint=primary stack=asd INFO[0000] Stack created endpoint=primary id=89 stack=asd ``` -### Verbose mode - -In verbose mode the script prints execution steps. - -```text -2019/07/20 19:15:45 [Using config file: /home/johndoe/.psu.yaml] -2019/07/20 19:15:45 [Getting stack mystack...] -2019/07/20 19:15:45 [Getting auth token...] -2019/07/20 19:15:45 [Stack mystack not found. Deploying...] -2019/07/20 19:15:45 [Swarm cluster found with id qwe123rty456uio789asd123f] -``` - -Verbose mode can be enabled through the `PSU_VERBOSE` [environment variable](#environment-variables) and the `verbose` [configuration key](#configuration-files). - -### Debug mode - -In debug mode the script prints as much information as possible to help diagnosing a malfunction. - -**WARNING**: Debug mode will print configuration values (with Portainer credentials) and Portainer API responses (with sensitive information like authentication token and stacks environment variables). Avoid using debug mode in CI/CD pipelines, as pipeline logs are usually recorded. - -Debug mode can be enabled through the `PSU_DEBUG` [environment variable](#environment-variables) and the `debug` [configuration key](#configuration-files). - ## Contributing So, you want to contribute to the project: