From 5031cc3e39fe889fb02853cdd8e04c8ca630e7a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Valais?= Date: Fri, 8 Sep 2023 16:40:55 +0200 Subject: [PATCH] readme: explain how logs are meant to be used MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maël Valais --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 47f03e9..4299bdf 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,18 @@ It takes care of: An example issuer implementation can be found in the [`./internal/testsetups/simple`](./internal/testsetups/simple) subdirectory. +## Log levels + +The library relies on the log levels defined in `logr`, i.e., numbers from 0 to +9\. You can use any logging library you like in your controller as long as the +levels "match". The two only logr levels used in issuer-lib are 0 ("info") and 1 +("debug"). + +For example, the message "Succeeded signing the CertificateRequest" is logged at +the level 0 ("info"). To integrate well with issuer-lib, your controller should +also use the level 0 when logging messages that inform the user about changes to +the CertificateRequest. + ## How it works This repository provides a go libary that you can use for creating cert-manager controllers for your own Issuers.