From 59526fa6f514f073756bb4cc0d9b302f76656d23 Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Thu, 11 May 2023 21:27:30 +0100 Subject: [PATCH] [v9.3.x] Docs: Correct capitalization of openSUSE (#68334) Docs: Correct capitalization of openSUSE (#67567) Correct capitalization of openSUSE (cherry picked from commit 7e0031ec36ac0feb408efb83f14c28afc984d6c5) Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> --- .../setup-grafana/installation/_index.md | 37 ++-- .../installation/suse-opensuse/index.md | 84 ++++++++ .../setup-grafana/start-restart-grafana.md | 2 +- .../shared/upgrade/upgrade-common-tasks.md | 187 ++++++++++++++++++ 4 files changed, 292 insertions(+), 18 deletions(-) create mode 100644 docs/sources/setup-grafana/installation/suse-opensuse/index.md create mode 100644 docs/sources/shared/upgrade/upgrade-common-tasks.md diff --git a/docs/sources/setup-grafana/installation/_index.md b/docs/sources/setup-grafana/installation/_index.md index 4c5b4f476f6..f44b447e7cd 100644 --- a/docs/sources/setup-grafana/installation/_index.md +++ b/docs/sources/setup-grafana/installation/_index.md @@ -5,6 +5,7 @@ aliases: - ../installation/installation/ - ../installation/requirements/ - /docs/grafana/v2.1/installation/install/ + - ./installation/rpm/ description: Installation guide for Grafana title: Install Grafana weight: 100 @@ -16,27 +17,28 @@ This page lists the minimum hardware and software requirements to install Grafan To run Grafana, you must have a supported operating system, hardware that meets or exceeds minimum requirements, a supported database, and a supported browser. -Grafana uses other open source software. Refer to [package.json](https://github.com/grafana/grafana/blob/main/package.json) for a complete list. +Grafana relies on other open source software to operate. For a list of open source software that Grafana uses, refer to [package.json](https://github.com/grafana/grafana/blob/main/package.json). ## Supported operating systems -The following operating systems are supported for Grafana installation: +Grafana supports the following operating systems: -- [Debian / Ubuntu]({{< relref "debian/" >}}) -- [RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)]({{< relref "rpm/" >}}) +- [Debian/Ubuntu]({{< relref "debian/" >}}) +- [Red Hat/RHEL/Fedora]({{< relref "redhat-rhel-fedora/" >}}) +- [SUSE/openSUSE]({{< relref "suse-opensuse/" >}}) - [macOS]({{< relref "mac/" >}}) - [Windows]({{< relref "windows/" >}}) -Installation of Grafana on other operating systems is possible, but it is neither recommended nor supported. +> **Note:** Installation of Grafana on other operating systems is possible, but is not recommended or supported. ## Hardware recommendations -Grafana does not use a lot of resources and is very lightweight in use of memory and CPU. +Grafana requires the minimum system resources: -Minimum recommended memory: 255 MB -Minimum recommended CPU: 1 +- Minimum recommended memory: 255 MB +- Minimum recommended CPU: 1 -Some features might require more memory or CPUs. Features require more resources include: +Some features might require more memory or CPUs, including: - [Server side rendering of images](https://grafana.com/grafana/plugins/grafana-image-renderer#requirements) - [Alerting]({{< relref "../../alerting/" >}}) @@ -44,7 +46,7 @@ Some features might require more memory or CPUs. Features require more resources ## Supported databases -Grafana requires a database to store its configuration data, such as users, data sources, and dashboards. The exact requirements depend on the size of the Grafana installation and features used. +Grafana requires a database to store its configuration data, such as users, data sources, and dashboards. The exact requirements depend on the size of the Grafana installation and the features you use. Grafana supports the following databases: @@ -52,22 +54,23 @@ Grafana supports the following databases: - [MySQL 5.7+](https://www.mysql.com/support/supportedplatforms/database.html) - [PostgreSQL 10+](https://www.postgresql.org/support/versioning/) -By default, Grafana installs with and uses SQLite, which is an embedded database stored in the Grafana installation location. +By default Grafana uses an embedded SQLite database, which is stored in the Grafana installation location. -Grafana will support the versions of these databases that are officially supported by the project at the time of a Grafana version's release. When a version becomes unsupported, Grafana may also drop support for that version. See the links above for the support policies for each project. +> **Note:** SQLite works well if your environment is small, but is not recommended when your environment starts growing. For more information about the limitations of SQLite, refer to [Appropriate Uses For SQLite](https://www.sqlite.org/whentouse.html). If you want high availability, you must use a MySQL or PostgreSQL database. For information about how to define the database configuration parameters inside the `grafana.ini` file, refer to [[database]](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#database). + +Grafana supports the versions of these databases that are officially supported by the project at the time a version of Grafana is released. When a Grafana version becomes unsupported, Grafana Labs might also drop support for that database version. See the links above for the support policies for each project. > **Note:** PostgreSQL versions 10.9, 11.4, and 12-beta2 are affected by a bug (tracked by the PostgreSQL project as [bug #15865](https://www.postgresql.org/message-id/flat/15865-17940eacc8f8b081%40postgresql.org)) which prevents those versions from being used with Grafana. The bug has been fixed in more recent versions of PostgreSQL. + > Grafana can report errors when relying on read-only MySQL servers, such as in high-availability failover scenarios or serverless AWS Aurora MySQL. This is a known issue; for more information, see [issue #13399](https://github.com/grafana/grafana/issues/13399). -> AWS Aurora MySQL is not compatible with Grafana Alerting, see [issue #54556](https://github.com/grafana/grafana/issues/54556). ## Supported web browsers -Grafana is supported in the current version of the following browsers. Older versions of these browsers might not be supported, so you should always upgrade to the latest version when using Grafana. +Grafana supports the current version of the following browsers. Older versions of these browsers might not be supported, so you should always upgrade to the latest browser version when using Grafana. + +> **Note:** Enable JavaScript in your browser. Running Grafana without JavaScript enabled in the browser is not supported. - Chrome/Chromium - Firefox - Safari - Microsoft Edge -- Internet Explorer 11 is only fully supported in Grafana versions prior v6.0. - -> **Note:** Always enable JavaScript in your browser. Running Grafana without JavaScript enabled in the browser is not supported. diff --git a/docs/sources/setup-grafana/installation/suse-opensuse/index.md b/docs/sources/setup-grafana/installation/suse-opensuse/index.md new file mode 100644 index 00000000000..6b0905f75d5 --- /dev/null +++ b/docs/sources/setup-grafana/installation/suse-opensuse/index.md @@ -0,0 +1,84 @@ +--- +description: Install guide for Grafana on SUSE or openSUSE. +title: Install Grafana on SUSE or openSUSE +menuTitle: SUSE or openSUSE +weight: 450 +--- + +# Install Grafana on SUSE or openSUSE + +This topic explains how to install Grafana dependencies, install Grafana on SUSE or openSUSE and start the Grafana server on your system. + +You can install Grafana using a YUM repository, using RPM, or by downloading a binary `.tar.gz` file. + +If you install via RPM or the `.tar.gz` file, then you must manually update Grafana for each new version. + +## Install Grafana from the YUM repository + +If you install from the YUM repository, then Grafana is automatically updated every time you run `sudo zypper update`. + +| Grafana Version | Package | Repository | +| ------------------ | ------------------ | ------------------------- | +| Grafana Enterprise | grafana-enterprise | `https://rpm.grafana.com` | +| Grafana OSS | grafana | `https://rpm.grafana.com` | + +> **Note:** Grafana Enterprise is the recommended and default edition. It is available for free and includes all the features of the OSS edition. You can also upgrade to the [full Enterprise feature set](https://grafana.com/products/enterprise/?utm_source=grafana-install-page), which has support for [Enterprise plugins](https://grafana.com/grafana/plugins/?enterprise=1&utcm_source=grafana-install-page). + +To install Grafana using a YUM repository, complete the following steps: + +1. Use zypper to add the grafana repo. + + ```bash + sudo zypper addrepo https://rpm.grafana.com grafana + ``` + +1. To install Grafana OSS, run the following command: + + ```bash + sudo zypper install grafana + ``` + +1. To install Grafana Enterprise, run the following command: + + ```bash + sudo zypper install grafana-enterprise + ``` + +## Install the Grafana RPM package manually + +If you install Grafana manually using YUM or RPM, then you must manually update Grafana for each new version. This method varies according to which Linux OS you are running. + +**Note:** The RPM files are signed. You can verify the signature with this [public GPG key](https://rpm.grafana.com/gpg.key). + +1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install. + - The most recent Grafana version is selected by default. + - The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version. +1. Select an **Edition**. + - **Enterprise** - Recommended download. Functionally identical to the open source version, but includes features you can unlock with a license if you so choose. + - **Open Source** - Functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features. +1. Depending on which system you are running, click **Linux** or **ARM**. +1. Copy and paste the RPM package URL and the local RPM package information from the installation page into the pattern shown below, then run the commands. + + ```bash + sudo zypper install initscripts urw-fonts wget + wget + sudo rpm -Uvh + ``` + +## Install Grafana as a standalone binary + +Complete the following steps to install Grafana using the standalone binaries: + +1. Navigate to the [Grafana download page](https://grafana.com/grafana/download). +1. Select the Grafana version you want to install. + - The most recent Grafana version is selected by default. + - The **Version** field displays only tagged releases. If you want to install a nightly build, click **Nightly Builds** and then select a version. +1. Select an **Edition**. + - **Enterprise:** This is the recommended version. It is functionally identical to the open-source version but includes features you can unlock with a license if you so choose. + - **Open Source:** This version is functionally identical to the Enterprise version, but you will need to download the Enterprise version if you want Enterprise features. +1. Depending on which system you are running, click the **Linux** or **ARM** tab on the download page. +1. Copy and paste the code from the installation page into your command line and run. + +## Next steps + +Refer to [Start the Grafana server]({{< relref "../../start-restart-grafana/" >}}). diff --git a/docs/sources/setup-grafana/start-restart-grafana.md b/docs/sources/setup-grafana/start-restart-grafana.md index 578752c109b..28e03200f5b 100644 --- a/docs/sources/setup-grafana/start-restart-grafana.md +++ b/docs/sources/setup-grafana/start-restart-grafana.md @@ -58,7 +58,7 @@ To restart the Grafana server, run the following commands: sudo systemctl restart grafana-server ``` -> **Note:** SUSE or OpenSUSE users might need to start the server with the systemd method, then use the init.d method to configure Grafana to start at boot. +> **Note:** SUSE or openSUSE users might need to start the server with the systemd method, then use the init.d method to configure Grafana to start at boot. ### Start the Grafana server using init.d diff --git a/docs/sources/shared/upgrade/upgrade-common-tasks.md b/docs/sources/shared/upgrade/upgrade-common-tasks.md new file mode 100644 index 00000000000..1382e1106e6 --- /dev/null +++ b/docs/sources/shared/upgrade/upgrade-common-tasks.md @@ -0,0 +1,187 @@ +--- +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. + +> **Note:** There might be minor breaking changes in some releases. We outline these changes in the [What's New ]({{< relref "../../whatsnew/" >}}) document for each release. + +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). + +> **Note:** When possible, we recommend that you test the Grafana upgrade process in a test or development environment. + +## 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 `/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 `/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 + sudo apt-get install -y adduser + sudo dpkg -i grafana__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 `/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 `/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 `/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 `/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. + + > **Note:** This is an example. The parameters you enter depend on how you configured your Grafana container. + + ```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 `/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 `/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 +```