{"id":44382402,"url":"https://github.com/nuodb/nuodb-cp-releases","last_synced_at":"2026-02-20T21:07:27.642Z","repository":{"id":191754169,"uuid":"685095318","full_name":"nuodb/nuodb-cp-releases","owner":"nuodb","description":"Releases and documentation for the NuoDB DBaaS Control Plane","archived":false,"fork":false,"pushed_at":"2026-02-11T21:22:21.000Z","size":231,"stargazers_count":1,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-02-12T05:58:53.118Z","etag":null,"topics":["dbaas","kubernetes","kubernetes-operator","nuodb","sql"],"latest_commit_sha":null,"homepage":"https://nuodb.github.io/nuodb-cp-releases/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nuodb.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-08-30T14:02:16.000Z","updated_at":"2024-09-16T15:07:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"7cd5d733-1b40-4000-bada-ab6199caded3","html_url":"https://github.com/nuodb/nuodb-cp-releases","commit_stats":null,"previous_names":["nuodb/nuodb-cp-releases"],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/nuodb/nuodb-cp-releases","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuodb%2Fnuodb-cp-releases","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuodb%2Fnuodb-cp-releases/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuodb%2Fnuodb-cp-releases/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuodb%2Fnuodb-cp-releases/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuodb","download_url":"https://codeload.github.com/nuodb/nuodb-cp-releases/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuodb%2Fnuodb-cp-releases/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29664597,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T19:49:36.704Z","status":"ssl_error","status_checked_at":"2026-02-20T19:44:05.372Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["dbaas","kubernetes","kubernetes-operator","nuodb","sql"],"created_at":"2026-02-11T23:44:58.069Z","updated_at":"2026-02-20T21:07:27.635Z","avatar_url":"https://github.com/nuodb.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NuoDB Control Plane\n\nThis repository is for releases and documentation for the NuoDB Control Plane, which enables automatic management of NuoDB databases in Kubernetes.\n\nNuoDB Control Plane allows users to provision NuoDB databases on-demand remotely using REST services by exposing various predefined configuration options.\nNuoDB domain and database are modeled as Kubernetes [Custom Resources][1] (CRs).\nTheir [Custom Resource Definitions][2] (CRDs) act as contracts between NuoDB Operator and the other modules.\n\n![nuodb-control-plane-overview](docs/images/overview.png)\n\n## Documentation\n\nThe NuoDB Control Plane documentation is available at [documentation](https://nuodb.github.io/nuodb-cp-docs/).\nThe REST API non-interactive documentation is available at [API documentation][3].\n\n### Get Started\n\n- [Quick Start Guide](https://nuodb.github.io/nuodb-cp-docs/docs/getting-started/deploy-nuodb-control-plane/)\n\n## Installation\n\nTo install the NuoDB Control Plane into your Kubernetes cluster, first add the Helm repository for the NuoDB Control Plane Helm charts.\n\n```sh\nhelm repo add nuodb-cp https://nuodb.github.io/nuodb-cp-releases/charts\n```\n\nYou can verify that the repo has been added by executing `helm search repo` to list the available Helm charts:\n\n```console\n$ helm repo add nuodb-cp https://nuodb.github.io/nuodb-cp-releases/charts\n\"nuodb-cp\" has been added to your repositories\n\n$ helm search repo nuodb-cp\nNAME                      \tCHART VERSION\tAPP VERSION\tDESCRIPTION\nnuodb-cp/nuodb-cp-crd     \t2.1.1        \t2.1.1      \tNuoDB Control Plane custom resource definitions...\nnuodb-cp/nuodb-cp-doc     \t2.1.1        \t2.1.1      \tInteractive documentation for the NuoDB Control...\nnuodb-cp/nuodb-cp-operator\t2.1.1        \t2.1.1      \tNuoDB Control Plane Operator\nnuodb-cp/nuodb-cp-rest    \t2.1.1        \t2.1.1      \tNuoDB Control Plane REST service\n```\n\nThe NuoDB Control Plane can now be installed as follows:\n\n```sh\nhelm install nuodb-cp-crd nuodb-cp/nuodb-cp-crd\nhelm install nuodb-cp-operator nuodb-cp/nuodb-cp-operator\nhelm install nuodb-cp-rest nuodb-cp/nuodb-cp-rest\n```\n\n## Helm charts\n\nThere are several Helm charts for installing the various components of the NuoDB Control Plane.\n\n- `nuodb-cp-crd` contains [custom resource definitions](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) used by the NuoDB Control Plane to manage NuoDB domains and databases.\nThis must always be installed.\n- `nuodb-cp-operator` contains the [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) for managing NuoDB domains and databases.\nThis must always be installed.\n- `nuodb-cp-rest` contains a REST service that exposes access to the NuoDB Control Plane in a Database as a Service (DBaaS) model.\nThis allows users without access to Kubernetes APIs to manage NuoDB domains and databases.\n- `nuodb-cp-doc` exposes an endpoint for interactive documentation of the NuoDB Control Plane REST service.\nSee [api-doc](https://nuodb.github.io/nuodb-cp-releases/api-doc) for non-interactive documentation of the REST service.\n\n## Dependencies\n\nThe NuoDB Control Plane depends on Kubernetes version 1.19 or later.\n\nAdditional dependencies are listed below.\n\n### Ingress controller\n\nAn Ingress controller can be used to enable external connectivity to the NuoDB Control Plane REST API and to the databases created by it.\nThe [HAProxy Ingress Controller](https://github.com/haproxytech/kubernetes-ingress) can be installed as follows:\n\n```sh\nhelm repo add haproxytech https://haproxytech.github.io/helm-charts\nhelm install haproxy-ingress haproxytech/kubernetes-ingress\n```\n\n### Cert-manager\n\nTo enable [admission webhooks](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/) that perform synchronous validation of NuoDB custom resource definitions, [cert-manager](https://github.com/cert-manager/cert-manager) should be installed to automatically generate certificates for the webhook server.\n\nThis can be done as follows:\n\n```sh\nhelm repo add jetstack https://charts.jetstack.io\nhelm install cert-manager jetstack/cert-manager\n```\n\n## Usage\n\nTo enable multi-tenancy, NuoDB _databases_ managed by the NuoDB Control Plane are grouped into _projects_, which are themselves grouped into _organizations_.\n\nCreate a NuoDB database as follows:\n\n1. Create a project using the `PUT projects` REST endpoint:\n\n```sh\ncurl -X PUT -H 'Content-Type: application/json' \\\n    $BASE_URL/projects/acme/messaging -d '{\"sla\": \"dev\", \"tier\": \"n0.small\"}'\n```\n\n2. Create a database using the `PUT databases` REST endpoint:\n\n```sh\ncurl -X PUT -H 'Content-Type: application/json' \\\n    $BASE_URL/databases/acme/messaging/demo -d '{\"dbaPassword\": \"dba\"}'\n```\n\n\u003e**Note**\n\u003e Projects and databases are identified by resource path segments `\u003corganization\u003e/\u003cproject\u003e` and `\u003corganization\u003e/\u003cproject\u003e/\u003cdatabase\u003e`, respectively. The example above creates the database `demo` within the project `messaging` within the organization `acme`.\n\n[1]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#custom-resources\n[2]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions\n[3]: https://nuodb.github.io/nuodb-cp-releases/api-doc\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuodb%2Fnuodb-cp-releases","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuodb%2Fnuodb-cp-releases","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuodb%2Fnuodb-cp-releases/lists"}