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

Add Deprecation Notice to 5.7.0 #5734

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
d19c06b
external oauth
Eopayemi Nov 18, 2024
f3d0c5e
ODIC
Eopayemi Nov 19, 2024
7928acd
SQLite
Eopayemi Nov 19, 2024
1e8296a
charts
Eopayemi Nov 19, 2024
f3e42b7
final
Eopayemi Nov 19, 2024
2974c1a
Merge branch 'master' of https://github.com/TykTechnologies/tyk-docs …
sharadregoti Nov 25, 2024
32bfb11
Merge branch 'master' into update-5.7.0
sharadregoti Nov 26, 2024
bc36178
Removed extra notes
sharadregoti Nov 26, 2024
6ed1edd
Fixed URLs
sharadregoti Nov 26, 2024
2718f4a
Fixed URLs
sharadregoti Nov 26, 2024
0381117
Update tyk-docs/content/tyk-pump/configuration.md
Eopayemi Nov 27, 2024
71e9041
Update tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-ch…
Eopayemi Nov 27, 2024
67b4a77
Update tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md
Eopayemi Nov 27, 2024
0be9da6
Update tyk-docs/content/product-stack/tyk-enterprise-developer-portal…
Eopayemi Nov 27, 2024
bdc559b
Update tyk-docs/content/product-stack/tyk-enterprise-developer-portal…
Eopayemi Nov 27, 2024
566da47
Update tyk-docs/content/tyk-pump/configuration.md
Eopayemi Nov 27, 2024
b4274d0
Update tyk-docs/content/tyk-dashboard/database-options.md
Eopayemi Nov 27, 2024
8a13bd0
Update tyk-docs/content/tyk-dashboard/database-options.md
Eopayemi Nov 27, 2024
951a0b0
Update tyk-docs/content/product-stack/tyk-enterprise-developer-portal…
Eopayemi Nov 27, 2024
05880e2
Update tyk-docs/content/product-stack/tyk-enterprise-developer-portal…
Eopayemi Nov 27, 2024
a2de0cc
Update tyk-docs/content/product-stack/tyk-enterprise-developer-portal…
Eopayemi Nov 27, 2024
ae3ecca
Update tyk-docs/content/product-stack/tyk-dashboard/advanced-configur…
Eopayemi Nov 27, 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
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,6 @@ menu:
parent: "OAuth 2.0"
weight: 7
---
{{< note success >}}
**Note**

Tyk's dedicated External OAuth middleware will be deprecated from Tyk 5.7.0. Tyk's [JSON Web Token (JWT)]({{< ref "api-management/authentication-authorization#use-json-web-tokens-jwt" >}}) authentication method also allows you to integrate with a third party OAuth provider, so the dedicated middleware will be deprecated to reduce duplication and potential for misconfiguration.
{{< /note >}}

{{< note success >}}
**Note**

We've deprecated the External OAuth middleware in Tyk 5.7.0 to simplify configurations and avoid redundancy. For third-party OAuth integration, please switch to Tyk’s [JSON Web Tokens (JWT)]({{< ref "api-management/authentication-authorization#use-json-web-tokens-jwt" >}}), which offers the same functionality with a more streamlined setup and reduced risk of misconfiguration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this was supposed to be removed.

{{< /note >}}

{{< note success >}}
**Note**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -774,7 +774,7 @@ tyk-dev-portal:
{{< note success >}}
**Note**

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

By default, Tyk Developer Portal use `sqlite3` to store portal metadata. If you want to use a different SQL Database, please modify the section below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -797,7 +797,7 @@ tyk-dev-portal:
{{< note success >}}
**Note**

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

By default, Tyk Developer Portal use `sqlite3` to store portal metadata. If you want to use other SQL Database, please modify the section below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Aggregated analytics corresponds to data that is used for the display of charts
{{< note success >}}
**Note**

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

Storage of aggregated analytics data has been tested with PostgreSQL and SqlLite databases. The following environment variables can be used to manage this configuration:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ In terms of admin functionality, the only limitation will be the inability to ap
{{< note success >}}
**Note**

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

Yes, since 1.4.0 version of the Enterprise Developer Portal, it supports SQL databases (MariaDB, SQLite, MySQL, and PostgreSQL) for storing the portal's CMS assets.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,13 @@ docker volume rm tyk-portal-mysql-data
SQLite is useful for quick deployment and testing, however we don't recommend using it in production.
{{< /warning >}}

{{< note success >}}
**Note**

SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}


### Prepare an environment variables file and data volumes
#### Create a volume for the portal's database
To start with, you need to create a single volume for sqlite:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Where `TYK_ORG` and `TYK_AUTH` are the Tyk Dashboard Organization ID and the Tyk
{{< note success >}}
**Note**

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

You must set the following values in the `values.yaml` or with `--set {field-name}={field-value}` with the helm upgrade command:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ sudo rpm -i portal-1.7.0-1.x86_64.rpm
{{< note success >}}
**Note**

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

Before starting the portal service, you need to configure the portal. Once the rpm package has been installed, the portal configuration file will be located in `/opt/portal/portal.conf`.
Expand Down
6 changes: 6 additions & 0 deletions tyk-docs/content/tyk-dashboard/database-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ All data stored in SQL platforms will be identical to our existing MongoDB suppo

## Which platform should you use?

{{< note success >}}
**Note**

SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

We recommend the following:

* For PoC installations, you can use any of the following platforms (SQLite, PostgreSQL or MongoDB).
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/tyk-pump/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The Tyk Dashboard uses the `mongo-pump-aggregate` collection to display analytic
{{< note success >}}
**Note**

SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
SQLite support has reached end of life as of Tyk 5.7.0. To avoid disruption, please transition to [PostgreSQL]({{< ref"planning-for-production/database-settings/postgresql#introduction" >}}), [MongoDB]({{< ref "planning-for-production/database-settings/mongodb" >}}), or one of the listed compatible alternatives.
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
{{< /note >}}

In v4.0 of the Tyk Dashboard, we have added support for the following SQL platforms:
Eopayemi marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
Loading