Skip to content
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: upgrade-kratos
title: Upgrade Ory Kratos OEL
id: upgrade
title: Upgrade Ory Kratos OEL to a newer version
sidebar_label: Upgrade Ory Kratos OEL
---

Follow this guide when you upgrade Ory Kratos Enterprise License (OEL) to a newer version. Upgrade to the latest version for the
Expand All @@ -9,20 +10,21 @@ newest features, security updates, and performance improvements.
If you encounter any issues during the upgrade process, please reach out to [Ory support](https://console.ory.sh/support) for
assistance.

## Prerequisites
```mdx-code-block
import Prerequisites from "../oel-common-prerequisites.md"

Before you upgrade, make sure you have
<Prerequisites />
```

- A valid Ory Enterprise License.
- Access to the Ory Enterprise Docker Registry.
- Backup of your current data and configuration.
## Pick the right version

### Backup Your Data
:::note

Ensure you have a complete backup of your database and configuration files. This step is crucial for restoring your system in case
of an upgrade failure.
Zero-downtime migrations are only possible if you do not skip any version when upgrading.

## Pick the right version
:::

The tags are ordered by date. Pick the newest version from the top of the list to upgrade.

To check if there is a newer versions of Ory Kratos OEL, check your Docker or Kubernetes environment to find the tag you are
running and compare against this list:
Expand All @@ -33,14 +35,6 @@ import ImageTags from "../oel-kratos-image-tags.md"
<ImageTags />
```

:::note

Zero-downtime migrations are only possible if you do not skip any version when upgrading.

:::

The tags are ordered by date. Pick the newest version from the top of the list to upgrade.

### Check Release Notes

Before upgrading, review the [changelog](changelog.mdx) for the picked version to understand the changes, new features, and any
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/oel/monitoring/monitoring.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: monitoring
title: Monitoring quickstart
title: Monitoring
---

This guide presents exemplary monitoring configuration that will work with OEL applications.
Expand Down
17 changes: 17 additions & 0 deletions docs/self-hosted/oel/oathkeeper/changelog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: changelog
title: Changelog for Ory Oathkeeper OEL
sidebar_label: Changelog
---

## 2025-05-08

### Initial Ory Oathkeeper OEL release

Changes:

- fix security vulnerability classified as critical CVE-2025-22871
- fix security vulnerability classified as high CVE-2025-30204 (GHSA-mh63-6h87-95cp)

No specific upgrade steps are required for this release. The Ory Kratos OEL image is now available in the Ory Enterprise Docker
Registry.
13 changes: 6 additions & 7 deletions docs/self-hosted/oel/oathkeeper/upgrade-oathkeeper.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: upgrade-oathkeeper
title: Upgrade Ory Oathkeeper OEL
title: Upgrade Ory Oathkeeper OEL to a newer version
sidebar_label: Upgrade Ory Oathkeeper OEL
---

Follow this guide when you upgrade Ory Oathkeeper Enterprise License (OEL) to a newer version. Upgrade to the latest version for
Expand All @@ -9,13 +10,11 @@ the newest features, security updates, and performance improvements.
If you encounter any issues during the upgrade process, please reach out to [Ory support](https://console.ory.sh/support) for
assistance.

## Prerequisites

Before you upgrade, make sure you have
```mdx-code-block
import Prerequisites from "../oel-common-prerequisites.md"

- a valid Ory Enterprise License.
- access to the Ory Enterprise Docker Registry.
- a backup of your current configuration.
<Prerequisites />
```

Ory Oathkeeper does not require any database migrations as it does not use a database.

Expand Down
14 changes: 6 additions & 8 deletions docs/self-hosted/oel/oauth2/migrate.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
---
id: migrate
title: Upgrade Ory Hydra OEL
title: Migrate to Ory Hydra OEL from Self-Hosted Ory Hydra
---

This guide outlines the steps to upgrade from self-hosted Ory Hydra to Ory Hydra Enterprise License (OEL). Upgrading to OEL
provides additional features and support for enterprise customers.

## Prerequisites
```mdx-code-block
import Prerequisites from "../oel-common-prerequisites.md"
Before starting the upgrade process, ensure you meet the following requirements:
<Prerequisites />
```

1. **Valid Ory Enterprise License**: You must have purchased an Ory Enterprise License.
2. **Access to the Ory Enterprise Docker Registry**: You need access to download the OEL Docker images.
3. **Ory Hydra Version**: Your current Ory Hydra installation must be version 2.0 or higher.
4. **Backup and Testing**: Create a backup of your current Ory Hydra database and test the migration on a test environment to
ensure compatibility and minimize risks.
- **Ory Hydra Version**: Your current Ory Hydra installation must be version 2.0 or higher.

## Upgrade process

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: revert-database-migrations
title: Reverting database migrations
title: Revert database migrations
---

# Reverting Database Migration for Ory Hydra
Expand Down
29 changes: 14 additions & 15 deletions docs/self-hosted/oel/oauth2/upgrade.mdx
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
---
id: upgrade
title: Upgrading Ory Hydra OEL
title: Upgrade Ory Hydra OEL to a newer version
sidebar_label: Upgrade Ory Hydra OEL
---

This document provides a comprehensive guide on how to upgrade your Ory Hydra Enterprise License (OEL) version. Upgrading to the
latest version ensures you have the newest features, security updates, and performance improvements.

## Prerequisites

Before proceeding with the upgrade, ensure you have:
```mdx-code-block
import Prerequisites from "../oel-common-prerequisites.md"

- A valid Ory Enterprise License.
- Access to the Ory Enterprise Docker Registry.
- Backup of your current data and configuration.
<Prerequisites />
```

## Pick the right version

To upgrade Ory Hydra OEL, you need to know the version you are currently running. Check your Docker or Kubernetes environment to
find the tag. You should find your tag in this list:

```mdx-code-block
import ImageTags from "../oel-hydra-image-tags.md"

<ImageTags />
```
find the tag. You should find your tag in this list down below.

:::note

Zero-downtime migrations are only possible if you do not skip any version when upgrading.

:::

The tags are ordered by date. Pick the newest version from the top of the list to upgrade.
The list is ordered by date. Pick the newest version from the top of the list to upgrade.

```mdx-code-block
import ImageTags from "../oel-hydra-image-tags.md"

<ImageTags />
```

## Upgrade Using Helm Charts in Kubernetes

Expand Down
8 changes: 8 additions & 0 deletions docs/self-hosted/oel/oel-common-prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Prerequisites

Before starting the process, ensure you meet the following requirements:

- Valid Ory Enterprise License: You must have purchased an Ory Enterprise License.
- Access to the Ory Enterprise Docker Registry: You need access to download the OEL Docker images.
- Backup and Testing: Create a backup of your current Ory database if you are upgrading or migrating and test the process on a
test environment to ensure compatibility and minimize risks.
14 changes: 13 additions & 1 deletion docs/self-hosted/oel/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@ To be able to run an enterprise build, you need:
- A valid Ory Enterprise License.
- Access to the Ory Enterprise Docker Registry.
- CockroachDB Enterprise (community version is not supported).
- Support for MySQL and PostgreSQL is available as well, but some features will be unavailable.

:::note

Support for MySQL and PostgreSQL is available as well, but some features will be unavailable. Please
[contact the team](https://www.ory.sh/contact) to talk about your use case.

:::

Ory Enterprise builds are not available for public download and require a license agreement with Ory to run.

Expand All @@ -37,6 +43,12 @@ The Ory Oathkeeper Enterprise license includes additional features and support f

- Regular releases addressing CVEs and security vulnerabilities.

## Ory Kratos Enterprise License

The Ory Kratos Enterprise license includes additional features and support for enterprise customers:

- Regular releases addressing CVEs and security vulnerabilities.

### Ory Hydra Docker Registry

There are two Docker registries available in different regions:
Expand Down
11 changes: 7 additions & 4 deletions src/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1177,23 +1177,26 @@ const oel: SidebarItemsConfig = [
label: "Ory Hydra OAuth2",
items: [
"self-hosted/oel/oauth2/migrate",
"self-hosted/oel/oauth2/token-prefix",
"self-hosted/oel/oauth2/upgrade",
"self-hosted/oel/oauth2/changelog",
"self-hosted/oel/oauth2/token-prefix",
"self-hosted/oel/oauth2/migrate-postgresql-ttl",
"self-hosted/oel/oauth2/revert-database-migrations",
"self-hosted/oel/oauth2/changelog",
],
},
{
type: "category",
label: "Ory Oathkeeper Zero Trust",
items: ["self-hosted/oel/oathkeeper/upgrade-oathkeeper"],
items: [
"self-hosted/oel/oathkeeper/upgrade-oathkeeper",
"self-hosted/oel/oathkeeper/changelog",
],
},
{
type: "category",
label: "Ory Kratos Identities",
items: [
"self-hosted/oel/kratos/upgrade-kratos",
"self-hosted/oel/kratos/upgrade",
"self-hosted/oel/kratos/changelog",
],
},
Expand Down
Loading