feat: deploy langflow using langchain-serve (#307)

.github/workflows/release.yml

@@ -47,3 +47,11 @@ jobs:
           POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}
         run: |
           poetry publish
+
+      - name: Trigger build and push on langchain-serve
+        uses: peter-evans/repository-dispatch@v2
+        with:
+          token: ${{ secrets.SERVE_GITHUB_TOKEN }}
+          repository: jina-ai/langchain-serve
+          event-type: langflow-push
+          client-payload: '{"push_token": "${{ secrets.LCSERVE_PUSH_TOKEN }}", "branch": "dev"}'

Makefile

@@ -46,6 +46,17 @@ build:
 	poetry build --format sdist
 	rm -rf src/backend/langflow/frontend
 
+lcserve_push:
+	make build_frontend
+	@version=$$(poetry version --short); \
+	lc-serve push --app langflow.lcserve:app --app-dir . \
+		--image-name langflow --image-tag $${version} --verbose
+
+lcserve_deploy:
+	@:$(if $(uses),,$(error `uses` is not set. Please run `make uses=... lcserve_deploy`))
+	lc-serve deploy jcloud --app langflow.lcserve:app --app-dir . \
+		--uses $(uses) --config src/backend/langflow/jcloud.yml --verbose
+
 dev:
 	make install_frontend
 ifeq ($(build),1)

README.md

@@ -46,13 +46,98 @@ Alternatively, click the **"Open in Cloud Shell"** button below to launch Google
 [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/logspace-ai/langflow&working_dir=scripts&shellonly=true&tutorial=walkthroughtutorial_spot.md)
 
 
-### Deploy Langflow on Google Cloud Platform
+### Deploy Langflow on [Jina AI Cloud](https://github.com/jina-ai/langchain-serve)
 
-Follow our step-by-step guide to deploy Langflow on Google Cloud Platform (GCP) using Google Cloud Shell. The guide is available in the [**Langflow in Google Cloud Platform**](GCP_DEPLOYMENT.md) document.
+Langflow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud.
 
-Alternatively, click the **"Open in Cloud Shell"** button below to launch Google Cloud Shell, clone the Langflow repository, and start an **interactive tutorial** that will guide you through the process of setting up the necessary resources and deploying Langflow on your GCP project.
+Start by installing `langchain-serve` with 
 
