aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sections/logging.rst
diff options
context:
space:
mode:
authorTomasz Wrobel <tomasz.wrobel@nokia.com>2020-03-26 09:43:41 +0100
committerTomasz Wrobel <tomasz.wrobel@nokia.com>2020-03-27 08:35:55 +0100
commit71986212d4088b3cc5c41c2ed96ec352ea899fe5 (patch)
treeadf2f276554908c9f00eddfabbe6fc47b3e2e0bb /docs/sections/logging.rst
parent483ccbf2d8f0c71ebb15a4a47246a68a42e68f3e (diff)
Add Certification Client documentation
Issue-ID: AAF-1091 Signed-off-by: Tomasz Wrobel <tomasz.wrobel@nokia.com> Change-Id: I8eb762063767f8532845e7f66b1d7398468ab650
Diffstat (limited to 'docs/sections/logging.rst')
-rw-r--r--docs/sections/logging.rst51
1 files changed, 48 insertions, 3 deletions
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 <pod-name> 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 |
++-------+------------------------------------------------+