{"id":24641179,"url":"https://github.com/elixir-cloud-aai/cloud-registry","last_synced_at":"2025-05-12T15:02:44.116Z","repository":{"id":56284136,"uuid":"310943623","full_name":"elixir-cloud-aai/cloud-registry","owner":"elixir-cloud-aai","description":"GA4GH Service Registry API implementation for the ELIXIR Cloud","archived":false,"fork":false,"pushed_at":"2024-09-10T15:42:35.000Z","size":72,"stargazers_count":4,"open_issues_count":15,"forks_count":1,"subscribers_count":23,"default_branch":"dev","last_synced_at":"2025-03-31T23:36:26.628Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/elixir-cloud-aai.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}},"created_at":"2020-11-07T22:32:48.000Z","updated_at":"2024-07-16T06:21:01.000Z","dependencies_parsed_at":"2022-08-15T16:00:45.454Z","dependency_job_id":"f3f447a2-ba4b-41c2-91ea-46c96e5119f6","html_url":"https://github.com/elixir-cloud-aai/cloud-registry","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-cloud-aai%2Fcloud-registry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-cloud-aai%2Fcloud-registry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-cloud-aai%2Fcloud-registry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elixir-cloud-aai%2Fcloud-registry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elixir-cloud-aai","download_url":"https://codeload.github.com/elixir-cloud-aai/cloud-registry/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253761767,"owners_count":21960214,"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","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-01-25T12:12:33.962Z","updated_at":"2025-05-12T15:02:44.052Z","avatar_url":"https://github.com/elixir-cloud-aai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ELIXIR Cloud service registry\n\n[![License][badge-license]][badge-url-license]\n[![Docs][badge-docs]][badge-url-docs]\n[![Build_status][badge-build-status]][badge-url-build-status]\n[![Coverage][badge-coverage]][badge-url-coverage]\n\n## Synopsis\n\nGA4GH Service Registry API implementation for the ELIXIR Cloud. The registry is\ncurrently deployed at [https://cloud-registry.rahtiapp.fi][deploy_url], but\nwill likely move soon.\n\n## Description\n\nService entries comply with the [`ExternalService` schema][schema-service]\ndefined in the [GA4GH Service Registry API][ga4gh-registry].\n\nFor developers, an API documentation (of the code, not the exposed API) is\navailable [here][docs-api].\n\n## Usage\n\nOnce [deployed](#Installation), the API will be served here:\n\n```text\nhttp://localhost:8080/ga4gh/registry/v1/\n```\n\nYou can explore the service via the [Swagger UI][url-swagger].\n\n\u003e Note that host and port can be adapted in the [`docker-compose`\n\u003e configuration][config]. In that case, the values in the URLs above need to be\n\u003e updated accordingly.\n\n[Endpoints][schema-endpoints] can be probed with `curl`, for example:\n\n```bash\ncurl -X GET \"http://localhost:8080/ga4gh/registry/v1/services\" -H  \"accept: application/json\"\n```\n\n## Installation\n\nTo quickly install the service for development/testing purposes, we recommend\ndeployment via [`docker-compose`][docker-compose], as described below. For\nmore durable deployments on cloud native infrastructure, we also provide a\n[Helm][helm] chart in the [`deployments/`][deployment] directory, together with\n[basic deployment instructions][deployment-instructions] (details may need to\nbe adapted for your specific infrastructure).\n\n### Requirements\n\nThe following software needs to be available on your system:\n\n- [`git 2.17.1`][git]\n- [`docker 18.09.6`][docker]\n- [`docker-compose 1.23.1`][docker-compose]\n\n\u003e Versions used to test deployment are indicated. Other versions with the same\n\u003e major version numbers will likely work as well, especially newer ones.\n\n### Deployment\n\nFirst, clone the repository and traverse into the root directory with:\n\n```bash\ngit clone git@github.com:elixir-cloud-aai/cloud-registry.git\ncd cloud-registry\n```\n\nThen simply start up the service with:\n\n```bash\ndocker-compose up --build -d\n```\n\n_**That't it!**_\n\nYou should now be able to use/explore the API as described in\nthe [usage section](#Usage).\n\n#### Other useful commands\n\nTo shut down the service, run:\n\n```bash\ndocker-compose down\n```\n\nIf you need to inspect the logs, call:\n\n```bash\ndocker-compose logs\n```\n\n## Contributing\n\nThis project is a community effort and lives off your contributions, be it in\nthe form of bug reports, feature requests, discussions, or fixes and other code\nchanges. Please refer to our organization's [contribution\nguidelines][contributing] if you are interested to contribute. Please mind the\n[code of conduct][coc] for all interactions with the community.\n\n## Versioning\n\nThe project adopts the [semantic versioning][semver] scheme for versioning.\nCurrently the service is in beta stage, so the API may change without further\nnotice.\n\n## License\n\nThis project is covered by the [Apache License 2.0][license-apache] also\n[shipped with this repository][license].\n\n## Contact\n\nThe project is a collaborative effort under the umbrella of [ELIXIR Cloud \u0026\nAAI][elixir-cloud]. Follow the link to get in touch with us via chat or email.\nPlease mention the name of this service for any inquiry, proposal, question\netc.\n\n[badge-build-status]:\u003chttps://github.com/elixir-cloud-aai/cloud-registry/actions/workflows/checks.yaml/badge.svg\u003e\n[badge-coverage]:\u003chttps://img.shields.io/coveralls/github/elixir-cloud-aai/cloud-registry\u003e\n[badge-docs]: \u003chttps://readthedocs.org/projects/cloud-registry/badge/?version=latest\u003e\n[badge-github-tag]:\u003chttps://img.shields.io/github/v/tag/elixir-cloud-aai/cloud-registry?color=C39BD3\u003e\n[badge-license]:\u003chttps://img.shields.io/badge/license-Apache%202.0-blue.svg\u003e\n[badge-url-build-status]:\u003chttps://github.com/elixir-cloud-aai/cloud-registry/actions/workflows/checks.yaml\u003e\n[badge-url-coverage]:\u003chttps://coveralls.io/github/elixir-cloud-aai/cloud-registry\u003e\n[badge-url-docs]: \u003chttps://cloud-registry.readthedocs.io/en/latest/?badge=latest\u003e\n[badge-url-github-tag]:\u003chttps://github.com/elixir-cloud-aai/cloud-registry/releases\u003e\n[badge-url-license]:\u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e\n[ga4gh-registry]: \u003chttps://github.com/ga4gh-discovery/ga4gh-service-registry\u003e\n[config]: docker-compose.yaml\n[deploy_url]: \u003chttps://cloud-registry.rahtiapp.fi/ga4gh/registry/v1/ui\u003e\n[deployment]: deployment/\n[deployment-instructions]: deployment/README.md\n[docker]: \u003chttps://docs.docker.com/get-docker/\u003e\n[docker-compose]: \u003chttps://docs.docker.com/compose/install/\u003e\n[docs-api]: \u003chttps://cloud-registry.readthedocs.io/en/latest/\u003e\n[git]: \u003chttps://git-scm.com/book/en/v2/Getting-Started-Installing-Git\u003e\n[helm]: \u003chttps://helm.sh/\u003e\n[license]: LICENSE\n[license-apache]: \u003chttps://www.apache.org/licenses/LICENSE-2.0\u003e\n[elixir-cloud]: \u003chttps://github.com/elixir-cloud-aai/elixir-cloud-aai\u003e\n[coc]: \u003chttps://github.com/elixir-cloud-aai/elixir-cloud-aai/blob/dev/CODE_OF_CONDUCT.md\u003e\n[contributing]: \u003chttps://github.com/elixir-cloud-aai/elixir-cloud-aai/blob/dev/CONTRIBUTING.md\u003e\n[semver]: \u003chttps://semver.org/\u003e\n[schema-service]: \u003chttps://github.com/ga4gh-discovery/ga4gh-service-registry/blob/8c45be52940db92c2fa1cd821519c271c22b1c4c/service-registry.yaml#L158\u003e\n[schema-endpoints]: \u003chttps://github.com/ga4gh-discovery/ga4gh-service-registry/blob/8c45be52940db92c2fa1cd821519c271c22b1c4c/service-registry.yaml#L16\u003e\n[url-swagger]: \u003chttp://localhost:8080/ga4gh/registry/v1/ui\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felixir-cloud-aai%2Fcloud-registry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felixir-cloud-aai%2Fcloud-registry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felixir-cloud-aai%2Fcloud-registry/lists"}