-[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/genome21/langflow&working_dir=scripts&shellonly=true&tutorial=walkthroughtutorial_spot.md)
+```bash
+pip install -U langchain-serve
+``` 
+
+Then, run:
+
+```bash
+langflow --jcloud
+```
+
+```text
+🎉 Langflow server successfully deployed on Jina AI Cloud 🎉
+🔗 Click on the link to open the server (please allow ~1-2 minutes for the server to startup): https://<your-app>.wolf.jina.ai/
+📖 Read more about managing the server: https://github.com/jina-ai/langchain-serve
+```
+
+  <details>
+  <summary>Show complete (example) output</summary>
+
+  ```text
+    🚀 Deploying Langflow server on Jina AI Cloud
+    ╭───────────────────────── 🎉 Flow is available! ──────────────────────────╮
+    │                                                                          │
+    │   ID                    langflow-e3dd8820ec                              │
+    │   Gateway (Websocket)   wss://langflow-e3dd8820ec.wolf.jina.ai           │
+    │   Dashboard             https://dashboard.wolf.jina.ai/flow/e3dd8820ec   │
+    │                                                                          │
+    ╰──────────────────────────────────────────────────────────────────────────╯
+    ╭──────────────┬──────────────────────────────────────────────────────────────────────────────╮
+    │ App ID       │                     langflow-e3dd8820ec                                      │
+    ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+    │ Phase        │                            Serving                                           │
+    ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+    │ Endpoint     │          wss://langflow-e3dd8820ec.wolf.jina.ai                              │
+    ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+    │ App logs     │                  dashboards.wolf.jina.ai                                     │
+    ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+    │ Swagger UI   │          https://langflow-e3dd8820ec.wolf.jina.ai/docs                       │
+    ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+    │ OpenAPI JSON │        https://langflow-e3dd8820ec.wolf.jina.ai/openapi.json                 │
+    ╰──────────────┴──────────────────────────────────────────────────────────────────────────────╯
+
+    🎉 Langflow server successfully deployed on Jina AI Cloud 🎉
+    🔗 Click on the link to open the server (please allow ~1-2 minutes for the server to startup): https://langflow-e3dd8820ec.wolf.jina.ai/
+    📖 Read more about managing the server: https://github.com/jina-ai/langchain-serve
+  ```
+
+  </details>
+
+#### API Usage
+
+You can use Langflow directly on your browser, or use the API endpoints on Jina AI Cloud to interact with the server.
+
+  <details>
+  <summary>Show API usage (with python)</summary>
+
+  ```python
+  import json
+  import requests
+
+  FLOW_PATH = "Time_traveller.json"
+
+  # HOST = 'http://localhost:7860'
+  HOST = 'https://langflow-f1ed20e309.wolf.jina.ai'
+  API_URL = f'{HOST}/predict'
+
+  def predict(message):
+      with open(FLOW_PATH, "r") as f:
+          json_data = json.load(f)
+      payload = {'exported_flow': json_data, 'message': message}
+      response = requests.post(API_URL, json=payload)
+      return response.json()
+
+
+  predict('Take me to 1920s Bangalore')
+  ```
+
+  ```json
+  {
+    "result": "Great choice! Bangalore in the 1920s was a vibrant city with a rich cultural and political scene. Here are some suggestions for things to see and do:\n\n1. Visit the Bangalore Palace - built in 1887, this stunning palace is a perfect example of Tudor-style architecture. It was home to the Maharaja of Mysore and is now open to the public.\n\n2. Attend a performance at the Ravindra Kalakshetra - this cultural center was built in the 1920s and is still a popular venue for music and dance performances.\n\n3. Explore the neighborhoods of Basavanagudi and Malleswaram - both of these areas have retained much of their old-world charm and are great places to walk around and soak up the atmosphere.\n\n4. Check out the Bangalore Club - founded in 1868, this exclusive social club was a favorite haunt of the British expat community in the 1920s.\n\n5. Attend a meeting of the Indian National Congress - founded in 1885, the INC was a major force in the Indian independence movement and held many meetings and rallies in Bangalore in the 1920s.\n\nHope you enjoy your trip to 1920s Bangalore!"
+  }
+  ```
+
+  </details>
+
+> Read more about resource customization, cost, and management of Langflow apps on Jina AI Cloud in the **[langchain-serve](https://github.com/jina-ai/langchain-serve)** repository.
 
 
 ## 🎨 Creating Flows

lcserve.Dockerfile

@@ -0,0 +1,16 @@
+# This file is used by `lc-serve` to build the image. 
+# Don't change the name of this file.
+
+FROM jinawolf/serving-gateway:${version}
+
+RUN apt-get update \
+    && apt-get install --no-install-recommends -y build-essential libpq-dev
+
+COPY . /appdir/
+
+RUN pip install poetry==1.4.0 && cd /appdir && pip install . && \
+    pip uninstall -y poetry && \
+    apt-get remove --auto-remove -y build-essential libpq-dev && \
+    apt-get autoremove && apt-get clean && rm -rf /var/lib/apt/lists/* && rm -rf /tmp/*
+
+ENTRYPOINT [ "jina", "gateway", "--uses", "config.yml" ]

pyproject.toml

@@ -51,6 +51,7 @@ websockets = "^11.0.2"
 tiktoken = "^0.3.3"
 wikipedia = "^1.4.0"
 gptcache = "^0.1.23"
+langchain-serve = { version = "^0.0.33", optional = true }
 
 [tool.poetry.group.dev.dependencies]
 black = "^23.1.0"
@@ -66,6 +67,9 @@ pandas-stubs = "^2.0.0.230412"
 types-pillow = "^9.5.0.2"
 
 
+[tool.poetry.extras]
+deploy = ["langchain-serve"]
+
 [tool.ruff]
 line-length = 120
 

src/backend/langflow/__main__.py

@@ -33,11 +33,15 @@ def serve(
     config: str = typer.Option("config.yaml", help="Path to the configuration file."),
     log_level: str = typer.Option("info", help="Logging level."),
     log_file: Path = typer.Option("logs/langflow.log", help="Path to the log file."),
+    jcloud: bool = typer.Option(False, help="Deploy on Jina AI Cloud"),
 ):
     """
     Run the Langflow server.
     """
 
+    if jcloud:
+        return serve_on_jcloud()
+
     configure(log_level=log_level, log_file=log_file)
     update_settings(config)
     app = create_app()
@@ -69,6 +73,51 @@ def serve(
         LangflowApplication(app, options).run()
 
 
+def serve_on_jcloud():
+    """
+    Deploy Langflow server on Jina AI Cloud
+    """
+    import asyncio
+    from importlib.metadata import version as mod_version
+
+    import click
+
+    try:
+        from lcserve.__main__ import serve_on_jcloud  # type: ignore
+    except ImportError:
+        click.secho(
+            "🚨 Please install langchain-serve to deploy Langflow server on Jina AI Cloud using `pip install langchain-serve`",
+            fg="red",
+        )
+        return
+
+    app_name = "langflow.lcserve:app"
+    app_dir = str(Path(__file__).parent)
+    version = mod_version("langflow")
+    base_image = "jinaai+docker://deepankarm/langflow"
+
+    click.echo("🚀 Deploying Langflow server on Jina AI Cloud")
+    app_id = asyncio.run(
+        serve_on_jcloud(
+            fastapi_app_str=app_name,
+            app_dir=app_dir,
+            uses=f"{base_image}:{version}",
+            name="langflow",
+        )
+    )
+    click.secho(
+        "🎉 Langflow server successfully deployed on Jina AI Cloud 🎉", fg="green"
+    )
+    click.secho(
+        "🔗 Click on the link to open the server (please allow ~1-2 minutes for the server to startup): ",
+        nl=False,
+        fg="green",
+    )
+    click.secho(f"https://{app_id}.wolf.jina.ai/", fg="blue")
+    click.secho("📖 Read more about managing the server: ", nl=False, fg="green")
+    click.secho("https://github.com/jina-ai/langchain-serve", fg="blue")
+
+
 def main():
     app()
 

src/backend/langflow/jcloud.yml

@@ -0,0 +1,2 @@
+instance: C4
+autoscale_min: 1

src/backend/langflow/lcserve.py

@@ -0,0 +1,14 @@
+# This file is used by lc-serve to load the mounted app and serve it.
+
+from pathlib import Path
+from fastapi.staticfiles import StaticFiles
+from langflow.main import create_app
+
+app = create_app()
+path = Path(__file__).parent
+static_files_dir = path / "frontend"
+app.mount(
+    "/",
+    StaticFiles(directory=static_files_dir, html=True),
+    name="static",
+)