Skip to main content
Manifests let you define Mixpeek resources in YAML files and apply them in a single operation. This enables version-controlled, reproducible infrastructure across environments.

Quick Start

Every collection needs a source and a feature_extractor; every retriever needs namespace, collections, and its stages pipeline. validate names any missing field, warns on unknown top-level keys (a typo like retreivers: won’t silently drop your search pipeline), and checks that references (namespace, bucket, collection names) resolve within the manifest.

Core Operations

Resource Types

Manifests support these resource types, applied in dependency order:
  1. Namespaces - Isolation boundaries with feature extractors
  2. Buckets - Object storage with schemas
  3. Collections - Document stores with indexing
  4. Taxonomies - Classification hierarchies
  5. Clusters - Grouping configurations
  6. Retrievers - Search pipelines

Secret References

Use ${{ secrets.NAME }} to reference organization secrets:
Secrets must exist before applying. Use the validate endpoint to check for missing secrets.

Dependency Resolution

Resources are created in topological order. The manifest engine:
  • Resolves cross-resource references automatically
  • Detects circular dependencies
  • Rolls back all changes if any creation fails

Workflows

Environment Replication

Pre-deployment Validation

CI/CD Integration

References