Add the ability to control more verbose container logging for cortx-setup InitContainers. When configured, setup log files will be
re-directed to the container's stdout. This allows setup logs to be captured by cluster logging solutions, and aids in troubleshooting, since logs will be available outside of the containers. The alternative is to exec into a debug container and examine the logs manually.
Configure is performed via global and component setupLoggingDetail values. Valid settings are:
"default" (or ""): no detailed logging
"component": component-only logging
"all": component plus all other setup files (e.g. Consul-related)
If the global value is set, it can be overridden by the component version (this the opposite of global image settings).
By default, the deployment script uses "component" logging, which is a good balance of logging output. The default chart value is "", or "default". Users of the deployment script can re-configure this with a custom values file.
Breaking change
Type of change
[ ] Bug fix (non-breaking change that fixes an issue)
[X] New feature (non-breaking change that adds new functionality)
[ ] Breaking change (bug fix or new feature that breaks existing functionality)
[ ] Third-party dependency update
[ ] Documentation additions or improvements
[ ] Code quality improvements to existing code or test additions/updates
Applicable issues
This change fixes an issue: CORTX-33135
How was this tested?
Deployed cluster in multiple scenarios:
With no custom values, everything setup with "component"
With various custom values overriding the deployment
With various custom values, overriding per-component
Additional information
The selection of files to redirect are hand-curated and based on observations of what is being logged during setup.
If CORTX implements it's own console logging in the future for setup, we can remove this.
Checklist
[X] The change is tested and works locally.
[ ] New or changed settings in the solution YAML are documented clearly in the README.md file.
Description
Add the ability to control more verbose container logging for cortx-setup InitContainers. When configured, setup log files will be re-directed to the container's stdout. This allows setup logs to be captured by cluster logging solutions, and aids in troubleshooting, since logs will be available outside of the containers. The alternative is to exec into a debug container and examine the logs manually.
Configure is performed via global and component
setupLoggingDetail
values. Valid settings are:"default"
(or""
): no detailed logging"component"
: component-only logging"all"
: component plus all other setup files (e.g. Consul-related)If the global value is set, it can be overridden by the component version (this the opposite of global image settings).
By default, the deployment script uses
"component"
logging, which is a good balance of logging output. The default chart value is""
, or"default"
. Users of the deployment script can re-configure this with a custom values file.Breaking change
Type of change
Applicable issues
How was this tested?
Deployed cluster in multiple scenarios:
Additional information
The selection of files to redirect are hand-curated and based on observations of what is being logged during setup.
If CORTX implements it's own console logging in the future for setup, we can remove this.
Checklist
If this change requires newer CORTX or third party image versions:
image
fields in solution.example.yaml have been updated to use the required versions.appVersion
field of the Helm chart has been updated to use the new CORTX version.If this change addresses a CORTX Jira issue:
CORTX-XXXXX:
)View rendered README.md View rendered charts/cortx/README.md