|
| 1 | +# orion-ld |
| 2 | + |
| 3 | +  |
| 4 | + |
| 5 | +A Helm chart for running the fiware orion-ld context broker on kubernetes. |
| 6 | + |
| 7 | +**Homepage:** <https://github.com/FIWARE/context.Orion-LD> |
| 8 | + |
| 9 | +## Maintainers |
| 10 | + |
| 11 | +| Name | Email | Url | |
| 12 | +| ---- | ------ | --- | |
| 13 | +| wistefan | stefan.wiedemann@fiware.org | | |
| 14 | + |
| 15 | +## Source Code |
| 16 | + |
| 17 | +* <https://github.com/FIWARE/context.Orion-LD> |
| 18 | + |
| 19 | +## Requirements |
| 20 | + |
| 21 | +Kubernetes: `>= 1.19` |
| 22 | + |
| 23 | +## Values |
| 24 | + |
| 25 | +| Key | Type | Default | Description | |
| 26 | +|-----|------|---------|-------------| |
| 27 | +| autoscaling.enabled | bool | `false` | should autoscaling be enabled for the context broker | |
| 28 | +| autoscaling.maxReplicas | int | `10` | maximum number of running pods | |
| 29 | +| autoscaling.metrics | list | `[]` | metrics to react on | |
| 30 | +| autoscaling.minReplicas | int | `1` | minimum number of running pods | |
| 31 | +| broker.cachedContextFolder | string | `"/opt/orion/ldcontexts"` | | |
| 32 | +| broker.db.hosts | list | `[]` | configuration of the mongo-db hosts. if multiple hosts are inserted, its assumed that mongo is running as a replica set | |
| 33 | +| broker.db.name | string | `"orion"` | the db to use. if running in multiservice mode, its used as a prefix. | |
| 34 | +| broker.envPrefix | string | `"ORIONLD_"` | Prefix to be used for env-vars in orion. Must be ORION_ for orion and ORIONLD_ for orion-ld | |
| 35 | +| broker.ipv4enabled | bool | `false` | set to true if only ipv4 should be used, do not set both options to true | |
| 36 | +| broker.ipv6enabled | bool | `false` | set to true if only ipv6 should be used, do not set both options to true | |
| 37 | +| broker.logging.level | string | `"WARN"` | log level of the broker | |
| 38 | +| broker.metrics.enabled | string | `"false"` | enable or disable metrics gathering | |
| 39 | +| broker.noDevTrace | bool | `true` | should the extended development tracing be disabled? | |
| 40 | +| broker.port | int | `1026` | port that the broker is listening to | |
| 41 | +| broker.troe | object | `{"dbHost":"postgres","dbPassword":"password","dbPort":5432,"dbUser":"user","enabled":false}` | configuration of temporal entity representation | |
| 42 | +| broker.troe.dbHost | string | `"postgres"` | host of the postgres to be used | |
| 43 | +| broker.troe.dbPassword | string | `"password"` | password to authenticate with at postgres | |
| 44 | +| broker.troe.dbPort | int | `5432` | port of the postgres to be used | |
| 45 | +| broker.troe.dbUser | string | `"user"` | username to authenticate with at postgres | |
| 46 | +| broker.troe.enabled | bool | `false` | should temporal representation of entities be enabled | |
| 47 | +| deployment.additionalAnnotations | object | `{}` | additional annotations for the deployment, if required | |
| 48 | +| deployment.additionalLabels | object | `{}` | additional labels for the deployment, if required | |
| 49 | +| deployment.affinity | object | `{}` | affinity template ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity | |
| 50 | +| deployment.image.pullPolicy | string | `"IfNotPresent"` | specification of the image pull policy | |
| 51 | +| deployment.image.repository | string | `"quay.io/fiware/orion-ld"` | orion image name ref: https://hub.docker.com/r/fiware/orion/ ref: https://quay.io/repository/fiware/orion-ld | |
| 52 | +| deployment.image.tag | string | `"1.0.1"` | tag of the image to be used | |
| 53 | +| deployment.livenessProbe.initialDelaySeconds | int | `30` | | |
| 54 | +| deployment.livenessProbe.periodSeconds | int | `10` | | |
| 55 | +| deployment.livenessProbe.successThreshold | int | `1` | | |
| 56 | +| deployment.livenessProbe.timeoutSeconds | int | `30` | | |
| 57 | +| deployment.nodeSelector | object | `{}` | selector template ref: https://kubernetes.io/docs/user-guide/node-selection/ | |
| 58 | +| deployment.readinessProbe.initialDelaySeconds | int | `30` | | |
| 59 | +| deployment.readinessProbe.periodSeconds | int | `10` | | |
| 60 | +| deployment.readinessProbe.successThreshold | int | `1` | | |
| 61 | +| deployment.readinessProbe.timeoutSeconds | int | `30` | | |
| 62 | +| deployment.replicaCount | int | `1` | initial number of target replications, can be different if autoscaling is enabled | |
| 63 | +| deployment.revisionHistoryLimit | int | `3` | number of old replicas to be retained | |
| 64 | +| deployment.sidecars | list | `[]` | additional sidepods for the deployment, if required | |
| 65 | +| deployment.tolerations | list | `[]` | tolerations template ref: ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ | |
| 66 | +| deployment.updateStrategy.rollingUpdate | object | `{"maxSurge":1,"maxUnavailable":0}` | new pods will be added gradually | |
| 67 | +| deployment.updateStrategy.rollingUpdate.maxSurge | int | `1` | number of pods that can be created above the desired amount while updating | |
| 68 | +| deployment.updateStrategy.rollingUpdate.maxUnavailable | int | `0` | number of pods that can be unavailable while updating | |
| 69 | +| deployment.updateStrategy.type | string | `"RollingUpdate"` | type of the update | |
| 70 | +| deployment.volumes | list | `[]` | additional volumes for the deployment, if required | |
| 71 | +| fullnameOverride | string | `""` | option to override the fullname config in the _helpers.tpl | |
| 72 | +| ingress.annotations | object | `{}` | annotations to be added to the ingress | |
| 73 | +| ingress.enabled | bool | `false` | should there be an ingress to connect orion with the public internet | |
| 74 | +| ingress.hosts | list | `[]` | all hosts to be provided | |
| 75 | +| ingress.tls | list | `[]` | configure the ingress' tls | |
| 76 | +| mongo.enabled | bool | `true` | should mongodb be enabled | |
| 77 | +| mongo.image.pullPolicy | string | `"IfNotPresent"` | pull policy to be used for mongo | |
| 78 | +| mongo.image.repository | string | `"quay.io/opencloudio/ibm-mongodb"` | mongo image name | |
| 79 | +| mongo.image.tag | string | `"4.0.24"` | version of mongo | |
| 80 | +| mongo.port | int | `27017` | port to make mongo accessible at | |
| 81 | +| nameOverride | string | `""` | option to override the name config in the _helpers.tpl | |
| 82 | +| route.annotations | object | `{}` | annotations to be added to the route | |
| 83 | +| route.enabled | bool | `false` | | |
| 84 | +| route.tls | object | `{}` | tls configuration for the route | |
| 85 | +| service.annotations | object | `{}` | addtional annotations, if required | |
| 86 | +| service.port | int | `1026` | port to be used by the service | |
| 87 | +| service.type | string | `"ClusterIP"` | service type | |
| 88 | +| serviceAccount | object | `{"create":false}` | if a orion specific service account should be used, it can be configured here ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ | |
| 89 | +| serviceAccount.create | bool | `false` | specifies if the account should be created | |
| 90 | + |
| 91 | +---------------------------------------------- |
| 92 | +Autogenerated from chart metadata using [helm-docs v1.6.0](https://github.com/norwoodj/helm-docs/releases/v1.6.0) |
0 commit comments