Skip to content

Chronicle official release chart cleanup #670

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

Draft
wants to merge 44 commits into
base: main
Choose a base branch
from

Conversation

ianpittwood
Copy link
Contributor

  • Improvements for chart annotations.
  • Values changes.
    • Allow name and namespace overrides in chart values.
    • Add common labels and annotations values to apply to all resources.
    • Moves default tag source to appVersion, image.tag changed to a blank override.
    • Separated an image.registry value from the image.repository value.
    • Improve documentation of values.yaml and add a values.schema.json definition for input validation.
    • An S3 bucket must now be specified in S3 Storage backend is enabled.
  • Changes to chart behavior.
    • Resource names are now applied dynamically based on the release name.
    • Additional default recommended Kubernetes labels have been applied to all resources.
    • Storage configuration is now validated and requires at least one of local or s3 storage be enabled.
    • extraSecretMounts can now be specified to mount additional secrets, such as certificates, into the pod.
    • Storage class can now be overridden on the pod's volume claim template.
    • Selector labels definitions between pod and service are now merged into a single definition. Removed the ability to override these values.
    • Add support for additional custom manifest input via extraObjects value.
  • Add unittests for chart templates.
  • Various Chart.yaml metadata changes.
    • Fix logo URL.
    • Add suggestions for compatible product charts.
    • Add annotation to include source image used in pod.
  • Update README.md and other documentation to reflect changes.

- Make most elements defined dynamically with overrides/merges rather than be hardcoded (e.g. resource names, namespaces, etc.)
- Update references for changes to values.yaml
- Change most label/annotation definitions to inline rather than bespoke helper definitions.
- Reimplement persistence as a PVC resource rather than a volumeClaimTemplate. This also adds selection for existing PVCs.
- Change configmap configuration key to be filename of the config file. Certain elements of the config will also be required when sections are enabled/disabled.
Provides base level of support for mounting things like certs/keys
- Add labels/annotations to statefulset
@ianpittwood ianpittwood marked this pull request as draft May 15, 2025 20:30
Copy link
Contributor

@t-margheim t-margheim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I did leave a couple notes about maybe dropping RetentionPeriod from the docs to match a change on our side.

Comment on lines +120 to +124
`retentionPeriod` controls how long usage data is retained. For example, `"120m"`
for 120 minutes, `"36h"` for 36 hours, `14d` for two weeks, or `"0"` for unbounded
retention. Units smaller than seconds or larger than days are not currently
supported. `retentionPeriod` does not apply to other types of data stored by
Chronicle.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature was recently moved to undocumented (see https://github.com/rstudio/chronicle/pull/2093), so we should probably remove references to it here as well.

Logging:
# -- Specified the output for log messages, can be one of "STDOUT", "STDERR", or a file path
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# -- Specified the output for log messages, can be one of "STDOUT", "STDERR", or a file path
# -- Specifies the output for log messages, can be one of "STDOUT", "STDERR", or a file path

Location: "./chronicle-data"
# -- The path to the local storage location
Path: "/opt/chronicle-data"
# -- The retention period for data before it is purged
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably also remove RetentionPeriod from here.

Copy link
Contributor

@markrtucker markrtucker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I agree with Tim's comments - especially the ones around retention period

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants