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

helm-chart: make backend templates more uniform #7127

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Nov 10, 2023

Motivation and context

The templates for the various backend service deployments differ in many ways, but a lot of those differences can be eliminated. That way, it becomes easier to compare different templates, to create new services, and to make changes across all templates.

Specific differences which are eliminated are as follows:

  • Different sets of values are used for customization. This can be mitigated by putting the specific set of values in a local variable once. That way, only the variable assignment needs to differ.

  • Containers and volumes are named differently. There's no need for this, since these names are local to a pod. Just name all analogous containers/volumes the same thing.

  • Some deployments use different values for the app label. This just seems incorrect, since they all belong to the same app. Standardize on cvat-app as the value.

  • Some deployments forget to check disableDistinctCachePerService. That seems like a bug.

  • There are minor formatting differences.

Ideally I'd like to reduce these templates to just calling one big shared template with service-specific parameters, but there are still enough differences between the templates that I don't feel like doing that just yet.

How has this been tested?

helm template

Checklist

  • I submit my changes into the develop branch
  • [ ] I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Copy link

codecov bot commented Nov 10, 2023

Codecov Report

Merging #7127 (7dcb178) into develop (6eb3ef4) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #7127      +/-   ##
===========================================
- Coverage    82.57%   82.54%   -0.04%     
===========================================
  Files          362      362              
  Lines        39264    39264              
  Branches      3578     3578              
===========================================
- Hits         32422    32410      -12     
- Misses        6842     6854      +12     
Components Coverage Δ
cvat-ui 77.68% <ø> (-0.07%) ⬇️
cvat-server 86.94% <ø> (ø)

@SpecLad SpecLad marked this pull request as draft November 13, 2023 12:22
@SpecLad
Copy link
Contributor Author

SpecLad commented Nov 13, 2023

I think I'm going to expand this, actually, hang on.

The templates for the various backend service deployments differ in many
ways, but a lot of those differences can be eliminated. That way, it becomes
easier to compare different templates, to create new services, and to
make changes across all templates.

Specific differences which are eliminated are as follows:

* Different sets of values are used for customization. This can be mitigated
  by putting the specific set of values in a local variable once. That way,
  only the variable assignment needs to differ.

* Containers and volumes are named differently. There's no need for this,
  since these names are local to a pod. Just name all analogous
  containers/volumes the same thing.

* Some deployments use different values for the `app` label. This just seems
  incorrect, since they all belong to the same app. Standardize on
  `cvat-app` as the value.

* Some deployments forget to check disableDistinctCachePerService.
  That seems like a bug.

* There are minor formatting differences.

Ideally I'd like to reduce these templates to just calling one big shared
template with service-specific parameters, but there are still enough
differences between the templates that I don't feel like doing that just
yet.
@SpecLad SpecLad marked this pull request as ready for review November 13, 2023 15:58
@azhavoro azhavoro merged commit 8d2d1b1 into cvat-ai:develop Nov 15, 2023
42 checks passed
This was referenced Nov 22, 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