2021-04-07 10:39:16 +00:00
---
2022-03-25 10:08:17 +00:00
sort: 18
2023-04-30 10:31:45 +00:00
weight: 18
title: Release process guidance
menu:
docs:
parent: "victoriametrics"
weight: 18
aliases:
- /Release-Guide.html
2021-04-07 10:39:16 +00:00
---
# Release process guidance
2019-12-02 21:00:11 +00:00
2023-05-10 07:50:41 +00:00
## Pre-reqs
2022-08-30 23:27:24 +00:00
1. Make sure you have enterprise remote configured
```
git remote add enterprise < url >
```
2023-07-26 21:08:19 +00:00
1. Make sure you have singing key configured
1. Make sure you have github token with at least `read:org, repo, write:packages` permissions exported under `GITHUB_TOKEN` env variable.
2022-08-30 23:27:24 +00:00
You can create token [here ](https://github.com/settings/tokens )
2023-07-26 21:08:19 +00:00
1. Make sure you're [authorized ](https://hub.docker.com/orgs/victoriametrics/settings/enforce-sign-in/windows ) for pushing docker images
2022-08-30 23:27:24 +00:00
2023-06-13 08:37:51 +00:00
### For MacOS users
Make sure you have GNU version of utilities `zip` , `tar` , `sha256sum` . To install them run the following commands:
```bash
brew install coreutils
brew install gnu-tar
export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"
```
Docker may need additional configuration changes:
```bash
docker buildx create --use --name=qemu
docker buildx inspect --bootstrap
```
For ARM arch (M1/M2 processors) additionally configure docker with preferred platform:
```
export DOCKER_DEFAULT_PLATFORM=linux/amd64
```
By default, docker on MacOS has limited amount of resources (CPU, mem) to use.
Bumping the limits may significantly improve build speed.
2019-12-02 21:00:11 +00:00
## Release version and Docker images
2019-11-30 18:36:10 +00:00
2023-07-26 21:08:19 +00:00
1. Make sure that the release commits have no security issues.
1. Document all the changes for new release in [CHANGELOG.md ](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md ) and update version if needed in [SECURITY.md ](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/SECURITY.md )
1. Add `(available starting from v1.xx.y)` line to feature docs introduced in the upcoming release.
1. Cut new version in [CHANGELOG.md ](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md )
2023-06-13 08:37:51 +00:00
and make it merged. See example in this [commit ](https://github.com/VictoriaMetrics/VictoriaMetrics/commit/b771152039d23b5ccd637a23ea748bc44a9511a7 ).
2023-07-26 21:08:19 +00:00
1. Cherry-pick all changes from `master` to `cluster` branch, and to ENT branches `enterprise-single-node` , `enterprise-cluster` .
1. Cherry-pick bug fixes relevant for LTS releases.
1. Make sure you get all changes fetched `git fetch --all` .
1. Create the following release tags:
2022-01-31 17:18:48 +00:00
* `git tag -s v1.xx.y` in `master` branch
* `git tag -s v1.xx.y-cluster` in `cluster` branch
* `git tag -s v1.xx.y-enterprise` in `enterprise` branch
* `git tag -s v1.xx.y-enterprise-cluster` in `enterprise-cluster` branch
2023-07-26 21:08:19 +00:00
1. Run `TAG=v1.xx.y make publish-release` . This command performs the following tasks:
2022-08-30 23:27:24 +00:00
a) Build and package binaries in `*.tar.gz` release archives with the corresponding `_checksums.txt` files inside `bin` directory.
This step can be run manually with the command `make release` from the needed git tag.
b) Build and publish [multi-platform Docker images ](https://docs.docker.com/build/buildx/multiplatform-images/ )
for the given `TAG` , `TAG-cluster` , `TAG-enterprise` and `TAG-enterprise-cluster` .
The multi-platform Docker image is built for the following platforms:
* linux/amd64
* linux/arm64
* linux/arm
* linux/ppc64le
* linux/386
This step can be run manually with the command `make publish` from the needed git tag.
2023-07-26 21:08:19 +00:00
1. Push the tags `v1.xx.y` and `v1.xx.y-cluster` created at step 2 to public GitHub repository at https://github.com/VictoriaMetrics/VictoriaMetrics.
2023-07-19 23:55:10 +00:00
Push the tags `v1.xx.y` , `v1.xx.y-cluster` , `v1.xx.y-enterprise` and `v1.xx.y-enterprise-cluster` to the corresponding
branches in private repository.
2023-05-10 07:50:41 +00:00
**Important note:** do not push enterprise tags to public GitHub repository - they must be pushed only to private repository.
2023-07-26 21:08:19 +00:00
1. Run `TAG=v1.xx.y make github-create-release github-upload-assets` . This command performs the following tasks:
2022-09-08 11:51:17 +00:00
a) Create draft GitHub release with the name `TAG` . This step can be run manually
2022-08-30 23:27:24 +00:00
with the command `TAG=v1.xx.y make github-create-release` .
The release id is stored at `/tmp/vm-github-release` file.
2022-09-08 11:51:17 +00:00
b) Upload all the binaries and checksums created at step `3a` to that release.
2022-08-30 23:27:24 +00:00
This step can be run manually with the command `make github-upload-assets` .
It is expected that the needed release id is stored at `/tmp/vm-github-release` file,
2022-09-08 11:51:17 +00:00
which must be created at the step `a` .
2022-08-30 23:27:24 +00:00
If the upload process is interrupted by any reason, then the following recovery steps must be performed:
- To delete the created draft release by running the command `make github-delete-release` .
This command expects that the id of the release to delete is located at `/tmp/vm-github-release`
2022-09-08 11:51:17 +00:00
file created at the step `a` .
2022-08-30 23:27:24 +00:00
- To run the command `TAG=v1.xx.y make github-create-release github-upload-assets` , so new release is created
and all the needed assets are re-uploaded to it.
2023-07-26 21:08:19 +00:00
1. Go to < https: // github . com / VictoriaMetrics / VictoriaMetrics / releases > and verify that draft release with the name `TAG` has been created
2022-08-30 23:27:24 +00:00
and this release contains all the needed binaries and checksums.
2023-07-26 21:08:19 +00:00
1. Update the release description with the content of [CHANGELOG ](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md ) for this release.
1. Publish release by pressing "Publish release" green button in GitHub's UI.
1. Bump version of the VictoriaMetrics cluster in the [sandbox environment ](https://github.com/VictoriaMetrics/ops/blob/main/gcp-test/sandbox/manifests/benchmark-vm/vmcluster.yaml )
2022-08-30 23:27:24 +00:00
by [opening and merging PR ](https://github.com/VictoriaMetrics/ops/pull/58 ).
2023-07-26 21:08:19 +00:00
1. Bump VictoriaMetrics version at `deployment/docker/docker-compose.yml` and at `deployment/docker/docker-compose-cluster.yml` .
2019-11-30 18:36:10 +00:00
2022-03-22 11:40:55 +00:00
## Building snap package
2020-12-29 09:43:09 +00:00
2022-03-22 11:40:55 +00:00
pre-requirements:
* snapcraft binary, can be installed with commands:
2023-05-10 07:50:41 +00:00
for MacOS `brew install snapcraft` and [install multipass ](https://discourse.ubuntu.com/t/installing-multipass-on-macos/8329 ),
2020-12-29 09:43:09 +00:00
for Ubuntu - `sudo snap install snapcraft --classic`
2022-03-22 11:40:55 +00:00
* exported snapcraft login to `~/.snap/login.json` with `snapcraft export-login login.json && mkdir -p ~/.snap && mv login.json ~/.snap/`
* already created release at github (it operates `git describe` version, so git tag must be annotated).
2020-12-29 09:43:09 +00:00
2022-04-04 09:14:27 +00:00
1. checkout to the latest git tag for single-node version.
2023-07-26 21:08:19 +00:00
1. execute `make release-snap` - it must build and upload snap package.
1. promote release to current, if needed manually at release page [snapcraft-releases ](https://snapcraft.io/victoriametrics/releases )
2020-12-29 09:43:09 +00:00
2022-03-22 11:40:55 +00:00
### Public Announcement
2020-12-19 19:58:03 +00:00
2022-03-22 11:40:55 +00:00
* Publish message in Slack at < https: // victoriametrics . slack . com >
* Post at Twitter at < https: // twitter . com / MetricsVictoria >
* Post in Reddit at < https: // www . reddit . com / r / VictoriaMetrics />
2023-05-10 07:50:41 +00:00
* Post in LinkedIn at < https: // www . linkedin . com / company / victoriametrics />
2022-03-22 11:40:55 +00:00
* Publish message in Telegram at < https: // t . me / VictoriaMetrics_en > and < https: // t . me / VictoriaMetrics_ru1 >
2023-05-10 07:50:41 +00:00
* Publish message in Google Groups at < https: // groups . google . com / forum /#! forum / victorametrics-users >
2019-11-30 18:36:10 +00:00
## Helm Charts
The helm chart repository [https://github.com/VictoriaMetrics/helm-charts/ ](https://github.com/VictoriaMetrics/helm-charts/ )
2022-03-22 11:40:55 +00:00
### Bump the version of images
2019-11-30 18:36:10 +00:00
2023-06-13 08:37:51 +00:00
Bump `tag` field in `values.yaml` with new release version.
Bump `appVersion` field in `Chart.yaml` with new release version.
Bump `version` field in `Chart.yaml` with incremental semver version.
Do these updates to the following charts:
2022-04-04 09:14:27 +00:00
1. Update `vmagent` chart version in [`values.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-agent/values.yaml ) and [`Chart.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-agent/Chart.yaml )
2023-07-26 21:08:19 +00:00
1. Update `vmalert` chart version in [`values.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-alert/values.yaml ) and [`Chart.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-alert/Chart.yaml )
1. Update `vmauth` chart version in [`values.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-auth/values.yaml ) and [`Chart.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-auth/Chart.yaml )
1. Update `cluster` chart versions in [`values.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/values.yaml ), bump version for `vmselect` , `vminsert` and `vmstorage` and [`Chart.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/Chart.yaml )
1. Update `k8s-stack` chart versions in [`values.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-k8s-stack/values.yaml ), bump version for `vmselect` , `vminsert` , `vmstorage` , `vmsingle` , `vmalert` , `vmagent` and [`Chart.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-k8s-stack/Chart.yaml )
1. Update `single-node` chart version in [`values.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-single/values.yaml ) and [`Chart.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-single/Chart.yaml )
1. Update `vmgateway` chart version in [`values.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-gateway/values.yamll ) and [`Chart.yaml` ](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-gateway/Chart.yaml )
2023-06-13 08:37:51 +00:00
Once updated, run the following commands:
1. Run `make gen-docs`
2023-07-26 21:08:19 +00:00
1. Run `make package` that creates or updates zip file with the packed chart
1. Run `make merge` . It creates or updates metadata for charts in index.yaml
1. Push changes to master. `master` is a source of truth
1. Push the same changes to `gh-pages` branch
2019-11-30 18:36:10 +00:00
2022-04-04 09:14:27 +00:00
## Ansible Roles
2022-03-22 11:40:55 +00:00
2022-04-04 09:14:27 +00:00
### Bump the version of images
2019-11-30 19:08:48 +00:00
2022-04-04 09:14:27 +00:00
Repository [https://github.com/VictoriaMetrics/ansible-playbooks ](https://github.com/VictoriaMetrics/ansible-playbooks )
2019-11-30 19:08:48 +00:00
2022-04-04 09:14:27 +00:00
1. Update `vmagent` version in [`main.yml` ](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/vmagent/defaults/main.yml#L4 )
2023-07-26 21:08:19 +00:00
1. Update `vmalert` version in [`main.yml` ](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/vmalert/defaults/main.yml#L4 )
1. Update `cluster` version in [`main.yml` ](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/cluster/defaults/main.yml#L3 )
1. Update `single` version in [`main.yml` ](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/single/defaults/main.yml#L6 )
1. Commit changes
1. Create a new tag
1. Create a new release. This automatically publishes the new versions to galaxy.ansible.com
2023-01-04 13:36:14 +00:00
## RPM packages
2023-06-13 08:37:51 +00:00
### Bump the version of components (for LTS releases only)
2023-01-04 13:36:14 +00:00
2023-01-10 09:14:56 +00:00
Repository [https://github.com/VictoriaMetrics/victoriametrics-lts-rpm ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm )
2023-01-04 13:36:14 +00:00
1. Update `vmagent` version in [`vmagent.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmagent.spec#L2 )
2023-07-26 21:08:19 +00:00
1. Update `vmalert` version in [`vmalert.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmalert.spec#L2 )
1. Update `vmauth` version in [`vmauth.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmauth.spec#L2 )
1. Update `vmbackup` version in [`vmbackup.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmbackup.spec#L2 )
1. Update `vmctl` version in [`vmctl.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmctl.spec#L2 )
1. Update `vmrestore` version in [`vmrestore.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmrestore.spec#L2 )
1. Update `vminsert` version in [`vminsert.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vminsert.spec#L2 )
1. Update `vmselect` version in [`vmselect.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmselect.spec#L2 )
1. Update `vmstorage` version in [`vmstorage.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmstorage.spec#L2 )
1. Update `vmsingle` version in [`vmsingle.spec` ](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmsingle.spec#L2 )
1. Commit and push changes to the repository. This will automatically build and publish new versions of RPM packages.