File: README.rst

package info (click to toggle)
celery 5.6.0-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 8,572 kB
  • sloc: python: 66,917; sh: 795; makefile: 378
file content (77 lines) | stat: -rw-r--r-- 1,968 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Helm Chart for Celery
=====================

This helm chart can be used for deploying Celery in local or a kubernetes server.

It contains following main folders/files:

::

    helm-chart
    ├── Chart.yaml
    ├── README.rst
    ├── templates
    │   ├── _helpers.tpl
    │   ├── configmap.yaml
    │   ├── deployment.yaml
    │   ├── secret.yaml
    │   └── serviceaccount.yaml
    └── values.yaml

The most important file here will be ``values.yaml``.
This will be used for setting/altering parameters, most of the parameters are annotated inside ``values.yaml`` with comments.

Deploying on Cluster:
--------------------

If you want to setup and test on local, check out: `setting up on local`_

To install on kubernetes cluster run following command from root of project:

::

    helm install celery helm-chart/

You can also setup environment-wise value files, for example: ``values_dev.yaml`` for ``dev`` env,
then you can use following command to override the current ``values.yaml`` file's parameters to be environment specific:

::

    helm install celery helm-chart/ --values helm-chart/values_dev.yaml

To upgrade an existing installation of chart you can use:

::

    helm upgrade --install celery helm-chart/

    or

    helm upgrade --install celery helm-chart/ --values helm-chart/values_dev.yaml


You can uninstall the chart using helm:

::

    helm uninstall celery

.. _setting up on local:

Setting up on local:
--------------------
To setup kubernetes cluster on local use the following link:

- k3d_
- `Colima (recommended if you are on MacOS)`_

.. _`k3d`: https://k3d.io/v5.7.3/
.. _`Colima (recommended if you are on MacOS)`: https://github.com/abiosoft/colima?tab=readme-ov-file#kubernetes

You will also need following tools:

- `helm cli`_
- `kubectl`_

.. _helm cli: https://helm.sh/docs/intro/install/
.. _kubectl: https://kubernetes.io/docs/tasks/tools/