Skip to content

[TT-14838] GW 5.8.3 Update documentation #6629

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 11 commits into
base: master
Choose a base branch
from

Conversation

buger
Copy link
Member

@buger buger commented Jul 3, 2025

Triggered by: lghiur

Included:

Tyk Gateway: true
Tyk Dashboard: false
Tyk MDCB false
Tyk Pump false

Intended for: master
Changes sourced from: release-5.8.3
Config info generator branch: main

Note: Gateway docs updates for release-5.8.3 (branch suffix: docs)

JIRA: https://tyktech.atlassian.net/browse/TT-14838

@buger buger force-pushed the update/TT-14838/release-master-docs branch from cf68346 to dd0ec7f Compare July 3, 2025 09:55
Copy link
Contributor

github-actions bot commented Jul 3, 2025

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

Copy link
Contributor

github-actions bot commented Jul 3, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

Documentation Accuracy

The new configuration options for readiness check, graceful shutdown timeout, and gRPC round robin load balancing should be validated for accuracy and completeness. Ensure that the documented environment variables, types, and default values match the actual implementation.

HealthCheckEndpointName Enables you to change the liveness endpoint.
Default is "/hello"

### readiness_check_endpoint_name
ENV: <b>TYK_GW_READINESSCHECKENDPOINTNAME</b><br />
Type: `string`<br />

ReadinessCheckEndpointName Enables you to change the readiness endpoint
Default is "/ready"

### graceful_shutdown_timeout_duration
ENV: <b>TYK_GW_GRACEFULSHUTDOWNTIMEOUTDURATION</b><br />
Type: `int`<br />

GracefulShutdownTimeoutDuration sets how many seconds the gateway should wait for an existing connection
to finish before shutting down the server. Defaults to 30 seconds.
Deprecation Notice Clarity

The deprecation notice for ExternalOAuth has been updated. Confirm that the language is clear and consistent with other deprecation notices, and that it accurately reflects the product's deprecation policy.

Deprecated: ExternalOAuth support has been deprecated from 5.7.0.
To avoid any disruptions, we recommend that you use JSON Web Token (JWT) instead,

Copy link
Contributor

github-actions bot commented Jul 3, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

Copy link

netlify bot commented Jul 3, 2025

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

Name Link
🔨 Latest commit f44e73f
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/687546944b948a000869b586
😎 Deploy Preview https://deploy-preview-6629--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.

@lghiur lghiur changed the title [TT-14838] Update documentation for master [TT-14838] 5.8.3 Gateway Update documentation Jul 3, 2025
@lghiur lghiur added the 5.8.3 label Jul 3, 2025
@@ -1416,7 +1417,7 @@ Tyk classic API definition: `version_data.versions..extended_paths.transform_hea
ContextVariables holds the configuration related to Tyk context variables.

**Field: `enabled` (`boolean`)**
Enabled enables context variables to be passed to Tyk middleware.
Enabled enables context variables to be passed to Tyk middlewares.
Copy link
Contributor

@andyo-tyk andyo-tyk Jul 10, 2025

Choose a reason for hiding this comment

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

Suggested change
Enabled enables context variables to be passed to Tyk middlewares.
Enabled provides access to context variables from specific Tyk middleware (URL rewrite, header and body transform).

Copy link
Contributor

@andyo-tyk andyo-tyk left a comment

Choose a reason for hiding this comment

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

Improve clarity for gRPC plugin load balancing

ENV: <b>TYK_GW_COPROCESSOPTIONS_GRPCROUNDROBINLOADBALANCING</b><br />
Type: `bool`<br />

GRPCRoundRobinLoadBalancing enables round robin load balancing for gRPC services
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
GRPCRoundRobinLoadBalancing enables round robin load balancing for gRPC services
GRPCRoundRobinLoadBalancing enables round robin load balancing for gRPC services; you must provide the address of the load balanced service using `dns:///` protocol in `coprocess_grpc_server`.

@buger buger changed the title [TT-14838] 5.8.3 Gateway Update documentation [TT-14838] Update documentation for master Jul 11, 2025
@buger buger force-pushed the update/TT-14838/release-master-docs branch from 09fb122 to d969c6a Compare July 11, 2025 08:48
@lghiur lghiur changed the title [TT-14838] Update documentation for master [TT-14838] GW 5.8.3 Update documentation Jul 11, 2025
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.

6 participants