Skip to content

minor doc changes #679

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

Merged
maksymvavilov merged 1 commit into from
Jan 6, 2026
Merged

minor doc changes #679

Show file tree
Hide file tree
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
11 changes: 6 additions & 5 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,11 +241,12 @@ Key controller flags (can also be set via environment variables):

Follow these guidelines when working with logs:

- `logger.Info()` - High-level resource state (creation, deletion, reconciliation path)
- `logger.Error()` - Errors not returned in reconciliation result (one error message only)
- `logger.V(1).Info()` - Debug logs (every change/event/update)

Use `--log-mode=development` flag to enable debug level logs.
There are two flags to control logging output
- `--log-mode=[development|<any-other-value>]` will enable debug level logs for the output.
The debug mode is the most verbose.
- `--log-level` controls the level of displayed logs. Defaults to the most verbose in the `development` mode.
In any other modes it can take numerical values form `-1` (Debug level) to `4` (Nothing).
It is possible to specify other values, but hey will have no effect (e.g. `4` will do the same as `128`)

Common log metadata:
- `DNSRecord` - Name/namespace of DNSRecord being reconciled
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Not exhaustive list of metadata for DNSRecord controller:
- `ownerID` - ID the of owner of the DNS Record
- `txtPrefix`/`txtSuffix` - prefix and suffix of the TXT record in provider.
- `zoneEndpoints` - endpoints that exist in the provider
- `specEdnoinds` - endpoints defined in the spec
- `specEndpoints` - endpoints defined in the spec
- `statusEndpoints` - endpoints that were processed previously

> Note that not all the metadata values are present at each of the logs statements.
Expand Down
2 changes: 1 addition & 1 deletion docs/provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In order to be able to interact with supported DNS providers, Kuadrant needs a credential that it can use.

Credentials are expected to reside in a secret. The secret name can be specified in the `DNSRecord.Spec.ProfiverRef` or the secret can have `kuadrant.io/default-provider=true` label. The secret that got assigned to the DNSRecord will be specified in the `Status.ProfiverRef`.
Credentials are expected to reside in a secret. The secret name can be specified in the `DNSRecord.Spec.ProviderRef` or the secret can have `kuadrant.io/default-provider=true` label. The secret that got assigned to the DNSRecord will be specified in the `Status.ProfiverRef`.

## Supported Providers

Expand Down
Loading