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

Better readme to Helm chart #4366

Merged
merged 8 commits into from
Mar 16, 2022

Conversation

kbegiedza
Copy link
Contributor

@kbegiedza kbegiedza commented Feb 19, 2022

Motivation and context

Trying to install and configure with helm was very painful, this PR tries to cover few things:

  • Better readme for first time users
  • Init container with automatically invoked db migration

How has this been tested?

Dry-run helm and released to brand new cluster.
Checked https certificates and frontend / backend connection.
image

Checklist

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.
  • I have updated the license header for each file (see an example below)
# Copyright (C) 2022 Intel Corporation
#
# SPDX-License-Identifier: MIT

@kbegiedza kbegiedza marked this pull request as ready for review February 19, 2022 18:55
@kbegiedza kbegiedza changed the title Feature/backend init container Added backend init container and better readme to Helm chart Feb 19, 2022
@nmanovic
Copy link
Contributor

@kbegiedza , thanks for your contribution! @azhavoro , could you please look?

@azhavoro
Copy link
Contributor

@kbegiedza Hello, what issue does the init container you added in this patch solve?

@kbegiedza
Copy link
Contributor Author

@azhavoro Thanks for question.
It simplifies helm deployment by removing manual process (migration on first deployment).

Without it, I had to manually exec manage.py migrate inside pod, because database was empty.

@azhavoro
Copy link
Contributor

@azhavoro Thanks for question. It simplifies helm deployment by removing manual process (migration on first deployment).

Without it, I had to manually exec manage.py migrate inside pod, because database was empty.

The back-end container startup process invokes the migration on every run, including the first https://github.com/openvinotoolkit/cvat/blob/develop/supervisord.conf#L62 and I don't see the command is overridden in the deployment https://github.com/openvinotoolkit/cvat/blob/develop/helm-chart/templates/cvat_backend/deployment.yml#L44-L117 and it seems that this init container looks unnecessary. Your changes to README.md look ok, but I think it's better to understand why the migration is not run on first deployment in your case.

@kbegiedza
Copy link
Contributor Author

Thanks for review @azhavoro, will remove init container from PR and investigate it further (and open new one if needed).

@kbegiedza kbegiedza changed the title Added backend init container and better readme to Helm chart Better readme to Helm chart Feb 22, 2022
@kbegiedza
Copy link
Contributor Author

@azhavoro fix'd

@azhavoro
Copy link
Contributor

Sorry for the late response, LGTM

Copy link
Contributor

@nmanovic nmanovic left a comment

Choose a reason for hiding this comment

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

@kbegiedza , thanks for your contribution!

@nmanovic nmanovic merged commit 93ccf21 into cvat-ai:develop Mar 16, 2022
mikhail-treskin pushed a commit to retailnext/cvat that referenced this pull request Jun 22, 2022
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.

3 participants