25975467ea
* Fix all issues reported by remark * Move remark dependencies from the workflow definition into package.json This enables the transitive dependencies to be pinned, just like for all other packages. * Add additional remark plugins These are needed to correctly parse certain constructs in Markdown files (such as tables and YAML frontmatter), and without them, remark produces invalid warnings on some files. * Update the remark-lint preset versions The previous versions reference the old version of the `remark-lint-table-cell-padding` plugin, which doesn't work correctly with the current version of `remark-parse` (and thus produces spurious warnings). * GitHub Actions: run remark on all Markdown files, not just changed ones This way, if a PR updates the remark configuration and that causes new errors to appear, those errors will show up in that PR, instead of the (unrelated) PR that next updates the affected files. There is no runtime cost to this, because remark takes approximately 1 second to check all files. |
5 years ago | |
|---|---|---|
| .. | ||
| templates | 5 years ago | |
| .helmignore | 5 years ago | |
| Chart.yaml | 5 years ago | |
| README.md | 5 years ago | |
| values.yaml | 5 years ago | |
README.md
FAQ
What should be configured before installation?
- You should have configured connection to existed k8s cluster
- Helm must be installed
- You should download chart external dependencies, using following commands:
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
helm dependency update
- (Optional) Install ingress of your choice (for example: https://github.com/kubernetes/ingress-nginx)
- (Optional) Create certificates for https (for example: https://github.com/jetstack/cert-manager/)
- (Optional) Create values.override.yaml and override there parameters you want
- Change postgresql password as described below
- Add ingress to values.override.yaml(example also below)
- Deploy cvat using command below
How to deploy new version of chart to cluster?
Execute following command:
helm upgrade <release_name> --install ./helm-chart -f ./helm-chart/values.yaml -f values.override.yaml(if exists) --namespace <desired namespace>
How to create superuser?
HELM_RELEASE_NAMESPACE="<insert>" &&\
HELM_RELEASE_NAME="<insert>" &&\
BACKEND_POD_NAME=$(kubectl get pod --namespace $HELM_RELEASE_NAMESPACE -l tier=backend,app.kubernetes.io/instance=$HELM_RELEASE_NAME -o jsonpath='{.items[0].metadata.name}') &&\
kubectl exec -it --namespace $HELM_RELEASE_NAMESPACE $BACKEND_POD_NAME -c cvat-backend-app-container -- python manage.py createsuperuser
How to change embedded postgresql password?
There are several passwords used here, for security reasons - better change them all.
postgresql:
secret:
password: cvat_postgresql
postgres_password: cvat_postgresql_postgres
replication_password: cvat_postgresql_replica
Or, if you know how to work with k8s - you could create your own secret and use it here:
postgresql:
global:
postgresql:
existingSecret: cvat-postgres-secret
How to describe ingress:
Just set ingress.enabled: to true, then copy example, uncomment it and change values there
How to understand what diff will be inflicted by 'helm upgrade'?
You can use https://github.com/databus23/helm-diff#install for that
I want to use my own postgresql/redis with your chart.
Just set postgresql.enabled or redis.enabled to false, as described below.
Then - put your instance params to "external" field
I want to override some settings in values.yaml.
Just create file values.override.yaml and place your changes here, using same structure as in values.yaml.
Then reference it in helm update/install command using -f flag
Why you used external charts to provide redis and postgres?
Because they definitely know what they do better then we are, so we are getting more quality and less support
What is kubernetes and how it is working?
What is helm and how it is working?
See https://helm.sh/