github.com/kubevela/workflow@v0.6.0/charts/vela-workflow/README.md (about) 1 <div style="text-align: center"> 2 <p align="center"> 3 <img src="https://raw.githubusercontent.com/kubevela/kubevela.io/main/docs/resources/KubeVela-03.png"> 4 <br><br> 5 <i>Make shipping applications more enjoyable.</i> 6 </p> 7 </div> 8 9 [](https://goreportcard.com/report/github.com/kubevela/workflow) 10 [](https://codecov.io/gh/kubevela/workflow) 11 [](/LICENSE) 12 [](https://lgtm.com/projects/g/kubevela/workflow/alerts/) 13 14 # KubeVela Workflow helm chart 15 16 ## TL;DR 17 18 ```bash 19 helm repo add kubevela https://charts.kubevela.net/core 20 helm repo update 21 helm install --create-namespace -n vela-system workflow kubevela/vela-workflow --wait 22 ``` 23 24 ## Prerequisites 25 26 - Kubernetes >= v1.19 && < v1.22 27 28 ## Parameters 29 30 ### Core parameters 31 32 | Name | Description | Value | 33 | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------- | 34 | `systemDefinitionNamespace` | System definition namespace, if unspecified, will use built-in variable `.Release.Namespace`. | `nil` | 35 | `concurrentReconciles` | concurrentReconciles is the concurrent reconcile number of the controller | `4` | 36 | `ignoreWorkflowWithoutControllerRequirement` | will determine whether to process the workflowrun without 'workflowrun.oam.dev/controller-version-require' annotation | `false` | 37 38 39 ### KubeVela workflow parameters 40 41 | Name | Description | Value | 42 | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | 43 | `workflow.enableSuspendOnFailure` | Enable the capability of suspend an failed workflow automatically | `false` | 44 | `workflow.enablePatchStatusAtOnce` | Enable the capability of patch status at once | `false` | 45 | `workflow.enableWatchEventListener` | Enable the capability of watch event listener for a faster reconcile, note that you need to install [kube-trigger](https://github.com/kubevela/kube-trigger) first to use this feature | `false` | 46 | `workflow.backoff.maxTime.waitState` | The max backoff time of workflow in a wait condition | `60` | 47 | `workflow.backoff.maxTime.failedState` | The max backoff time of workflow in a failed condition | `300` | 48 | `workflow.step.errorRetryTimes` | The max retry times of a failed workflow step | `10` | 49 | `workflow.groupByLabel` | The label used to group workflow record | `pipeline.oam.dev/name` | 50 51 52 ### KubeVela workflow backup parameters 53 54 | Name | Description | Value | 55 | ------------------------------ | ---------------------------------------------- | -------------------------- | 56 | `backup.enabled` | Enable backup workflow record | `false` | 57 | `backup.strategy` | The backup strategy for workflow record | `BackupFinishedRecord` | 58 | `backup.ignoreStrategy` | The ignore strategy for backup | `IgnoreLatestFailedRecord` | 59 | `backup.cleanOnBackup` | Enable auto clean after backup workflow record | `false` | 60 | `backup.persistType` | The persist type for workflow record | `""` | 61 | `backup.configSecretName` | The secret name of backup config | `backup-config` | 62 | `backup.configSecretNamespace` | The secret name of backup config namespace | `vela-system` | 63 64 65 ### KubeVela Workflow controller parameters 66 67 | Name | Description | Value | 68 | --------------------------- | ------------------------------------ | ---------------------- | 69 | `replicaCount` | Workflow controller replica count | `1` | 70 | `imageRegistry` | Image registry | `""` | 71 | `image.repository` | Image repository | `oamdev/vela-workflow` | 72 | `image.tag` | Image tag | `latest` | 73 | `image.pullPolicy` | Image pull policy | `Always` | 74 | `resources.limits.cpu` | Workflow controller's cpu limit | `500m` | 75 | `resources.limits.memory` | Workflow controller's memory limit | `1Gi` | 76 | `resources.requests.cpu` | Workflow controller's cpu request | `50m` | 77 | `resources.requests.memory` | Workflow controller's memory request | `20Mi` | 78 | `webhookService.type` | KubeVela webhook service type | `ClusterIP` | 79 | `webhookService.port` | KubeVela webhook service port | `9443` | 80 | `healthCheck.port` | KubeVela health check port | `9440` | 81 82 83 ### Common parameters 84 85 | Name | Description | Value | 86 | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------- | --------------- | 87 | `imagePullSecrets` | Image pull secrets | `[]` | 88 | `nameOverride` | Override name | `""` | 89 | `fullnameOverride` | Fullname override | `""` | 90 | `serviceAccount.create` | Specifies whether a service account should be created | `true` | 91 | `serviceAccount.annotations` | Annotations to add to the service account | `{}` | 92 | `serviceAccount.name` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | `nil` | 93 | `nodeSelector` | Node selector | `{}` | 94 | `tolerations` | Tolerations | `[]` | 95 | `affinity` | Affinity | `{}` | 96 | `rbac.create` | Specifies whether a RBAC role should be created | `true` | 97 | `logDebug` | Enable debug logs for development purpose | `false` | 98 | `logFilePath` | If non-empty, write log files in this path | `""` | 99 | `logFileMaxSize` | Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. | `1024` | 100 | `kubeClient.qps` | The qps for reconcile clients, default is 50 | `500` | 101 | `kubeClient.burst` | The burst for reconcile clients, default is 100 | `1000` | 102 | `kubeClient.userAgent` | The user agent of the client, default is vela-workflow | `vela-workflow` | 103 104 105 ## Uninstallation 106 107 ### Helm CLI 108 109 ```shell 110 $ helm uninstall -n vela-system workflow 111 ```