Skip to content

Commit ac06b53

Browse files
Eopayemiandyo-tykletzya
authored
[DX-1722] Deprecation announcement (#5643)
* deprecation * ODIC * Update tyk-docs/content/basic-config-and-security/security/authentication-authorization/openid-connect.md Co-authored-by: andyo-tyk <[email protected]> * Update tyk-docs/content/basic-config-and-security/security/authentication-authorization/ext-oauth-middleware.md Co-authored-by: andyo-tyk <[email protected]> * Update tyk-docs/content/tyk-dashboard/database-options.md Co-authored-by: andyo-tyk <[email protected]> * remove odd file --------- Co-authored-by: andyo-tyk <[email protected]> Co-authored-by: Yaara <[email protected]>
1 parent 2b14aa6 commit ac06b53

File tree

12 files changed

+90
-1
lines changed

12 files changed

+90
-1
lines changed

tyk-docs/content/basic-config-and-security/security/authentication-authorization/ext-oauth-middleware.md

+5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ menu:
88
parent: "OAuth 2.0"
99
weight: 7
1010
---
11+
{{< note success >}}
12+
**Note**
13+
14+
Tyk's dedicated External OAuth middleware will be deprecated from Tyk 5.7.0. Tyk's [JSON Web Token (JWT)]({{< ref "basic-config-and-security/security/authentication-authorization/json-web-tokens#about-jwts" >}}) 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.
15+
{{< /note >}}
1116

1217
## Introduction
1318

tyk-docs/content/basic-config-and-security/security/authentication-authorization/openid-connect.md

+7
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ aliases:
1414
- /advanced-configuration/integrate/api-auth-mode/json-web-tokens
1515
---
1616

17+
{{< note success >}}
18+
**Note**
19+
20+
Tyk's dedicated OpenID Connect Authentication middleware will be deprecated from Tyk 5.7.0. Tyk's [JSON Web Token (JWT)]({{< ref "basic-config-and-security/security/authentication-authorization/json-web-tokens#about-jwts" >}}) authentication method also allows you to integrate with an OIDC provider, so the dedicated OIDC middleware will be deprecated to reduce duplication and potential for misconfiguration.
21+
{{< /note >}}
22+
23+
1724
[OpenID Connect](https://openid.net/developers/how-connect-works) (OIDC) builds on top of OAuth 2.0, adding authentication. You can secure your APIs on Tyk by integrating with any standards compliant OIDC provider using [JSON Web Tokens]({{< ref "basic-config-and-security/security/authentication-authorization/json-web-tokens" >}}) (JWTs).
1825
JWTs offer a simple way to use the third-party Identity Provider (IdP) without needing any direct integration between the Tyk and 3rd-party systems.
1926

tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md

+6
Original file line numberDiff line numberDiff line change
@@ -771,6 +771,12 @@ tyk-dev-portal:
771771

772772
#### Tyk Developer Portal Database
773773

774+
{{< note success >}}
775+
**Note**
776+
777+
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.
778+
{{< /note >}}
779+
774780
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.
775781

776782
```yaml

tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md

+6
Original file line numberDiff line numberDiff line change
@@ -794,6 +794,12 @@ tyk-dev-portal:
794794

795795
#### Tyk Developer Portal Database
796796

797+
{{< note success >}}
798+
**Note**
799+
800+
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.
801+
{{< /note >}}
802+
797803
By default, Tyk Developer Portal use `sqlite3` to store portal metadata. If you want to use other SQL Database, please modify the section below.
798804

799805
```yaml

tyk-docs/content/product-stack/tyk-dashboard/advanced-configurations/data-storage-configuration.md

+6
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,12 @@ Aggregated analytics corresponds to data that is used for the display of charts
164164

165165
#### How To Configure Tyk Pump To Write Aggregated Analytics To A SQL Database?
166166

167+
{{< note success >}}
168+
**Note**
169+
170+
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.
171+
{{< /note >}}
172+
167173
Storage of aggregated analytics data has been tested with PostgreSQL and SqlLite databases. The following environment variables can be used to manage this configuration:
168174

169175
- *TYK_PMP_PUMPS_SQLAGGREGATE_TYPE*: Set to *sql_aggregate* to configure Pump to store aggregated analytics data for charts and graphs in dashboard to a SQL based database.

tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.6.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,27 @@ An example is given below for illustrative purposes only. Tested Versions and Co
144144

145145
### Deprecations
146146
<!-- Required. Use the following statement if there are no deprecations, or explain if there are -->
147-
There are no deprecations in this release.
147+
148+
We are deprecating support for SQLite, External OAuth Middleware, and OpenID Connect (OIDC) Middleware in Tyk Dashboard to simplify the platform and enhance overall performance. These changes will take effect from 5.7.0.
149+
150+
### Why the Change?
151+
152+
### SQLite
153+
154+
While useful for testing, SQLite is not designed for production environments. By focusing on PostgreSQL and MongoDB, we can provide users with more scalable and reliable options.
155+
156+
### External OAuth Middleware
157+
158+
This feature serves a similar purpose to our JWT Authentication and may lead to confusion. We recommend transitioning to JWT Authentication for a more streamlined experience.
159+
160+
### OpenID Connect (OIDC) Middleware
161+
162+
The low adoption of this option, along with its functional overlap with other supported authentication methods, prompts us to deprecate OIDC middleware to reduce complexity within the platform. We recommend users transition to JWT Authentication.
163+
164+
165+
We encourage users to switch to the recommended alternatives. For more detailed information, please refer to the [Documentation](https://tyk.io/docs/basic-config-and-security/security/authentication-authorization/openid-connect/)
166+
167+
148168
<!-- Optional section!
149169
Used to share and notify users about our plan to deprecate features, configs etc.
150170
Once you put an item in this section, we must keep this item listed in all the following releases till the deprecation happens. -->

tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal.md

+7
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,12 @@ In terms of admin functionality, the only limitation will be the inability to ap
6868

6969

7070
### Does the portal support SQL databases for storing the portal's CMS assets?
71+
72+
{{< note success >}}
73+
**Note**
74+
75+
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.
76+
{{< /note >}}
77+
7178
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.
7279
During the bootstrap process, the portal will create the appropriate tables in the main database. The only thing required to enable SQL storage for the portal's assets is to specify the `db` [storage type]({{< ref "/product-stack/tyk-enterprise-developer-portal/deploy/configuration#portal_storage" >}}) either via a config file or an environment variable.

tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-docker.md

+6
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,12 @@ The above MySQL configuration is an example. You can customize deployment of you
159159
Please refer to the [MySQL documentation](https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html) for further guidance.
160160
{{< /warning >}}
161161

162+
{{< note success >}}
163+
**Note**
164+
165+
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.
166+
{{< /note >}}
167+
162168
#### Create an environment variables file
163169
Creating an environment variables file to specify settings for the portal is the next step.
164170
This is optional, as you can alternatively specify all the variables using the -e option when starting your deployment.

tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-helm.md

+6
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ Where `TYK_ORG` and `TYK_AUTH` are the Tyk Dashboard Organization ID and the Tyk
4242

4343
## Config settings
4444

45+
{{< note success >}}
46+
**Note**
47+
48+
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.
49+
{{< /note >}}
50+
4551
You must set the following values in the `values.yaml` or with `--set {field-name}={field-value}` with the helm upgrade command:
4652

4753
| Field Name | Description |

tyk-docs/content/product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-rpm.md

+7
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ sudo rpm -i portal-1.7.0-1.x86_64.rpm
4848
### Configure and launch the portal
4949

5050
#### Update the configuration file with your license
51+
52+
{{< note success >}}
53+
**Note**
54+
55+
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.
56+
{{< /note >}}
57+
5158
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`.
5259
Initially, the config file is filled with the default values. The minimal configuration change to start the portal is to add the `LicenseKey` property to the config file.
5360
The below sample configuration will start the portal on portal 3001 with SQLite as a database, no TLS enabled, and all CMS assets (images, theme files, etc.) are stored in the filesystem.

tyk-docs/content/tyk-dashboard/database-options.md

+7
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ Please check [here]({{< ref "planning-for-production/database-settings/mongodb.m
2424

2525
{{< include "sql-versions-include" >}}
2626

27+
{{< note success >}}
28+
**Note**
29+
30+
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.
31+
{{< /note >}}
32+
2733
### Configuring PostgreSQL
2834

2935
Please check [here]({{< ref "planning-for-production/database-settings/postgresql.md" >}}) for production configurations.
@@ -41,3 +47,4 @@ We recommend the following:
4147

4248
* For PoC installations, you can use any of the following platforms (SQLite, PostgreSQL or MongoDB).
4349
* For production installations, we **only** support MongoDB or PostgreSQL
50+

tyk-docs/content/tyk-pump/configuration.md

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ The Tyk Dashboard uses the `mongo-pump-aggregate` collection to display analytic
2828
{{< tab_end >}}
2929
{{< tab_start "SQL" >}}
3030

31+
{{< note success >}}
32+
**Note**
33+
34+
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.
35+
{{< /note >}}
36+
3137
In v4.0 of the Tyk Dashboard, we have added support for the following SQL platforms:
3238
- PostgreSQL
3339
- SQLite

0 commit comments

Comments
 (0)