{"id":13586318,"url":"https://github.com/timescale/timescaledb-docker-ha","last_synced_at":"2025-05-07T04:58:50.944Z","repository":{"id":37097132,"uuid":"203553224","full_name":"timescale/timescaledb-docker-ha","owner":"timescale","description":"Create Docker images containing TimescaleDB, Patroni to be used by developers and Kubernetes.","archived":false,"fork":false,"pushed_at":"2025-04-25T02:07:43.000Z","size":1118,"stargazers_count":198,"open_issues_count":28,"forks_count":51,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-05-07T04:58:39.060Z","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/timescale.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2019-08-21T09:38:26.000Z","updated_at":"2025-05-06T09:56:20.000Z","dependencies_parsed_at":"2023-02-19T11:45:48.970Z","dependency_job_id":"c76fc6dc-7222-46c3-9548-d28a6eb18c58","html_url":"https://github.com/timescale/timescaledb-docker-ha","commit_stats":null,"previous_names":[],"tags_count":299,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker-ha","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker-ha/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker-ha/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Ftimescaledb-docker-ha/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timescale","download_url":"https://codeload.github.com/timescale/timescaledb-docker-ha/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252816948,"owners_count":21808704,"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":"2024-08-01T15:05:28.244Z","updated_at":"2025-05-07T04:58:50.919Z","avatar_url":"https://github.com/timescale.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# TimescaleDB Docker image for Kubernetes\n\nThis directory contains everything that allows us to create a Docker image with the following pieces of software:\n\n- PostgreSQL\n- Some PostgreSQL extensions, most notably PostGIS\n- TimescaleDB, multiple versions\n- pgBackRest\n- scripts to make it all work in a Kubernetes Context\n\nCurrently, our base image is Ubuntu, as we require glibc 2.33+.\n\nIt's currently pushing the resulting images to: https://hub.docker.com/r/timescale/timescaledb-ha\n\n## Build images\n\nTo build an image, run the following make target:\n\n```console\nmake\n```\n\nAs building the whole image takes considerably amounts of time, the default will only install 1 timescaledb version:\nThe head of the `master` branch of the github.com/timescale/timescaledb.\n\nFor more robust build runs do:\n\n```console\nmake build\n```\n\nOr, if you only want to exclude Timescale License code you can use the following command:\n\n```console\nmake build-oss\n```\n\n\u003e For more information about licensing, please read our [blog post](https://blog.timescale.com/blog/how-we-are-building-an-open-source-business-a7701516a480/) about the subject.\n\nBy default, the Docker image contains many extensions, including [TimescaleDB](https://github.com/timescale/timescaledb) and [PostGIS](https://postgis.net/).\nYou can override which version of the extensions are built by setting environment variables, some examples:\n\n```console\n# Build without any PostGIS\nPOSTGIS_VERSIONS=\"\" make build\n```\n\nFor further environment variables that can be set, we point you to the [Makefile](Makefile) itself.\n\nFor updating changes in versions for timescaledb, pgvectorscale, or toolkit, update `build_scripts/versions.yaml`\n\n## Verify your work\n\nFor every pushed commit to this repository, a Docker Image will be built. Once your commit is pushed, a Docker Image will\nbe built, and if successful, will be pushed. The tag of this Docker Image will be `cicd-\u003cfirst 7 chars of commit sha\u003e-amd64`,\nfor example, for commit `baddcafe...`, the tag will look like:\n```text\ntimescale/timescaledb-ha:cicd-baddcaf-amd64\n```\n\n#### Find out tag using commandline\n\nAssuming your current working directory is on the same commit as the one you pushed\n\n```console\necho \"timescale/timescaledb-ha:cicd-$(git rev-parse HEAD | cut -c 1-7)\"\n```\n\n#### Find tag using GitHub Web interface\n\n- Actions\n- Click on the **Build branch** Workflow for your commit/branch\n- Look at the `Build and push branch summary` for the tag\n\n##### Example output\n\n```text\nChecking docker.io/timescale/timescaledb-ha:cicd-8578fce-amd64\n\namd64: the base image was built 93 seconds ago\n...\n```\n\nIn the above example, your Docker tag is `cicd-8578fce-amd64` and your full image url is:\n\n```text\ndocker.io/timescale/timescaledb-ha:cicd-8578fce-amd64\n```\n\n## Test your Docker Image\n\n```console\ndocker run --rm -ti -e POSTGRES_PASSWORD=smoketest docker.io/timescale/timescaledb-ha:cicd-baddcaf-amd64\n```\n\n## Versioning and Releases\n\n### Release Process\n\nBetween releases, we keep track of notable changes in CHANGELOG.md.\n\nWhen we want to make a release we should update CHANGELOG.md to contain the release notes for the planned release in a section for\nthe proposed release number. This update is the commit that will be tagged with as the actual release which ensures that each release\ncontains a copy of it's own release notes.\n\nWe should also copy the release notes to the Github releases page, but CHANGELOG.md is the primary place to keep the release notes.\n\nThe release commit should be tagged with a signed tag:\n\n```console\ngit tag -s vx.x.x\ngit push --tags\n```\n\nIf you use the release notes in the tag commit message and it will automatically appear in the Github release. On the Github releases\npage click `Draft a new release` and then type your tag in the drop down contain `@master`. The release will automatically be created\nusing the tag commit text.\n\n### Publish the images to Docker Hub and other registries\n\nThey will be written under quite a few aliases, for example, for PostgreSQL 15.2 and Timescale 2.10.3, the following images will be built and pushed/overwritten:\n\n- timescale/timescaledb-ha:pg15\n- timescale/timescaledb-ha:pg15-all\n- timescale/timescaledb-ha:pg15-ts2.10\n- timescale/timescaledb-ha:pg15-ts2.10-all\n- timescale/timescaledb-ha:pg15.2-ts2.10.3\n- timescale/timescaledb-ha:pg15.2-ts2.10.3-all\n\nFor `OSS_ONLY` builds, the following tags will be published:\n- timescale/timescaledb-ha:pg15-oss\n- timescale/timescaledb-ha:pg15-all-oss\n- timescale/timescaledb-ha:pg15-ts2.10-oss\n- timescale/timescaledb-ha:pg15-ts2.10-all-oss\n- timescale/timescaledb-ha:pg15.2-ts2.10.3-oss\n- timescale/timescaledb-ha:pg15.2-ts2.10.3-all-oss\n\nThe `-all` portion of the tags specifies that the image contains pg15, as well as version 13, and 14. Otherwise, only\nthe single version of PostgreSQL is included in the image.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Ftimescaledb-docker-ha","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimescale%2Ftimescaledb-docker-ha","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Ftimescaledb-docker-ha/lists"}