c0627d8a16
docs: What's New & Upgrade Guide 10.0 (#64927)
* updated what's new index and added v10.0 what's new and upgrade guide
* Update _index.md
* Added nested folders
* Nested folders screenshot
* Add draft of Correlations what's new content
* Correlations minor edit
* add dashboards whats new
* What's new: Query multiple data sources in Explore
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
* AuthNZ: What's new in Grafana 10.0 (#66362)
* AuthNZ: What's new in Grafana 10.0
* Add upgrade guides
* Apply suggestions from code review
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
* Apply suggestions from code review
Co-authored-by: Jo <joao.guerreiro@grafana.com>
* Apply suggestions from code review
Co-authored-by: Jo <joao.guerreiro@grafana.com>
---------
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
Co-authored-by: Jo <joao.guerreiro@grafana.com>
* Added span filters section
* add info about dashboard previews removal
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: Ivan Ortega Alba <ivanortegaalba@gmail.com>
* add datagrid and drag and drop
* combine new ds picker and panel onboarding content
* Logs: Add LogContext to What's New v10 (#66575)
* add log context description
* change `eyeball button` to `eye icon`
* Adds Alerting entries for 10
* Add Azure Monitor entry for v10
* add public dashboards features
* small tweaks to public dashboards content
* Add Security: Trusted types section
* Add DataViz: initial placeholder sections with some content
* Adds alerting entry for templates
* Adds an and
* update headings
* fix link format and update wording
* nesting topics under dashboards and visualizations, updated headers
* Adds oncall contact point entry
* Copyedits for oncall alerting entry
* add incremental querying blurb to whats-new
* Renaming nested folders to subfolders
* Update what's new to indicate availability of features and improve messaging (#66755)
* Added image for time regions
* update wording for feature release stage
* Add section about Phlare data source rename
* restructuring and styling fixes
* add datasource picker recording
* Log Context: Improved "Whats New" text (#67285)
* improve "Log context" whats new
* change screenshot
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: Matias Chomicki <matyax@gmail.com>
* fix spelling
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: J Stickler <julie.stickler@grafana.com>
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: J Stickler <julie.stickler@grafana.com>
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: J Stickler <julie.stickler@grafana.com>
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: J Stickler <julie.stickler@grafana.com>
* change image
---------
Co-authored-by: Matias Chomicki <matyax@gmail.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
* wording and style edits
* Update how to use Trusted Types
* Adding opentracing deprecation notes
* Adding opentracing deprecation notes
* added breaking changes with raw markdown
* updated page weight
* state location of public dashboards list more explicitly
* added email sharing user admin info
* clarified what was fixed
* Deletes oncall entry
* added heading markdown
* replaced absolute links with relrefs
* fixed relrefs
* Update canvas GA section to include connection properties
* canvas: slight grammar update
* updated template and name of contributor field for each item
* adding contributor name
* added contributor names to what's new
* added contributor names to what's new and upgrade guide
* fixed typo
* Docs: What is new 10 - add Data plane (#68125)
* Remove drag & drop to dashboard
* Add PDC to 10.0 what's new
* reorder sections, edit copy
* update order, format and copy
* grammar fix
add "and"
* add intro text to breaking changes pages
* fix Explore mixed DS what's new doc (#68303)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Remove datagrid from what's new, drag and drop to experimental
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
* updates to data source picker availability
* Update what's new for canvas / trend panel (finalized)
* Update ds picker recording
* Add deprecation notice for changing folder UID
* docs: update with angular plugin list
* Update with documentations links for annotation filtering and time regions
* Update annotation filtering section in docs/sources/whatsnew/whats-new-in-v10-0.md
* add datagrid as experimental
* modify datagrid doc accordingly
* Update docs/sources/whatsnew/whats-new-in-v10-0.md
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* adds alerting screenshot
* deletes sentence
* adds state history pic
* resolving outstanding suggestions
Co-authored-by: David Harris <david.harris@grafana.com>
Co-authored-by: Nathan Marrs <nathanielmarrs@gmail.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
* changed order of sections
* updated text about breaking changes in whats new and upgrade guide
* fixed links
* copy edits
* general copy edits
* removed TO DOs from whats new, copy edited upgrade guide, some copy edits of breaking changes
* fix doc validator errors
* added availability information, updated preview notes, replaced screenshot
* copy edit, added links, added breaking changes content
* general copy edit of breaking changes; small update to common tasks
* replaced notes with admonitions
* link fixes
* reverted blog links to full addresses
* fixed heading inconsisency
* fix doc validator error
* added availability note
* added missing availability notes
* replaced screenshot and fixed wording
* replaced screenshot and fixed wording
* Updated subfolders description
To call out missing features and stress that it can only be used in dev/test environments
* added availability note
---------
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Zsofia <zsofia.komaromi@gmail.com>
Co-authored-by: Josiah (Jay) Goodson <josiah.goodson@gmail.com>
Co-authored-by: natellium <natalia.bernarte@grafana.com>
Co-authored-by: Piotr Jamróz <pm.jamroz@gmail.com>
Co-authored-by: Natalia Bernarte Oses <74534993+natellium@users.noreply.github.com>
Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>
Co-authored-by: Vardan Torosyan <vardants@gmail.com>
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
Co-authored-by: Jo <joao.guerreiro@grafana.com>
Co-authored-by: Joey Tawadrous <joey.tawadrous@grafana.com>
Co-authored-by: Artur Wierzbicki <artur.wierzbicki@grafana.com>
Co-authored-by: Ivan Ortega Alba <ivanortegaalba@gmail.com>
Co-authored-by: Oscar Kilhed <oscar.kilhed@grafana.com>
Co-authored-by: Sven Grossmann <sven.grossmann@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Andreas Christou <andreas.christou@grafana.com>
Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>
Co-authored-by: nmarrs <nathanielmarrs@gmail.com>
Co-authored-by: Galen <galen.kistler@grafana.com>
Co-authored-by: Adela Almasan <adela.almasan@grafana.com>
Co-authored-by: Andrej Ocenas <mr.ocenas@gmail.com>
Co-authored-by: Matias Chomicki <matyax@gmail.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
Co-authored-by: Kyle Brandt <kyle@grafana.com>
Co-authored-by: Mitchel Seaman <mitchel.seaman@gmail.com>
Co-authored-by: Giordano Ricci <me@giordanoricci.com>
Co-authored-by: Ezequiel Victorero <ezequiel.victorero@grafana.com>
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
Co-authored-by: David Harris <david.harris@grafana.com>
Co-authored-by: Victor Marin <victor.marin@grafana.com>
Co-authored-by: Joey <90795735+joey-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
(cherry picked from commit d4ef06451c)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
194 lines
7.2 KiB
Markdown
194 lines
7.2 KiB
Markdown
---
|
|
title: Upgrade guide common tasks
|
|
---
|
|
|
|
We recommend that you upgrade Grafana often to stay current with the latest fixes and enhancements.
|
|
Because Grafana upgrades are backward compatible, the upgrade process is straightforward, and dashboards and graphs will not change.
|
|
|
|
In addition to common tasks you should complete for all versions of Grafana, there might be additional upgrade tasks to complete for a version.
|
|
|
|
{{% admonition type="note" %}}
|
|
There might be breaking changes in some releases. We outline these changes in the [What's New ]({{< relref "../../whatsnew/" >}}) document for most releases or a separate [Breaking changes]({{< relref "../../breaking-changes/" >}}) document for releases with many breaking changes.
|
|
{{% /admonition %}}
|
|
|
|
For versions of Grafana prior to v9.2, we published additional information in the [Release Notes]({{< relref "../../release-notes/" >}}).
|
|
|
|
When available, we list all changes with links to pull requests or issues in the [Changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md).
|
|
|
|
{{% admonition type="note" %}}
|
|
When possible, we recommend that you test the Grafana upgrade process in a test or development environment.
|
|
{{% /admonition %}}
|
|
|
|
## Back up the Grafana database
|
|
|
|
Although Grafana automatically upgrades the database on startup, we recommend that you back up your Grafana database so that you can roll back to a previous version, if required.
|
|
|
|
### SQLite
|
|
|
|
If you use SQLite, you only need to back up the `grafana.db` file. On Unix systems, the database file is usually located in `/var/lib/grafana/`.
|
|
|
|
If you are unsure which database you use and where it is stored, check the Grafana configuration file. If you
|
|
installed Grafana to a custom location using a binary tar/zip, the database is usually located in `<grafana_install_dir>/data`.
|
|
|
|
### MySQL
|
|
|
|
To back up or restore a MySQL Grafana database, run the following commands:
|
|
|
|
```bash
|
|
backup:
|
|
> mysqldump -u root -p[root_password] [grafana] > grafana_backup.sql
|
|
|
|
restore:
|
|
> mysql -u root -p grafana < grafana_backup.sql
|
|
```
|
|
|
|
### Postgres
|
|
|
|
To back up or restore a Postgres Grafana database, run the following commands:
|
|
|
|
```bash
|
|
backup:
|
|
> pg_dump grafana > grafana_backup
|
|
|
|
restore:
|
|
> psql grafana < grafana_backup
|
|
```
|
|
|
|
## Backup plugins
|
|
|
|
We recommend that you back up installed plugins before you upgrade Grafana so that you can roll back to a previous version of Grafana, if necessary.
|
|
|
|
## Upgrade Grafana
|
|
|
|
The following sections provide instructions for how to upgrade Grafana based on your installation method.
|
|
|
|
### Debian
|
|
|
|
To upgrade Grafana installed from a Debian package (`.deb`), complete the following steps:
|
|
|
|
1. In your current installation of Grafana, save your custom configuration changes to a file named `<grafana_install_dir>/conf/custom.ini`.
|
|
|
|
This enables you to upgrade Grafana without the risk of losing your configuration changes.
|
|
|
|
1. [Download](https://grafana.com/grafana/download?platform=linux) the latest version of Grafana.
|
|
|
|
1. Run the following `dpkg -i` command.
|
|
|
|
```bash
|
|
wget <debian package url>
|
|
sudo apt-get install -y adduser
|
|
sudo dpkg -i grafana_<version>_amd64.deb
|
|
```
|
|
|
|
### APT repository
|
|
|
|
To upgrade Grafana installed from the Grafana Labs APT repository, complete the following steps:
|
|
|
|
1. In your current installation of Grafana, save your custom configuration changes to a file named `<grafana_install_dir>/conf/custom.ini`.
|
|
|
|
This enables you to upgrade Grafana without the risk of losing your configuration changes.
|
|
|
|
1. Run the following commands:
|
|
|
|
```bash
|
|
sudo apt-get update
|
|
sudo apt-get upgrade
|
|
```
|
|
|
|
Grafana automatically updates when you run `apt-get upgrade`.
|
|
|
|
### Binary .tar file
|
|
|
|
To upgrade Grafana installed from the binary `.tar.gz` package, complete the following steps:
|
|
|
|
1. In your current installation of Grafana, save your custom configuration changes to a file named `<grafana_install_dir>/conf/custom.ini`.
|
|
|
|
This enables you to upgrade Grafana without the risk of losing your configuration changes.
|
|
|
|
1. [Download](https://grafana.com/grafana/download) the binary `.tar.gz` package.
|
|
|
|
1. Extract the downloaded package and overwrite the existing files.
|
|
|
|
### RPM or YUM
|
|
|
|
To upgrade Grafana installed using RPM or YUM complete the following steps:
|
|
|
|
1. In your current installation of Grafana, save your custom configuration changes to a file named `<grafana_install_dir>/conf/custom.ini`.
|
|
|
|
This enables you to upgrade Grafana without the risk of losing your configuration changes.
|
|
|
|
1. Perform one of the following steps based on your installation.
|
|
|
|
- If you [downloaded an RPM package](https://grafana.com/grafana/download) to install Grafana, then complete the steps documented in [Install Grafana on Red Hat, RHEL, or Fedora]({{< relref "../../setup-grafana/installation/redhat-rhel-fedora/" >}}) or [Install Grafana on SUSE or openSUSE]({{< relref "../../setup-grafana/installation/suse-opensuse/" >}}) to upgrade Grafana.
|
|
- If you used the Grafana YUM repository, run the following command:
|
|
|
|
```bash
|
|
sudo yum update grafana
|
|
```
|
|
|
|
- If you installed Grafana on openSUSE or SUSE, run the following command:
|
|
|
|
```bash
|
|
sudo zypper update
|
|
```
|
|
|
|
### Docker
|
|
|
|
To upgrade Grafana running in a Docker container, complete the following steps:
|
|
|
|
1. In your current installation of Grafana, save your custom configuration changes to a file named `<grafana_install_dir>/conf/custom.ini`.
|
|
|
|
This enables you to upgrade Grafana without the risk of losing your configuration changes.
|
|
|
|
1. Run a commands similar to the following commands.
|
|
|
|
{{% admonition type="note" %}}
|
|
This is an example. The parameters you enter depend on how you configured your Grafana container.
|
|
{{% /admonition %}}
|
|
|
|
```bash
|
|
docker pull grafana/grafana
|
|
docker stop my-grafana-container
|
|
docker rm my-grafana-container
|
|
docker run -d --name=my-grafana-container --restart=always -v /var/lib/grafana:/var/lib/grafana grafana/grafana
|
|
```
|
|
|
|
### Windows
|
|
|
|
To upgrade Grafana installed on Windows, complete the following steps:
|
|
|
|
1. In your current installation of Grafana, save your custom configuration changes to a file named `<grafana_install_dir>/conf/custom.ini`.
|
|
|
|
This enables you to upgrade Grafana without the risk of losing your configuration changes.
|
|
|
|
1. [Download](https://grafana.com/grafana/download) the Windows binary package.
|
|
|
|
1. Extract the contents of the package to the location in which you installed Grafana.
|
|
|
|
You can overwrite existing files and folders, when prompted.
|
|
|
|
### Mac
|
|
|
|
To upgrade Grafana installed on Mac, complete the following steps:
|
|
|
|
1. In your current installation of Grafana, save your custom configuration changes to a file named `<grafana_install_dir>/conf/custom.ini`.
|
|
|
|
This enables you to upgrade Grafana without the risk of losing your configuration changes.
|
|
|
|
1. [Download](https://grafana.com/grafana/download) the Mac binary package.
|
|
|
|
1. Extract the contents of the package to the location in which you installed Grafana.
|
|
|
|
You can overwrite existing files and folders, when prompted.
|
|
|
|
## Update Grafana plugins
|
|
|
|
After you upgrade Grafana, we recommend that you update all plugins because a new version of Grafana
|
|
can make older plugins stop working properly.
|
|
|
|
Run the following command to update plugins:
|
|
|
|
```bash
|
|
grafana cli plugins update-all
|
|
```
|