Comment on page
Application structure
A LangStream application is composed of multiple yaml manifests. Each manifest complements the others to create a data processing environment. You will typically use the LangStream CLI to interact with the Kubernetes control plane.
Your development environment should follow a specific folder structure:
- At the root there should be instance.yaml and optionally a secrets.yaml. These files cannot be in the "application" directory, which is passed as a zip at runtime.
- The root should also contain a directory for the application files. We typically name this “application”.
- The “application” directory should contain a pipeline.yaml, and optionally a configuration.yaml and gateways.yaml.
The hierarchy should look like this:
|- project-folder
|- application
|- pipeline.yaml
|- gateways.yaml
|- configuration.yaml
|- instance.yaml
|- secrets.yaml (optional)
This application would be deployed out of the project-folder directory with:
langstream apps deploy sample-app -app ./application -i ./instance.yaml -s ./secrets.yaml
Want to get started a little quicker? Check out the LangStream VSCode Extension for pre-made applications and agent code snippets.
This is referred to as the “application directory” because the main pipeline and its configuration are declared within.
- pipeline.yaml: this is the declaration of topics and pipeline steps. It is required. Learn more about building pipelines.
- configuration.yaml: this is the declaration of additional services a step in the pipeline depends on. It is optional. Learn more about configurations.
The instance is a declaration of the application’s processing infrastructure. This includes where “streaming” is processed and where “compute” takes place. This is a required value. Learn more about instances.
Typically the values for an instance are specific to the environment running the application. As you promote the application off of your desktop to higher environments, other instance files may be needed. In this case, it is recommended to add a suffix to the file name, representing the environment it is configured for. A few examples:
Environment: local
Filename: instance-local.yaml
Environment: staging
Filename: instance-staging.yaml
Environment: production
Filename: instance-production.yaml
This is a holder for secrets used within pipeline steps, configuration dependencies, and instance declarations. It is an optional value.
Secrets are held separately to create a separation of information. It’s not a good practice to hard code tokens in pipeline manifests. Instead, include a pointer to a secret that is managed in different ways. Learn more about secrets.
Last modified 1mo ago