chore: update hybrid deployment documentation #1315
Conversation
hari-dhanushkodi
requested review from
andrewnguonly and
Copilot
and removed request for
Copilot and
katmayb
katmayb
left a comment
katmayb
left a comment
There was a problem hiding this comment.
lgtm from a docs perpective @hari-dhanushkodi! I merged a new section on the self-hosted-full-platform page yesterday where you have placed yours, so you'll have to resolve that conflict — Feel free to order your new optional section and the one I added, how you think is best.
| </Info> | ||
| 3. A [Helm chart](https://github.com/langchain-ai/helm/tree/main/charts/langgraph-dataplane) is provided to install the necesssary components in your Kubernetes cluster. | ||
| - `langgraph-listener`: This is a service that listens to LangChain's [control plane](/langsmith/control-plane) for changes to your deployments and creates/updates downstream CRDs. This is the ["listener" application](/langsmith/data-plane#”listener”-application). | ||
| - `langgraph-dataplane-listener`: This is a service that listens to LangChain's [control plane](/langsmith/control-plane) for changes to your deployments and creates/updates downstream CRDs. This is the ["listener" application](/langsmith/data-plane#”listener”-application). |
There was a problem hiding this comment.
Side question: Is this deployment still called langgraph-dataplane-listener? Or did we change it to langgsmith-dataplane-listener?
There was a problem hiding this comment.
looks like it is still langgraph-dataplane-listener
src/langsmith/deploy-hybrid.mdx
Outdated
| - `config.enableLGPDeploymentHealthCheck`: To disable the Agent Server health check, set this to `false`. | ||
| - `ingress.hostname`: As part of the deployment workflow, the `langgraph-listener` deployment attempts to call the Agent Server health check endpoint (`GET /ok`) to verify that the application has started up correctly. A typical setup involves creating a shared DNS record or domain for Agent Server deployments. This is not managed by LangSmith. Once created, set `ingress.hostname` to the domain, which will be used to complete the health check. | ||
| - `operator.enabled`: There can only be 1 instance of the `langgraph-platform-operator` deployed in a Kubernetes namespace. Set this to `false` if there is already an instance of `langgraph-platform-operator` deployed in the current Kubernetes namespace. | ||
| - `operator.enabled`: There can only be 1 instance of the `langgraph-platform-operator` deployed in a Kubernetes namespace. Set this to `false` if there is already an instance of `langgraph-platform-operator` deployed in the current Kubernetes namespace. This should only be relevant if you plan to have multiple installations watch the same namespace. |
There was a problem hiding this comment.
Feedback: installations <-- Can we be more literal here? What does installations refer to?
There was a problem hiding this comment.
actually ended up removing this.. based on these docs, we do not want people touching the operator.enabled option (this leads to so many issues). Instead, we state the invariant that watch namespaces should never intersect
| In addition to the existing data plane already created in the above steps, you can create more data planes that reside in different Kubernetes clusters. | ||
|
|
||
| 1. Read through the cluster organization guide in the [hybrid deployment documentation](/langsmith/hybrid#listeners) to understand how to best organize this. | ||
| 2. Verify the prerequisites mentioned in the [hybrid](/langsmith/deploy-hybrid#prerequisites) section are met for the new cluster. Note that for step 5, you need to enable egress to your [self-hosted LangSmith instance](/langsmith/self-host-usage#configuring-the-application-you-want-to-use-with-langsmith) instead of the managed control plane. |
There was a problem hiding this comment.
Feedback: What does step 5 refer to? Any way to be more targeted/specific?
There was a problem hiding this comment.
added a link to the step
|
|
||
| 1. Read through the cluster organization guide in the [hybrid deployment documentation](/langsmith/hybrid#listeners) to understand how to best organize this. | ||
| 2. Verify the prerequisites mentioned in the [hybrid](/langsmith/deploy-hybrid#prerequisites) section are met for the new cluster. Note that for step 5, you need to enable egress to your [self-hosted LangSmith instance](/langsmith/self-host-usage#configuring-the-application-you-want-to-use-with-langsmith) instead of the managed control plane. | ||
| 3. Run the following commands against your LangSmith postgres instance to enable this feature: |
There was a problem hiding this comment.
Suggestion: LangSmith postgres <-- Even this might be ambiguous. People get confused about all the different Postgres instances we create. How can we make this unambiguous? Should we reference langchainplusdb or whatever it's actually called?
There was a problem hiding this comment.
added an additional sentence and another link to disambiguate
|
Mintlify preview ID generated: preview-hd2025-1762991532-0eb5ec2 |
Overview
Updating the listener/hybrid docs after many support cases with customers. Adding the following:
Checklist
docs devsrc/docs.jsonif neededAdditional notes