LangStream Documentation
Langstream.aiLangStream GitHub RepoChangelog
  • LangStream Documentation
  • ❤️Langstream.ai
  • ⭐LangStream GitHub Repo
  • 📜Changelog
  • about
    • What is LangStream?
    • License
  • Get Started
  • installation
    • LangStream CLI
    • Docker
    • Minikube (mini-langstream)
    • Kubernetes
    • Build and install from source
  • Building Applications
    • Vector Databases
    • Application structure
      • Pipelines
      • Instances
      • Configuration
      • Topics
      • Assets
      • Secrets
      • YAML templating
      • Error Handling
      • Stateful agents
      • .langstreamignore
    • Sample App
    • Develop, test and deploy
    • Application Lifecycle
    • Expression Language
    • API Gateways
      • Websocket
      • HTTP
      • Message filtering
      • Gateway authentication
    • API Reference
      • Agents
      • Resources
      • Assets
  • LangStream CLI
    • CLI Commands
    • CLI Configuration
    • Web interface
  • Integrations
    • Large Language Models (LLMs)
      • OpenAI
      • Hugging Face
      • Google Vertex AI
      • Amazon Bedrock
      • Ollama
    • Data storage
      • Astra Vector DB
      • Astra
      • Cassandra
      • Pinecone
      • Milvus
      • Solr
      • JDBC
      • OpenSearch
    • Integrations
      • Apache Kafka Connect
      • Apache Camel
    • LangServe
  • Pipeline Agents
    • Agent Messaging
    • Builtin agents
      • Input & Output
        • webcrawler-source
        • s3-source
        • azure-blob-storage-source
        • sink
        • vector-db-sink
        • camel-source
      • AI Agents
        • ai-chat-completions
        • ai-text-completions
        • compute-ai-embeddings
        • flare-controller
      • Text Processors
        • document-to-json
        • language-detector
        • query
        • query-vector-db
        • re-rank
        • text-normaliser
        • text-extractor
        • text-splitter
        • http-request
      • Data Transform
        • cast
        • compute
        • drop
        • drop-fields
        • merge-key-value
        • unwrap-key-value
      • Flow control
        • dispatch
        • timer-source
        • trigger-event
    • Custom Agents
      • Python sink
      • Python source
      • Python processor
      • Python service
    • Agent Developer Guide
      • Agent Types
      • Agent Creation
      • Configuration and Testing
      • Environment variables
  • Messaging
    • Messaging
      • Apache Pulsar
      • Apache Kafka
      • Pravega.io
  • Patterns
    • RAG pattern
    • FLARE pattern
  • Examples
    • LangServe chatbot
    • LlamaIndex Cassandra sink
Powered by GitBook
On this page
  • Install mini-langstream
  • Start the cluster
  • Your first application
Edit on GitHub
  1. installation

Minikube (mini-langstream)

PreviousDockerNextKubernetes

Last updated 1 year ago

To create a LangStream cluster locally, it's recommended to use - setting 4 CPUs is highly recommended. mini-langstream comes in help for installing and managing your local cluster.

Install mini-langstream

mini-langstream requires the following commands to be already installed:

  • Docker

  • Minikube

  • Helm

  • Kubectl

  • LangStream CLI

If you install mini-langstream using Brew, all the dependencies are automatically installed.

MacOS:

brew install LangStream/langstream/mini-langstream

Unix:

curl -Ls "https://raw.githubusercontent.com/LangStream/langstream/main/mini-langstream/get-mini-langstream.sh" | bash

Start the cluster

mini-langstream will do all the setup for you, in particular:

  • start minikube in a dedicated context

  • deploy LangStream components using helm

  • run a stateful Kafka broker as docker container

  • run a stateful s3-compatible storage (MinIO) as docker container

  • forward the control plane and API Gateways ports locally

  • create a dedicated LangStream CLI profile to interact with the cluster

  • wrap all the common k8s tools to inspect the cluster (mini-langstream kubectl, mini-langstream helm, mini-langstream k9s)

  1. Start or ensure the cluster is running:

mini-langstream start
  1. Try to use the CLI:

mini-langstream cli apps list
  1. Deploy an application:

export OPENAI_API_KEY=<your-openai-api-key>
mini-langstream cli apps deploy my-app -app https://github.com/LangStream/langstream/tree/main/examples/applications/openai-completions -s https://github.com/LangStream/langstream/blob/main/examples/secrets/secrets.yaml

To delete all the storage and stop the cluster:

mini-langstream delete

Your first application

Here are a few ways to get started building LangStream applications:

to quickly create an OpenAI query with LangStream.

and learn how to build the needed manifests

and use the provided starter applications & agent snippets

minikube
Build a sample application
Set up your development environment
Install the VSCode extension