Skip to content

Commit 55e626d

Browse files
docs: fix code formatting on deployment docs (#118)
## Testing Ran `docs dev`: <img width="735" height="676" alt="Screenshot 2025-08-05 at 11 25 59 AM" src="https://github.com/user-attachments/assets/115cb117-b117-4de5-ab15-8068d0e66c44" /> <img width="891" height="686" alt="Screenshot 2025-08-05 at 11 26 12 AM" src="https://github.com/user-attachments/assets/9a040774-04e3-4961-b69f-3e3c6adfa9a9" />
1 parent b8cb5aa commit 55e626d

File tree

2 files changed

+45
-27
lines changed

2 files changed

+45
-27
lines changed

src/langgraph-platform/deploy-hybrid.mdx

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,35 +19,45 @@ Before deploying, review the [conceptual guide for the Hybrid](/langgraph-platfo
1919
### Prerequisites
2020

2121
1. `KEDA` is installed on your cluster.
22+
```bash
2223
helm repo add kedacore https://kedacore.github.io/charts
2324
helm install keda kedacore/keda --namespace keda --create-namespace
25+
```
2426
2. A valid `Ingress` controller is installed on your cluster.
2527
3. You have slack space in your cluster for multiple deployments. `Cluster-Autoscaler` is recommended to automatically provision new nodes.
2628
4. You will need to enable egress to two control plane URLs. The listener polls these endpoints for deployments:
27-
https://api.host.langchain.com
28-
https://api.smith.langchain.com
29+
- https://api.host.langchain.com
30+
- https://api.smith.langchain.com
2931

3032
### Setup
3133

3234
1. You give us your LangSmith organization ID. We will enable the Self-Hosted Data Plane for your organization.
3335
2. We provide you a [Helm chart](https://github.com/langchain-ai/helm/tree/main/charts/langgraph-dataplane) which you run to setup your Kubernetes cluster. This chart contains a few important components.
34-
1. `langgraph-listener`: This is a service that listens to LangChain's [control plane](/langgraph-platform/control-plane) for changes to your deployments and creates/updates downstream CRDs.
35-
2. `LangGraphPlatform CRD`: A CRD for LangGraph Platform deployments. This contains the spec for managing an instance of a LangGraph Platform deployment.
36-
3. `langgraph-platform-operator`: This operator handles changes to your LangGraph Platform CRDs.
36+
1. `langgraph-listener`: This is a service that listens to LangChain's [control plane](/langgraph-platform/control-plane) for changes to your deployments and creates/updates downstream CRDs.
37+
2. `LangGraphPlatform CRD`: A CRD for LangGraph Platform deployments. This contains the spec for managing an instance of a LangGraph Platform deployment.
38+
3. `langgraph-platform-operator`: This operator handles changes to your LangGraph Platform CRDs.
3739
3. Configure your `langgraph-dataplane-values.yaml` file.
40+
```bash
3841
config:
39-
langsmithApiKey: "" # API Key of your Workspace
40-
langsmithWorkspaceId: "" # Workspace ID
41-
hostBackendUrl: "https://api.host.langchain.com" # Only override this if on EU
42-
smithBackendUrl: "https://api.smith.langchain.com" # Only override this if on EU
42+
langsmithApiKey: "" # API Key of your Workspace
43+
langsmithWorkspaceId: "" # Workspace ID
44+
hostBackendUrl: "https://api.host.langchain.com" # Only override this if on EU
45+
smithBackendUrl: "https://api.smith.langchain.com" # Only override this if on EU
46+
```
4347
4. Deploy `langgraph-dataplane` Helm chart.
48+
```bash
4449
helm repo add langchain https://github.com/langchain-ai/helm
4550
helm repo update
46-
helm upgrade -i langgraph-dataplane langchain/langgraph-dataplane --values langgraph-dataplane-values.yaml
47-
5. If successful, you will see two services start up in your namespace.
48-
NAME READY STATUS RESTARTS AGE
49-
langgraph-dataplane-listener-7fccd788-wn2dx 0/1 Running 0 9s
50-
langgraph-dataplane-redis-0 0/1 ContainerCreating 0 9s
51+
helm upgrade -i langgraph-dataplane langchain/langgraph-dataplane --values langgraph-dataplane-values.yaml --wait --debug
52+
```
53+
5. If successful, you will see three services start up in your namespace.
54+
```bash
55+
NAME READY STATUS RESTARTS AGE
56+
langgraph-dataplane-listener-6dd4749445-zjmr4 0/1 ContainerCreating 0 26s
57+
langgraph-dataplane-operator-6b88879f9b-t76gk 1/1 Running 0 26s
58+
langgraph-dataplane-redis-0 1/1 Running 0 25s
59+
```
60+
5161
6. You create a deployment from the [control plane UI](/langgraph-platform/control-plane#control-plane-ui).
5262

5363
## Amazon ECS

src/langgraph-platform/deploy-self-hosted-full-platform.mdx

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,43 @@ Before deploying, review the [conceptual guide for the Self-Hosted Full Platform
1616
3. Use the [LangGraph CLI](/langgraph-platform/langgraph-cli) to [test your application locally](/langgraph-platform/local-server).
1717
4. Use the [LangGraph CLI](/langgraph-platform/langgraph-cli) to build a Docker image (i.e. `langgraph build`) and push it to a registry your Kubernetes cluster has access to.
1818
5. `KEDA` is installed on your cluster.
19+
```bash
1920
helm repo add kedacore https://kedacore.github.io/charts
2021
helm install keda kedacore/keda --namespace keda --create-namespace
22+
```
2123
6. Ingress Configuration
22-
1. You must set up an ingress for your LangSmith instance. All agents will be deployed as Kubernetes services behind this ingress.
23-
2. You can use this guide to [set up an ingress](https://docs.smith.langchain.com/self_hosting/configuration/ingress) for your instance.
24+
1. You must set up an ingress for your LangSmith instance. All agents will be deployed as Kubernetes services behind this ingress.
25+
2. You can use this guide to [set up an ingress](https://docs.smith.langchain.com/self_hosting/configuration/ingress) for your instance.
2426
7. You have slack space in your cluster for multiple deployments. `Cluster-Autoscaler` is recommended to automatically provision new nodes.
2527
8. A valid Dynamic PV provisioner or PVs available on your cluster. You can verify this by running:
28+
```bash
2629
kubectl get storageclass
30+
```
2731
9. Egress to `https://beacon.langchain.com` from your network. This is required for license verification and usage reporting if not running in air-gapped mode. See the [Egress documentation](/langgraph-platform/egress-metrics-metadata) for more details.
2832

2933
## Setup
3034

3135
1. As part of configuring your Self-Hosted LangSmith instance, you enable the `langgraphPlatform` option. This will provision a few key resources.
32-
1. `listener`: This is a service that listens to the [control plane](/langgraph-platform/control-plane) for changes to your deployments and creates/updates downstream CRDs.
33-
2. `LangGraphPlatform CRD`: A CRD for LangGraph Platform deployments. This contains the spec for managing an instance of a LangGraph platform deployment.
34-
3. `operator`: This operator handles changes to your LangGraph Platform CRDs.
35-
4. `host-backend`: This is the [control plane](/langgraph-platform/control-plane).
36+
1. `listener`: This is a service that listens to the [control plane](/langgraph-platform/control-plane) for changes to your deployments and creates/updates downstream CRDs.
37+
2. `LangGraphPlatform CRD`: A CRD for LangGraph Platform deployments. This contains the spec for managing an instance of a LangGraph platform deployment.
38+
3. `operator`: This operator handles changes to your LangGraph Platform CRDs.
39+
4. `host-backend`: This is the [control plane](/langgraph-platform/control-plane).
3640
2. Two additional images will be used by the chart. Use the images that are specified in the latest release.
41+
```bash
3742
hostBackendImage:
38-
repository: "docker.io/langchain/hosted-langserve-backend"
39-
pullPolicy: IfNotPresent
43+
repository: "docker.io/langchain/hosted-langserve-backend"
44+
pullPolicy: IfNotPresent
4045
operatorImage:
41-
repository: "docker.io/langchain/langgraph-operator"
42-
pullPolicy: IfNotPresent
46+
repository: "docker.io/langchain/langgraph-operator"
47+
pullPolicy: IfNotPresent
48+
```
4349
3. In your config file for langsmith (usually `langsmith_config.yaml`), enable the `langgraphPlatform` option. Note that you must also have a valid ingress setup:
50+
```bash
4451
config:
45-
langgraphPlatform:
46-
enabled: true
47-
langgraphPlatformLicenseKey: "YOUR_LANGGRAPH_PLATFORM_LICENSE_KEY"
52+
langgraphPlatform:
53+
enabled: true
54+
langgraphPlatformLicenseKey: "YOUR_LANGGRAPH_PLATFORM_LICENSE_KEY"
55+
```
4856
4. In your `values.yaml` file, configure the `hostBackendImage` and `operatorImage` options (if you need to mirror images)
4957
5. You can also configure base templates for your agents by overriding the base templates [here](https://github.com/langchain-ai/helm/blob/main/charts/langsmith/values.yaml#L898).
5058
6. You create a deployment from the [control plane UI](/langgraph-platform/control-plane#control-plane-ui).

0 commit comments

Comments
 (0)