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

fix(chart): Improve templates in the section videoRecorder #1987

Merged
merged 1 commit into from
Oct 30, 2023
Merged

fix(chart): Improve templates in the section videoRecorder #1987

merged 1 commit into from
Oct 30, 2023

Conversation

VietND96
Copy link
Member

@VietND96 VietND96 commented Oct 29, 2023

Thanks for contributing to the Docker-Selenium project!
A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing guidelines, applied for this repository.
Avoid large PRs, help reviewers by making them as simple and short as possible.

Description

Improve chart templates in the section videoRecorder after #1881

Motivation and Context

  • Update chart README for configuration parameters and their default values in the section videoRecorder.
  • Update imageTag default value latest to ffmpeg-6.0-YYYYMMDD to align within project.
  • Update the order of a few config keys.
  • Update port default 5666 to 9000. Since by default, video container exposes 9000 in Dockerfile.
  • Add startupProbe and livenessProbe for the video container to template. Since via ConfigMap and script video_ready.py, the user can extend custom APIs and use them to check video container startup or liveness. (Refer to a sample)
  • Add to chart values.yaml config keys extraVolumeMounts, extraVolumes, its default value, and sample reference in comment lines.
  • Update _helpers.tpl to improve the template for the video recorder
    • In the template, under specs for container video and uploader, 2 mount points with name video and video-scripts are set static values in the template. If a user wants to modify another way to persist and share that path in container or mount video scripts to their custom ConfigMap, etc. It seems difficult to do via chart values.yaml.
      Improve: via _helpers.tpl, create a template for initial default configs. Create another template to combine the config extraVolumeMounts, extraVolumes input from user and default configs required. Based on the unique key of config, if it already existed in the extra part, which is redefined by the user, it would take precedence and the default config will be ignored
    • Add the tpl function in a few lines, which adds extra configs from chart values.yaml to apply template to a set of data . For example, data contains Helm variables like JAVA_OPTS: "-Dotel.traces.exporter=jaeger -Dotel.exporter.jaeger.endpoint=http://{{ .Release.Name }}-jaeger-all-in-one-headless:14250

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Member

@diemol diemol left a comment

Choose a reason for hiding this comment

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

Thank you, @VietND96!

@diemol diemol merged commit 4f725b7 into SeleniumHQ:trunk Oct 30, 2023
3 checks passed
@VietND96 VietND96 changed the title Improve chart templates in the section videoRecorder fix(chart): Improve templates in the section videoRecorder Dec 27, 2023
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.

2 participants