Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Redash upgrade instructions and compose file #698

Merged
merged 4 commits into from
Apr 29, 2024
Merged

Update Redash upgrade instructions and compose file #698

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8708853
Update Redash upgrade instructions and compose file
mirkan1 Apr 28, 2024
7743ad9
Restyled by prettier-markdown
restyled-commits Apr 28, 2024
6fb630e
//
mirkan1 Apr 29, 2024
9c1eef6
//
mirkan1 Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions src/pages/kb/open-source/admin-guide/how-to-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,21 @@ These instructions are for users of our new Docker-based instance. If you run ou

We recommended you upgrade your Redash instance to the latest release so you can benefit from new features and bug fixes. This document assumes you used our images to set up your instance of Redash.

For best results you should upgrade Redash by one semantic version at a time. To move from V4 to V7, for example, you should upgrade V4 to V5 to V6 to V7.
For best results you should upgrade Redash by one semantic version at a time. To move from V6 to V10, for example, you should upgrade V6 to V7 to V8 to V10.

During each migration, check the [releases page](https://github.com/getredash/redash/releases) for any special notices or breaking changes in the next version.

Below is a table of recent docker release images for your reference:

| released_at | version | docker_image |
| ----------- | ------- | -------------------------- |
| 2019-10-27 | 8.0.0 | redash/redash:8.0.0.b32245 |
| 2019-03-17 | 7.0.0 | redash/redash:7.0.0.b18042 |
| 2018-12-17 | 6.0.0 | redash/redash:6.0.0.b8537 |
| 2018-10-18 | 5.0.2 | redash/redash:5.0.2.b5486 |
| 2018-09-27 | 5.0.1 | redash/redash:5.0.1.b4850 |
| released_at | version | docker_image |
| ----------- | ------- | --------------------------- |
| 2021-12-24 | 10.1.0 | redash/redash:10.1.0.b50633 |
| 2021-10-02 | 10.0.0 | redash/redash:10.0.0.b50363 |
| 2019-10-27 | 8.0.0 | redash/redash:8.0.0.b32245 |
| 2019-03-17 | 7.0.0 | redash/redash:7.0.0.b18042 |
| 2018-12-17 | 6.0.0 | redash/redash:6.0.0.b8537 |
| 2018-10-18 | 5.0.2 | redash/redash:5.0.2.b5486 |
| 2018-09-27 | 5.0.1 | redash/redash:5.0.1.b4850 |

{% callout warning %}

Expand All @@ -39,14 +41,14 @@ If you are currently running an instance of Redash prior to V7, **do not upgrade
1. Make sure to backup your data. You need to backup Redash's PostgreSQL database (the database Redash stores metadata in, not the ones you might be querying) and your `.env` file (if it exists). The data in Redis is transient.
2. Change directory to `/opt/redash`.
3. Update `/opt/redash/docker-compose.yml` Redash image reference to the one you want to upgrade to.
4. Stop Redash services: `docker-compose stop server scheduler scheduled_worker adhoc_worker` (you might need to list additional services if you updated your configuration)
5. Apply migration (if necessary): `docker-compose run --rm server manage db upgrade`
6. Start services: `docker-compose up -d`
4. Stop Redash services: `docker compose stop server scheduler scheduled_worker adhoc_worker` (you might need to list additional services if you updated your configuration)
5. Apply migration (if necessary): `docker compose run --rm server manage db upgrade`
6. Start services: `docker compose up -d`

_Done!_

{% callout %}
**Getting an error when running `docker` or `docker-compose` commands?**
**Getting an error when running `docker` or `docker compose` commands?**

Make sure the `ubuntu` user is part of the `docker` group:

Expand Down
Loading