Skip to content

[TT-14448] Add AMQP 1.0 docs #6601

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

Conversation

buraksezer
Copy link
Contributor

@buraksezer buraksezer commented Jun 26, 2025

User description

PR for https://tyktech.atlassian.net/browse/TT-14448


PR Type

Documentation


Description

  • Add comprehensive documentation for amqp_1 input configuration

  • Add detailed documentation for amqp_1 output configuration

  • Document all configuration fields, metadata, and performance tips

  • Provide YAML configuration examples for both input and output


Changes walkthrough 📝

Relevant files
Documentation
stream-config.md
Add AMQP 1.0 input/output documentation and configuration examples

tyk-docs/content/api-management/stream-config.md

  • Added a new section for amqp_1 input, detailing all config fields,
    metadata, and usage
  • Added a new section for amqp_1 output, covering all config options,
    metadata, and performance
  • Included YAML configuration examples and field-by-field explanations
    for both input and output
  • Enhanced documentation with security notes and advanced options for
    TLS and SASL
  • +603/-0 

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

    ⚠️ Deploy preview for PR #6601 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: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 Security concerns

    Sensitive information exposure:
    The documentation includes examples and fields for sensitive data (e.g., TLS keys, SASL passwords) and currently only references a TODO for linking to secrets management best practices. Without clear, actionable warnings or links, users may inadvertently expose secrets in configuration files. Ensure the documentation is updated to reference secure handling practices and secrets management documentation.

    ⚡ Recommended focus areas for review

    Sensitive Information Handling

    Several fields (such as tls.root_cas, tls.client_certs[].key, and sasl.password) are marked as containing sensitive information, but the documentation only includes TODO comments for linking to the secrets management documentation. Ensure that the final documentation provides clear guidance and warnings about securely handling secrets and does not encourage users to hardcode sensitive data.

    <!-- TODO add secrets link :::warning Secret
    This field contains sensitive information that usually shouldn't be added to a config directly, read our [secrets page for more info](/docs/configuration/secrets).
    ::: -->
    Documentation Clarity

    The documentation is comprehensive but could benefit from additional clarity or warnings regarding the use of environment variables for sensitive fields, and the risks of including secrets directly in configuration files. Consider making these warnings more prominent.

    A SASL plain text username. It is recommended that you use environment variables to populate this field.
    

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Jun 26, 2025

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

    Name Link
    🔨 Latest commit 8b622df
    🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/685d4a3517924e0008087dda
    😎 Deploy Preview https://deploy-preview-6601--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 Jun 26, 2025

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

    Name Link
    🔨 Latest commit cba857e
    🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/6867d5126bd82a0008443ddb
    😎 Deploy Preview https://deploy-preview-6601--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.

    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