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.

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

docs(config): logging config documentation update #9109

Merged
merged 5 commits into from
Sep 19, 2024

Conversation

ossdhaval
Copy link
Contributor

Prepare


Description

Target issue

closes #issue-number-here

Implementation Details


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
@ossdhaval ossdhaval self-assigned this Aug 5, 2024
Copy link

dryrunsecurity bot commented Aug 5, 2024

DryRun Security Summary

This pull request updates the documentation for logging configuration in the Janssen Authorization Server (jans-auth) and other Janssen modules, providing a more general approach to managing logging configuration using command-line, text-based UI, and REST API.

Expand for full summary

Summary:

The code changes in this pull request focus on updating the documentation for logging configuration in the Janssen Authorization Server (jans-auth) and other Janssen modules, such as FIDO2 and SCIM. The key changes include:

  1. Removal of the specific details on configuring logging for the jans-auth module, and instead, a focus on the general approach to manage logging configuration using command-line, text-based UI, and REST API.
  2. Provision of step-by-step instructions on how to retrieve the current logging configuration, update it, and apply the changes using the command-line interface.
  3. Introduction of the text-based UI (TUI) approach to manage logging configuration for different Janssen modules, including jans-auth, FIDO2, and SCIM.
  4. Specification of the default log locations for different Janssen modules.
  5. Mention of a separate document covering logging configuration for cloud-native deployments.

From an application security perspective, the ability to configure logging at the module level and the availability of different interfaces to manage the configuration are positive aspects. This allows administrators to have fine-grained control over logging and tailor it to their specific needs, which can be important for security monitoring and incident investigation.

Files Changed:

  • docs/admin/config-guide/auth-server-config/logging-configuration.md: This file has been updated to provide more general information on managing logging configuration for Janssen modules, including jans-auth, FIDO2, and SCIM. The changes remove the specific details on configuring logging for the jans-auth module and focus on the broader approach to logging configuration using command-line, text-based UI, and REST API.

Code Analysis

We ran 9 analyzers against 3 files and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

@mo-auto mo-auto added the area-documentation Documentation needs to change as part of issue or PR label Aug 5, 2024
@mo-auto mo-auto enabled auto-merge (squash) August 5, 2024 14:35
@mo-auto mo-auto merged commit d60da8e into main Sep 19, 2024
11 checks passed
@mo-auto mo-auto deleted the docs-logging-config-update branch September 19, 2024 08:48
yuriyz pushed a commit that referenced this pull request Nov 7, 2024
* docs(loggin): logging config update changes

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(logging): fix loggin document format

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(logging): update detail of TUI

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

---------

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Former-commit-id: d60da8e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants