Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: explain how logs are meant to be used #56

Merged
merged 1 commit into from
Sep 11, 2023
Merged

README: explain how logs are meant to be used #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading