{"id":28485532,"url":"https://github.com/orientechnologies/orientdb-helm","last_synced_at":"2025-09-04T00:36:54.389Z","repository":{"id":54254485,"uuid":"287279910","full_name":"orientechnologies/orientdb-helm","owner":"orientechnologies","description":"Helm chart for OrientDB","archived":false,"fork":false,"pushed_at":"2021-03-25T07:24:01.000Z","size":60,"stargazers_count":5,"open_issues_count":3,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-15T10:52:02.282Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Smarty","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orientechnologies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-13T12:56:00.000Z","updated_at":"2024-05-31T01:51:02.000Z","dependencies_parsed_at":"2022-08-13T10:10:24.535Z","dependency_job_id":null,"html_url":"https://github.com/orientechnologies/orientdb-helm","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/orientechnologies/orientdb-helm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orientechnologies%2Forientdb-helm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orientechnologies%2Forientdb-helm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orientechnologies%2Forientdb-helm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orientechnologies%2Forientdb-helm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orientechnologies","download_url":"https://codeload.github.com/orientechnologies/orientdb-helm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orientechnologies%2Forientdb-helm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273534075,"owners_count":25122635,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-08T00:11:15.725Z","updated_at":"2025-09-04T00:36:54.363Z","avatar_url":"https://github.com/orientechnologies.png","language":"Smarty","funding_links":[],"categories":[],"sub_categories":[],"readme":"# orientdb-helm\nHelm chart for OrientDB (version \u003e= 3.1.3).\n\n\u003e **Disclaimer**: This Helm chart is provided for testing purposes only or trying out OrientDB CE on Kubernetes. This Helm chart is not part of any official OrientDB release and it is only supported by community contributions. For any issues/questions please use the GitHub Issues.\n\nTo install, make sure the Kubernetes namespace mentioned in `values.yaml` exists and then issue:\n\n```\nhelm install helm-release-name path/to/Orientdb/chart\n```\n\n\nYou can scale up/down the OrientDB cluster using `upgrade`. For example to change the cluster size to 3:\n```\nhelm upgrade helm-release-name path/to/Orientdb/chart --set servers=3\n```\n\nTo delete the OrientDB cluster issue:\n```\nhelm delete helm-release-name\n```\n\nNote that deleting the Helm release does not delete the PVCs created and therefore the PVs will not be released. To do so, you'd need to explicitly remove the PVCs.\n\nSome of the parameters that can be changed/passed to the helm chart:\n\n| Parameter Name | Default Value | Description |\n|----------------|---------------|-------------|\n| `volumeClaims.backup.mount`| `false` | Create a PVC for backup |\n|`servers`|`3`|Number of OrientDB instances in the cluster|\n|`createRootUser`|`true`|Create the `root` user on each server|\n|`rootPassword`|`root`|Password for the `root` user|\n|`environmentVariables`|`[]`|List of environment variables passed to the server. This could be used to change the JVM heap size for example|\n|`image.repository`|`orientdb`|Image repository and name. E.g. `repo/customOrient`|\n|`serviceAccount.create`|`true`|Whether to create the kubernetes service account used by Hazelcast. If false, it must already exist, and its name must be provided using `serviceAccount.name`|\n|`volumeClaims.databases`|No storage class and `2Gi`|storage class and size of the PV to use for storing databases|\n|`service.nodePort.create`|`false`|Create a `NodePort` service exposing binary and HTTP port of all instances |\n|`tryAvoidingColocation` | `false` | If true, try to spread the OrientDB instances evenly across the cluster nodes |\n|`statefulSetName`|`orientdb`|Name of the StatefulSet created|\n|`security.customSecurityConfigFile`| |If provided, the content of this file is used for `security.json`|\n|`log.customLogPropertiesFile`| |If provided, the content of this file is used for `orientdb-server-log.properties`|\n|`automaticBackup.customBackupConfigFile`| |If provided, the content of this file is used for `automatic-backup.json` to configure automatic backup|\n|`ssl.enable`|`false`|Enable TLS connections to server (HTTPS and binary)|\n|`ssl.keyStoreFile`||Path to keystore file for TLS|\n|`ssl.keyStorePassword`||Password of the provided keystore|\n|`ssl.trustStoreFile`||Path to truststore file for TLS|\n|`ssl.trustStorePassword`||Password of the provided truststore|\n|`ssl.clientAuth`|`false`|Whether to use mutual TLS authentication with clients|\n\n## OrientDB and Gremlin / TinkerPop\n\nTo enable running Gremlin queries via OrientDB Studio, you should use an OrientDB distribution with TinkerPop3 support, and enable Gremlin server-side script:\n```\nhelm install helm-release-name path/to/Orientdb/chart --set image.tag=3.1.9-tp3 --set \"serverSideScript.allowedLanguages={SQL,Gremlin}\"\n```\n\n\u003e Using the helm chart for deploying non-CE OrientDB distributions (e.g., EE, TinkerPop) requires the corresponding docker image to be passed as the parameter to the Helm chart.  For OrientDB with TinkerPop3 an official docker image is provided, e.g. from [here](https://github.com/orientechnologies/orientdb-docker/blob/master/3.0-tp3/x86_64/alpine/gremlin-server.yaml).\n\n## Custom configuration\n\nWhen providing custom config files to the Helm chart, note that Helm cannot access files located outside of the chart directory or under the templates directory.\n\nOther configurations that can be set are:\n* Attaching custom labels and annotations to the resources created by the chart.\n* Defining resource limits and requests.\n* Override default configurations defined in OrientDB configuration files such as `hazelcast.xml`, `orientdb-server-config.xml`, ` default-distributed-db-config.json`, etc.\n\n## Multi-master\n\nOrientDB supports a multi-master (a.k.a. master-less) architecture. Therefore, it might be useful to expose each OrientDB instance in the cluster separately. As all instance are part of the same StatefulSet, one simple approach would to create one service per instance that uses the naming convention of StatefulSets `statefulSetName-0`, `statefulSetName-1`, ... \n\nTo do so the service could use a Pod selector similar to the following:\n```\n\"statefulset.kubernetes.io/pod-name\": \"statefulSetName-0\"\n``` \n\n## Security\n\nTo deploy with TLS enabled, you should deploy the chart with `ssl.enable=true` and provide the keystore and truststore files and password. You can find more information on how to setup TLS in the [official OrientDB documentations.](http://orientdb.org/docs/3.1.x/security/Using-SSL-with-OrientDB.html)\n\nIn case there is not enough entropy available on `/dev/random` the startup of the server might block. You could [deploy a haveged daemon](./havegedSetup.md) to address this issue.\n\n**TODOs**\n\n- [ ] add helm chart to repository for testing\n- [ ] document EE \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forientechnologies%2Forientdb-helm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forientechnologies%2Forientdb-helm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forientechnologies%2Forientdb-helm/lists"}