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.

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

website/docs: new upgrade page #10742

Merged
merged 24 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion website/docs/installation/docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import TabItem from "@theme/TabItem";
wget https://goauthentik.io/docker-compose.yml
```
</TabItem>
<TabItem value="MacOS" label="MacOS">
<TabItem value="macOS" label="macOS">
```shell
curl -O https://goauthentik.io/docker-compose.yml
```
Expand Down
61 changes: 61 additions & 0 deletions website/docs/installation/upgrade.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Upgrade authentik
tanberry marked this conversation as resolved.
Show resolved Hide resolved
tanberry marked this conversation as resolved.
Show resolved Hide resolved
---

Upgrading to the latest version of authentik, whether a new major release or a patch, involves running a few commands to pull down the latest images and then restarting the servers and databases.

## Important considerations

- Be sure to carefully read the [Release Notes](../releases/) for the specific version to which you plan to upgrade. The release might have special requirements or actions or contain breaking changes.

- Make a backup of your PostgreSQL database before upgrading. You can dump your existing database to get a backup file. For more information about dumping and backing up your database, refer to [Upgrade PostgreSQL on Docker Compose](../troubleshooting/postgres/upgrade_docker.md) or [Upgrade PostgreSQL on Kubernetes](../troubleshooting/postgres/upgrade_kubernetes.md).

- You need to upgrade in sequence of the major releases; do not skip directly from an older major version to the most recent version. For example, if you are currently running 2023.10.3, you will need to first upgrade to 2024.2.x, then 2024.4.x, and then 2024.6.x, in sequence.

- The version of the authentik instance and any outposts must be the same. We recommended that you always upgrade any outposts at the same time you upgrade your authentik instance.

## Upgrade authentik

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs groupId="platform">
<TabItem value="docker-compose" label="Docker Compose" default>
In your terminal, navigate to your installation directory and follow these steps:

#### 1. Retrieve latest `docker-compose.yml` file

Download the `docker-compose.yml` file using either `wget -O docker-compose.yml https://goauthentik.io/docker-compose.yml` or `curl -O https://goauthentik.io/docker-compose.yml` or a similar process.

**2. Run upgrade commands**

```shell
tanberry marked this conversation as resolved.
Show resolved Hide resolved
docker compose pull
docker compose up -d
```

</TabItem>
<TabItem value="kubernetes" label="Kubernetes">
In your terminal, navigate to your installation directory and run the following commands:

```
helm repo update
helm install --upgrade authentik authentik/authentik -f values.yaml
```

</TabItem>
</Tabs>

## Verify your upgrade

You can view the current version of your authentik instance by logging in to the Admin interface, and then navigating to **Dashboards -> Overview**.

![](./version1.png)

## Troubleshooting your upgrade

If you run the upgrade commands but your version on the Dashboard doesn’t change, follow this steps:

1. Look at the server logs and search for an entry of `migration inconsistency`.
2. If you see this entry, revert to your database backup.
3. Now, upgrade to each subsequent higher version. That is, upgrade in sequence, do not skip directly to the most recent version.
Binary file added website/docs/installation/version1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions website/docs/releases/_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@ To try out the release candidate, replace your Docker image tag with the latest

## Upgrading

This release does not introduce any new requirements.
This release does not introduce any new requirements. You can follow the upgrade instructions below; for more detailed information about upgrading authentik, refer to our [Upgrade documentation](../installation/upgrade.mdx).

### docker-compose
:::warning
When you upgrade, be aware that the version of the authentik instance and of any outposts must be the same. We recommended that you always upgrade any outposts at the same time you upgrade your authentik instance.
:::

### Docker Compose

To upgrade, download the new docker-compose file and update the Docker stack with the new version, using these commands:

Expand Down
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const docsSidebar = {
items: [
"installation/docker-compose",
"installation/kubernetes",
"installation/upgrade",
"installation/beta",
"installation/configuration",
"installation/reverse-proxy",
Expand Down
Loading