Skip to content

Improve SQLITE deprecation message in Tyk Dashboard RN #6713

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

Open
wants to merge 36 commits into
base: master
Choose a base branch
from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Jul 11, 2025

User description

Contributor checklist

  • Reviewed PR Code suggestions and updated accordingly
  • Tyklings: Labled the PR with the relevant releases
  • Tyklings: Added Jira DX PR ticket to the subject

New Contributors



PR Type

Documentation


Description

  • Expanded and clarified deprecation notice for authentication methods.

  • Added detailed explanation of SQLite End of Life.

  • Provided migration recommendations to PostgreSQL or MongoDB.

  • Explained technical benefits of removing SQLite dependency.


Changes diagram

flowchart LR
  A["Old Deprecation Notice"] -- "Replaced with" --> B["Expanded Auth Methods Deprecation"]
  A -- "Replaced with" --> C["Detailed SQLite End of Life Section"]
  B -- "Recommends" --> D["JWT Authentication"]
  C -- "Recommends" --> E["PostgreSQL or MongoDB"]
  C -- "Explains" --> F["Benefits: Static Binary, No CGO, RHEL8 Support"]
Loading

Changes walkthrough 📝

Relevant files
Documentation
dashboard.md
Expanded and clarified deprecation and migration guidance

tyk-docs/content/developer-support/release-notes/dashboard.md

  • Rewrote and expanded the deprecation section for clarity.
  • Added detailed rationale for SQLite deprecation and migration advice.
  • Provided technical explanation of CGO/static binary benefits.
  • Improved formatting and structure for easier reading.
  • +36/-8   

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @sharadregoti
    Copy link
    Contributor Author

    /writer "Do you have any more suggestions on this change?"

    Copy link
    Contributor

    ⚠️ Deploy preview for PR #6713 did not become live after 3 attempts.
    Please check Netlify or try manually: Preview URL

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Clarity and Accuracy

    The expanded deprecation and migration guidance should be reviewed for technical accuracy, clarity, and consistency with current product support and messaging.

    This section highlights features and dependencies that have been deprecated.
    
    ##### Authentication Methods
    
    We’ve deprecated the following authentication methods in this release:
    
    * **[External OAuth]({{< ref "api-management/client-authentication#integrate-with-external-authorization-server-deprecated" >}})**
    
      * Tyk Classic: `external_oauth`
      * Tyk OAS: `server.authentication.securitySchemes.externalOAuth`
    
    * **[OpenID Connect (OIDC)]({{< ref "api-management/client-authentication#integrate-with-openid-connect-deprecated" >}})**
    
      * Tyk Classic: `auth_configs.oidc`
      * Tyk OAS: `server.authentication.oidc`
    
    We recommend migrating to **[JWT Authentication]({{< ref "basic-config-and-security/security/authentication-authorization/json-web-tokens" >}})** for improved flexibility and long-term support.
    
    ##### SQLite End of Life
    
    SQLite has reached **End of Life** for the Tyk Dashboard in this release. It was previously intended for **proof-of-concept** use only and is no longer supported.
    
    We now recommend using **PostgreSQL** or **MongoDB** for both development and production deployments, as they provide greater scalability and long-term support.
    
    **Why This Matters**
    
    * SQLite is written in **C**, and using it in Go projects typically requires [**CGO**](https://golang.org/cmd/cgo/), which enables Go code to call C libraries.
    * As long as the Dashboard depended on SQLite, CGO was required.
    * With SQLite removed, the Tyk Dashboard can now be compiled with `CGO_ENABLED=0`, resulting in a **fully static binary**.
    
    This change enables:
    
    * Easier cross-platform builds
    * Better compatibility with **RHEL8**
    * Fewer dependencies and improved portability
    

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link
    Contributor

    PR Analysis: Improve SQLite Deprecation Message in Tyk Dashboard Release Notes

    This PR enhances the SQLite deprecation message in the Tyk Dashboard release notes, significantly improving clarity and providing better context for users.

    Changes Made

    The PR transforms a simple paragraph about SQLite deprecation into a well-structured, informative section that:

    1. Adds a clear heading - "SQLite End of Life" makes the deprecation more visible
    2. Improves formatting - Uses bullet points and bold text for better readability
    3. Provides technical context - Explains the CGO dependency issue
    4. Clarifies the benefits of removing SQLite:
      • Enables fully static binary compilation (CGO_ENABLED=0)
      • Facilitates easier cross-platform builds
      • Improves compatibility with RHEL8
      • Reduces dependencies and enhances portability

    Impact

    These changes help users better understand:

    • Why SQLite is being deprecated (technical reasons beyond just scalability)
    • What alternatives they should use (PostgreSQL or MongoDB)
    • The technical benefits this change brings to the Tyk Dashboard

    The improved message structure and formatting also aligns with the style of other sections in the release notes, creating a more consistent and professional document.

    This is a valuable improvement that provides users with clearer guidance during this transition away from SQLite support.


    Tip: Mention me again using /probe <request>.
    Powered by Probe AI

    Copy link

    netlify bot commented Jul 11, 2025

    PS. Add to the end of url /docs/nightly

    Name Link
    🔨 Latest commit 8394546
    🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/6870ec4a700de200087af0df
    😎 Deploy Preview https://deploy-preview-6713--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify project configuration.

    Copy link

    netlify bot commented Jul 11, 2025

    PS. Add to the end of url /docs/nightly

    Name Link
    🔨 Latest commit 48b6b0f
    🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/6875468d2145620008363403
    😎 Deploy Preview https://deploy-preview-6713--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify project configuration.

    @sharadregoti sharadregoti requested a review from letzya July 14, 2025 07:53
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants