Skip to content

docs: kubernetes best practices and postgresql dba guide#9226

Merged
aimurphy merged 33 commits into
mainfrom
docs-lfoss-1579-kubernetes-and-dba
Aug 1, 2025
Merged

docs: kubernetes best practices and postgresql dba guide#9226
aimurphy merged 33 commits into
mainfrom
docs-lfoss-1579-kubernetes-and-dba

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Jul 29, 2025

  • Database administration for postgresql
  • Kubernetes scaling best practices
  • Update Kubernetes pages where required

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive "Langflow Database Guide for Enterprise DBAs" covering PostgreSQL deployment, high availability, monitoring, security, and operational best practices.
    • Expanded production best practices with detailed sections on scaling, resource allocation, failure mitigation, monitoring, and security for Kubernetes deployments.
    • Updated the custom database configuration guide to reference the new enterprise database guide.
    • Added the new database guide to the documentation sidebar for easier navigation.

@mendonk mendonk self-assigned this Jul 29, 2025
@mendonk mendonk requested a review from aimurphy July 29, 2025 14:45
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 29, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

New enterprise-focused documentation was added, including a comprehensive PostgreSQL deployment and operations guide for database administrators. Existing production best practices and custom database configuration documents were expanded with detailed operational, scaling, security, and monitoring guidance. The documentation sidebar was updated to reference the new enterprise database guide.

Changes

Cohort / File(s) Change Summary
Enterprise Database Guide Addition
docs/docs/Deployment/deployment-enterprise-database.mdx
Added a detailed guide for enterprise DBAs covering PostgreSQL deployment, high availability, scaling, security, monitoring, and failure mitigation for Langflow in production environments.
Production Best Practices Expansion
docs/docs/Deployment/deployment-prod-best-practices.mdx
Expanded with sections on scaling resources, failure points, monitoring, and security for production deployments, especially on Kubernetes.
Custom Database Config Docs Update
docs/docs/Configuration/configuration-custom-database.mdx
Appended a "See also" section with a reference link to the new enterprise database guide.
Sidebar Navigation Update
docs/sidebars.js
Added the new enterprise database guide to the "Storage and memory" category in the documentation sidebar.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Suggested labels

documentation, size:L, lgtm

Suggested reviewers

  • aimurphy
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-lfoss-1579-kubernetes-and-dba

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 29, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (2)
docs/docs/Deployment/deployment-prod-best-practices.mdx (1)

101-109: Minor style nit – indent fenced block at list level

Because this fenced block sits inside a list, indenting it two spaces avoids Markdown renderer quirks where the code block can break the list formatting in some interpreters.

-    ```yaml
+  ```yaml
   resources:
     requests:
       memory: "2Gi"
docs/docs/Deployment/deployment-enterprise-database.mdx (1)

105-110: Optional: highlight HA connection string with admonition

Consider wrapping this best-practice in an admonition block to make it pop for readers skimming the guide.

:::tip Connection string for fail-over
Use a virtual IP or proxy DNS that always points to the current primary:
`postgresql://langflow:securepassword@db-proxy:5432/langflow?sslmode=require`
:::
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 575cde3 and 8ee663d.

📒 Files selected for processing (4)
  • docs/docs/Configuration/configuration-custom-database.mdx (1 hunks)
  • docs/docs/Deployment/deployment-enterprise-database.mdx (1 hunks)
  • docs/docs/Deployment/deployment-prod-best-practices.mdx (1 hunks)
  • docs/sidebars.js (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/docs/**/*.{md,mdx}

📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Files:

  • docs/docs/Deployment/deployment-prod-best-practices.mdx
  • docs/docs/Configuration/configuration-custom-database.mdx
  • docs/docs/Deployment/deployment-enterprise-database.mdx
docs/sidebars.js

📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.

Files:

  • docs/sidebars.js
🧠 Learnings (4)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Before deployment, documentation must be reviewed for accuracy, completeness, clarity, and navigation, including checking for broken links and up-to-date screenshots.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Use SQLite for development and PostgreSQL for production databases
docs/docs/Deployment/deployment-prod-best-practices.mdx (5)

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Before deployment, documentation must be reviewed for accuracy, completeness, clarity, and navigation, including checking for broken links and up-to-date screenshots.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.

Learnt from: deon-sanchez
PR: #9158
File: src/backend/base/langflow/api/v1/mcp_projects.py:404-404
Timestamp: 2025-07-23T21:19:22.567Z
Learning: In langflow MCP projects configuration, prefer using dynamically computed URLs (like the sse_url variable) over hardcoded localhost URLs to ensure compatibility across different deployment environments.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.

docs/sidebars.js (4)

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/sidebars.js : Sidebar navigation must be updated in docs/sidebars.js to reflect new or reorganized documentation content.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Sidebar and navigation should be kept current to ensure users can easily find all documentation sections and cross-references.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: All documentation changes must be built and served locally using yarn build and yarn serve before deployment.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docusaurus.config.js : Site configuration such as title, tagline, URL, and navbar items must be managed in docs/docusaurus.config.js.

docs/docs/Deployment/deployment-enterprise-database.mdx (4)

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Applies to src/backend/base/langflow/services/database/models/**/*.py : Place database models in src/backend/base/langflow/services/database/models/

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.

Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Use SQLite for development and PostgreSQL for production databases

🔇 Additional comments (2)
docs/docs/Configuration/configuration-custom-database.mdx (1)

162-164: Link addition looks good

Clear cross-reference to the new enterprise guide improves navigation.

docs/sidebars.js (1)

142-146: Sidebar entry correctly wired

The new ID matches the file path and keeps the “Storage and memory” section coherent.
Nothing else to address.

Comment thread docs/docs/Configuration/configuration-custom-database.mdx
Comment thread docs/docs/Deployment/deployment-enterprise-database.mdx Outdated
Comment thread docs/docs/Deployment/deployment-enterprise-database.mdx Outdated
Comment thread docs/docs/Deployment/deployment-enterprise-database.mdx Outdated
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 29, 2025
@SonicDMG SonicDMG temporarily deployed to docs-lfoss-1579-kubernetes-and-dba - langflow-manual-install PR #9226 July 29, 2025 16:09 — with Render Destroyed
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 29, 2025
@SonicDMG SonicDMG temporarily deployed to docs-lfoss-1579-kubernetes-and-dba - langflow-manual-install PR #9226 July 29, 2025 16:10 — with Render Destroyed
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 29, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 29, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 29, 2025
@github-actions

This comment was marked as resolved.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 1, 2025
@github-actions

This comment was marked as resolved.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 1, 2025
@github-actions

This comment was marked as resolved.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 1, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 1, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 1, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 1, 2025
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Aug 1, 2025

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@aimurphy aimurphy added this pull request to the merge queue Aug 1, 2025
Merged via the queue into main with commit 21f678d Aug 1, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants