Skip to content

n8n Operator Documentation

Welcome to the n8n Operator documentation. This operator automates the deployment and management of n8n workflow automation instances on Kubernetes clusters.

Table of Contents

  1. Installation Guide
  2. Prerequisites
  3. Installation Steps
  4. Project Distribution
  5. Uninstallation

  6. Configuration Guide

  7. Traffic Routing Options
  8. Database Configuration
  9. Persistent Storage
  10. Security Configuration
  11. Complete Configuration Example

  12. API Reference

  13. Custom Resource Definitions
  14. API Specifications

Features

Traffic Routing

  • Support for Kubernetes Ingress
  • Support for Gateway API HTTPRoute
  • Configurable hostnames and TLS

Database Integration

  • PostgreSQL database support
  • Configurable connection parameters
  • SSL support for secure connections

Storage Management

  • Persistent storage configuration
  • Automatic volume provisioning
  • Configurable storage size

Security

  • Non-root container execution
  • Automated TLS configuration
  • Secure database connections

Support

If you encounter any issues or need assistance: 1. Check the documentation sections above 2. Look for similar issues in the GitHub repository 3. Open a new issue if needed

Contributing

We welcome contributions! Please see our Contributing Guide for details on how to: - Submit bug reports - Request features - Submit pull requests - Improve documentation