From 71986212d4088b3cc5c41c2ed96ec352ea899fe5 Mon Sep 17 00:00:00 2001 From: Tomasz Wrobel Date: Thu, 26 Mar 2020 09:43:41 +0100 Subject: Add Certification Client documentation Issue-ID: AAF-1091 Signed-off-by: Tomasz Wrobel Change-Id: I8eb762063767f8532845e7f66b1d7398468ab650 --- docs/sections/logging.rst | 51 ++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 48 insertions(+), 3 deletions(-) (limited to 'docs/sections/logging.rst') diff --git a/docs/sections/logging.rst b/docs/sections/logging.rst index 159b5132..422b70a0 100644 --- a/docs/sections/logging.rst +++ b/docs/sections/logging.rst @@ -5,8 +5,9 @@ Logging ======= -Where to Access Information ---------------------------- +Certification Service API +-------------------------- + Certification Service logs are available in the Docker container @@ -17,9 +18,53 @@ Path to logs: /var/log/onap/aaf/certservice Available log files: - * audit.log * debug.log * error.log +Certification Service Client +---------------------------- +To see logs use : + +- Docker: + +.. code-block:: bash + + docker logs cert-service-client + +- Kubernetes: + +.. code-block:: bash + + kubectl logs cert-service-client + + +Logs are stored inside container log path: + + /var/logs + +Client application exits with following exit codes: + + ++-------+------------------------------------------------+ +| Code | Information | ++=======+================================================+ +| 0 | Success | ++-------+------------------------------------------------+ +| 1 | Invalid client configuration | ++-------+------------------------------------------------+ +| 2 | Invalid CSR configuration | ++-------+------------------------------------------------+ +| 3 | Fail in key pair generation | ++-------+------------------------------------------------+ +| 4 | Fail in CSR generation | ++-------+------------------------------------------------+ +| 5 | CertService HTTP unsuccessful response | ++-------+------------------------------------------------+ +| 6 | Internal HTTP Client connection problem | ++-------+------------------------------------------------+ +| 7 | Fail in PKCS12 conversion | ++-------+------------------------------------------------+ +| 8 | Fail in Private Key to PEM Encoding | ++-------+------------------------------------------------+ -- cgit 1.2.3-korg