From 946b3ddda7a3798123a045eefe6f7d7fdd6d45ce Mon Sep 17 00:00:00 2001 From: Aleksandra Maciaga Date: Thu, 16 Apr 2020 21:46:06 +0200 Subject: [PATCH] Update documentation Signed-off-by: Aleksandra Maciaga Issue-ID: AAF-1091 Change-Id: I7b9b4211dc8f2a191dfc7b4249e74a42902b2b01 --- certServiceClient/README.md | 1 + docs/sections/logging.rst | 56 +++++++++++++++++++++++++++++++++++---------- 2 files changed, 45 insertions(+), 12 deletions(-) diff --git a/certServiceClient/README.md b/certServiceClient/README.md index 43d732c8..849db4f1 100644 --- a/certServiceClient/README.md +++ b/certServiceClient/README.md @@ -70,3 +70,4 @@ docker logs aaf-certservice-client 6 Internal HTTP Client connection problem 7 Fail in PKCS12 conversion 8 Fail in Private Key to PEM Encoding +9 Wrong TLS configuration diff --git a/docs/sections/logging.rst b/docs/sections/logging.rst index 422b70a0..5d9aac82 100644 --- a/docs/sections/logging.rst +++ b/docs/sections/logging.rst @@ -7,42 +7,72 @@ Logging Certification Service API -------------------------- +To see console Certification Service logs use: +- Docker: -Certification Service logs are available in the Docker container +.. code-block:: bash + + docker logs + +- Kubernetes: + +.. code-block:: bash + + kubectl logs + +Console logs contain logs for logging levels from **DEBUG** to **ERROR**. + +Certification Service logs for different logging levels are available in the container: + +- Docker: + +.. code-block:: bash - docker exec -it aaf-certservice-api bash + docker exec -it bash + +- Kubernetes: + +.. code-block:: bash + + kubectl exec -it bash Path to logs: /var/log/onap/aaf/certservice Available log files: - * audit.log - * debug.log - * error.log + + - audit.log - contains logs for **INFO** logging level + - debug.log - contains logs for logging levels from **DEBUG** to **ERROR** + - error.log - contains logs for **ERROR** logging level + +User cannot change logging levels. Certification Service Client ---------------------------- -To see logs use : +To see console Certification Service Client logs use : - Docker: .. code-block:: bash - docker logs cert-service-client + docker logs - Kubernetes: - + CertService Client is used as init container in other components. In the following example: + - ** refers to the component that uses CertService Client as init container + - ** refers to name of init container used by the mentioned component. It can be found by executing *'kubectl descrine pod '* and looking into 'Init Containers section' + .. code-block:: bash - - kubectl logs cert-service-client + kubectl logs -c -Logs are stored inside container log path: - /var/logs + +| Container stops after execution, so all logs available are printed to console. +| User cannot change logging levels. Client application exits with following exit codes: @@ -68,3 +98,5 @@ Client application exits with following exit codes: +-------+------------------------------------------------+ | 8 | Fail in Private Key to PEM Encoding | +-------+------------------------------------------------+ +| 9 | Wrong TLS configuration | ++-------+------------------------------------------------+ -- 2.16.6