.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2020 NOKIA
+
Logging
=======
-Certification Service API
---------------------------
+CertService API
+---------------
+To see CertService console logs use:
+
+- Docker:
+
+.. code-block:: bash
+
+ docker logs <cert-service-container-name>
+
+ e.g.
+ docker logs aafcert-service
+
+- Kubernetes:
+
+.. code-block:: bash
+
+ kubectl -n onap logs <cert-service-pod-name>
+
+ e.g.
+ kubectl -n onap logs $(kubectl -n onap get pods | grep cert-service | awk '{print $1}')
+
+Console logs contains logs for logging levels from **DEBUG** to **ERROR**.
+
+CertService logs for different logging levels are available in the container:
+
+- Docker:
+.. code-block:: bash
+
+ docker exec -it <cert-service-container-name> bash
-Certification Service logs are available in the Docker container
+ e.g.
+ docker exec -it aafcert-service bash
- docker exec -it aaf-certservice-api bash
+- Kubernetes:
+
+.. code-block:: bash
+
+ kubectl -n onap exec -it <cert-service-pod-name> bash
+
+ e.g.
+ kubectl -n onap exec -it $(kubectl -n onap get pods | grep cert-service | awk '{print $1}') 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 :
+.. _cert_logs:
+
+CertService client
+------------------
+To see CertService client console logs use :
- Docker:
.. code-block:: bash
- docker logs cert-service-client
+ docker logs <cert-service-client-container-name>
+
+ e.g.
+ docker logs aafcert-client
- Kubernetes:
-
+ CertService client is used as init container in other components. In the following example:
+ - *<some-component-pod-name>* refers to the component that uses CertService client as init container
+ - *<cert-service-client-init-container-name>* refers to name of init container used by the mentioned component. It can be found by executing *'kubectl -n onap descrine pod <some-component-pod-name>'* and looking into 'Init Containers section'
+
.. code-block:: bash
-
- kubectl logs <pod-name> cert-service-client
+ kubectl -n onap logs <some-component-pod-name> -c <cert-service-client-init-container-name>
-Logs are stored inside container log path:
+ e.g.
+ kubectl -n onap logs <some-component-pod-name> -c cert-service-client
- /var/logs
+
+
+| Container stops after execution, so all available logs are printed on console.
+| User cannot change logging levels.
Client application exits with following exit codes:
+-------+------------------------------------------------+
| 8 | Fail in Private Key to PEM Encoding |
+-------+------------------------------------------------+
+| 9 | Wrong TLS configuration |
++-------+------------------------------------------------+