From 65c742d976b274c0a685d35c4b00089a496294d6 Mon Sep 17 00:00:00 2001 From: Andrii Chubatiuk Date: Mon, 1 Jul 2024 15:51:32 +0200 Subject: [PATCH] deployment: remove snap packages support (#6543) ### Describe Your Changes Removed snap packages support as it requires time for maintenance and it's not popular at all ### Checklist The following checks are **mandatory**: - [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). --------- Signed-off-by: hagen1778 Co-authored-by: hagen1778 (cherry picked from commit 0a42c8fd8b34e074465d02559e621ecd296f6d6d) Signed-off-by: hagen1778 --- docs/CHANGELOG.md | 2 ++ docs/Quick-Start.md | 1 - docs/README.md | 25 +++---------------------- docs/Release-Guide.md | 14 -------------- docs/Single-server-VictoriaMetrics.md | 25 +++---------------------- 5 files changed, 8 insertions(+), 59 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 8d06166b62..a78841eaa3 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -29,6 +29,8 @@ See also [LTS releases](https://docs.victoriametrics.com/lts-releases/). ## tip +**Update note 1: support for snap packages was removed due to lack of interest from community. See this [pull request](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6543) for details. Please read about supported package types [here](https://docs.victoriametrics.com/#install).** + * FEATURE: [vmauth](https://docs.victoriametrics.com/vmauth/): allow overriding `Host` header with a target host before sending to a downstream. See this [issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6453) * FEATURE: [dashboards](https://grafana.com/orgs/victoriametrics): add [Grafana dashboard](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/dashboards/vmauth.json) and [alerting rules](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/alerts-vmauth.yml) for [vmauth](https://docs.victoriametrics.com/vmauth/) dashboard. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4313) for details. * FEATURE: [vmagent](https://docs.victoriametrics.com/vmagent/): added `yandexcloud_sd` AWS API IMDSv2 support. diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md index f2c64174e6..f9ea00dd0b 100644 --- a/docs/Quick-Start.md +++ b/docs/Quick-Start.md @@ -25,7 +25,6 @@ Single-server-VictoriaMetrics VictoriaMetrics is available as: * [Managed VictoriaMetrics at AWS](https://aws.amazon.com/marketplace/pp/prodview-4tbfq5icmbmyc) * [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) -* [Snap packages](https://snapcraft.io/victoriametrics) * [Helm Charts](https://github.com/VictoriaMetrics/helm-charts#list-of-charts) * [Binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) * [Source code](https://github.com/VictoriaMetrics/VictoriaMetrics). diff --git a/docs/README.md b/docs/README.md index 750465f837..ac8bec4d07 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,8 +18,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t See [case studies for VictoriaMetrics](https://docs.victoriametrics.com/casestudies/). VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), -[Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) -and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). +[Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Documentation for the cluster version of VictoriaMetrics is available [here](https://docs.victoriametrics.com/cluster-victoriametrics/). @@ -142,7 +141,6 @@ VictoriaMetrics can also be installed via these installation methods: * [Ansible role for installing cluster VictoriaMetrics (by VictoriaMetrics)](https://github.com/VictoriaMetrics/ansible-playbooks). * [Ansible role for installing cluster VictoriaMetrics (by community)](https://github.com/Slapper/ansible-victoriametrics-cluster-role). * [Ansible role for installing single-node VictoriaMetrics (by community)](https://github.com/dreamteam-gg/ansible-victoriametrics-role). -* [Snap package for VictoriaMetrics](https://snapcraft.io/victoriametrics). ### How to start VictoriaMetrics @@ -185,24 +183,7 @@ Additionally, all the VictoriaMetrics components allow setting flag values via e ### Configuration with snap package -Snap package for VictoriaMetrics is available [here](https://snapcraft.io/victoriametrics). - -Command-line flags for Snap package can be set with following command: - -```sh -echo 'FLAGS="-selfScrapeInterval=10s -search.logSlowQueryDuration=20s"' > $SNAP_DATA/var/snap/victoriametrics/current/extra_flags -snap restart victoriametrics -``` - -Do not change value for `-storageDataPath` flag, because snap package has limited access to host filesystem. - -Changing scrape configuration is possible with text editor: - -```sh -vi $SNAP_DATA/var/snap/victoriametrics/current/etc/victoriametrics-scrape-config.yaml -``` - -After changes were made, trigger config re-read with the command `curl 127.0.0.1:8428/-/reload`. +Snap packages for VictoriaMetrics are supported by community and are available at [https://snapcraft.io/victoriametrics](https://snapcraft.io/victoriametrics). ### Running as Windows service @@ -1208,7 +1189,7 @@ More details may be found [here](https://github.com/VictoriaMetrics/VictoriaMetr ## Setting up service Read [instructions](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/43) on how to set up VictoriaMetrics -as a service for your OS. A [snap package](https://snapcraft.io/victoriametrics) is available for Ubuntu. +as a service for your OS. ## How to work with snapshots diff --git a/docs/Release-Guide.md b/docs/Release-Guide.md index 0a4fe5f661..f201a1a27e 100644 --- a/docs/Release-Guide.md +++ b/docs/Release-Guide.md @@ -99,20 +99,6 @@ Bumping the limits may significantly improve build speed. 1. Bump VictoriaMetrics version at `deployment/docker/docker-compose.yml` and at `deployment/docker/docker-compose-cluster.yml`. 1. Follow the instructions in [release follow-up](https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/blob/master/Release-Guide.md). -## Building snap package - - pre-requirements: - -* snapcraft binary, can be installed with commands: - for MacOS `brew install snapcraft` and [install multipass](https://discourse.ubuntu.com/t/installing-multipass-on-macos/8329), - for Ubuntu - `sudo snap install snapcraft --classic` -* 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). - -1. checkout to the latest git tag for single-node version. -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) - ### Public Announcement * Publish message in Slack at diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 034486ab21..97b8108a18 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -26,8 +26,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t See [case studies for VictoriaMetrics](https://docs.victoriametrics.com/casestudies/). VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), -[Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) -and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). +[Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Documentation for the cluster version of VictoriaMetrics is available [here](https://docs.victoriametrics.com/cluster-victoriametrics/). @@ -150,7 +149,6 @@ VictoriaMetrics can also be installed via these installation methods: * [Ansible role for installing cluster VictoriaMetrics (by VictoriaMetrics)](https://github.com/VictoriaMetrics/ansible-playbooks). * [Ansible role for installing cluster VictoriaMetrics (by community)](https://github.com/Slapper/ansible-victoriametrics-cluster-role). * [Ansible role for installing single-node VictoriaMetrics (by community)](https://github.com/dreamteam-gg/ansible-victoriametrics-role). -* [Snap package for VictoriaMetrics](https://snapcraft.io/victoriametrics). ### How to start VictoriaMetrics @@ -193,24 +191,7 @@ Additionally, all the VictoriaMetrics components allow setting flag values via e ### Configuration with snap package -Snap package for VictoriaMetrics is available [here](https://snapcraft.io/victoriametrics). - -Command-line flags for Snap package can be set with following command: - -```sh -echo 'FLAGS="-selfScrapeInterval=10s -search.logSlowQueryDuration=20s"' > $SNAP_DATA/var/snap/victoriametrics/current/extra_flags -snap restart victoriametrics -``` - -Do not change value for `-storageDataPath` flag, because snap package has limited access to host filesystem. - -Changing scrape configuration is possible with text editor: - -```sh -vi $SNAP_DATA/var/snap/victoriametrics/current/etc/victoriametrics-scrape-config.yaml -``` - -After changes were made, trigger config re-read with the command `curl 127.0.0.1:8428/-/reload`. +Snap packages for VictoriaMetrics are supported by community and are available at [https://snapcraft.io/victoriametrics](https://snapcraft.io/victoriametrics). ### Running as Windows service @@ -1216,7 +1197,7 @@ More details may be found [here](https://github.com/VictoriaMetrics/VictoriaMetr ## Setting up service Read [instructions](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/43) on how to set up VictoriaMetrics -as a service for your OS. A [snap package](https://snapcraft.io/victoriametrics) is available for Ubuntu. +as a service for your OS. ## How to work with snapshots