n8n Docker API Backend Deployment Workflow

This n8n workflow provides a robust and flexible solution for deploying and managing a Docker API backend. It acts as a central control point, allowing you to trigger deployments, execute commands, and receive structured responses, all through a simple webhook.

What it does

This workflow automates the following steps:

1. Listens for a Webhook Trigger: The workflow starts by listening for incoming HTTP POST requests to a defined webhook URL. This acts as the entry point for triggering deployment actions.
2. Conditional Routing (If): It then uses an "If" node to evaluate conditions based on the incoming webhook data. This allows for dynamic routing of the workflow based on specific criteria (e.g., different deployment environments, specific commands).
3. Data Transformation (Edit Fields): An "Edit Fields (Set)" node is used to manipulate or prepare the data received from the webhook. This could involve extracting specific parameters, setting default values, or reformatting the payload for subsequent steps.
4. Multi-path Conditional Logic (Switch): A "Switch" node provides more advanced conditional routing, enabling the workflow to execute different branches of logic based on various values within the processed data. This is useful for handling multiple distinct deployment scenarios or commands.
5. Remote Command Execution (SSH): The "SSH" node is designed to connect to a remote server and execute commands. This is the core component for interacting with your Docker environment, allowing you to run docker-compose up, docker pull, or any other necessary shell commands.
6. Custom Logic (Code): A "Code" node allows for the execution of custom JavaScript code. This provides extreme flexibility for complex data manipulation, custom validations, or generating dynamic commands before executing them via SSH.
7. Responds to Webhook: Finally, the "Respond to Webhook" node sends a custom response back to the caller of the initial webhook, providing feedback on the execution status or results of the deployment.
8. Informational Notes (Sticky Note): A "Sticky Note" is included for documentation within the workflow itself, likely containing important instructions or context for maintainers.

Prerequisites/Requirements

To use this workflow, you will need:

• n8n Instance: A running n8n instance to host this workflow.
• SSH Credentials: SSH credentials (private key or password) configured in n8n to connect to your Docker host server.
• Docker Host Server: A remote server with Docker and Docker Compose installed, accessible via SSH.
• Webhook Caller: An application or service capable of sending HTTP POST requests to the n8n webhook URL.

Setup/Usage

1. Import the Workflow: Import the provided JSON into your n8n instance.
2. Configure Webhook:
   • Activate the "Webhook" trigger node.
   • Copy the generated webhook URL. This is the endpoint you will send requests to.
3. Configure SSH Credentials:
   • Open the "SSH" node.
   • Select or create new SSH credentials within n8n that can connect to your Docker host.
   • Ensure the SSH user has the necessary permissions to execute Docker commands.
4. Customize Logic:
   • If Node: Adjust the conditions in the "If" node (node ID 20) to match your desired routing logic based on incoming webhook data.
   • Edit Fields Node: Modify the "Edit Fields" node (node ID 38) to transform the incoming data as needed.
   • Switch Node: Configure the "Switch" node (node ID 112) to handle different cases for your deployment scenarios.
   • Code Node: Implement your custom JavaScript logic in the "Code" node (node ID 834) for advanced processing or command generation.
   • SSH Node: Configure the commands to be executed on your Docker host within the "SSH" node (node ID 490). This is where you'll define your docker-compose commands or other deployment scripts.
   • Respond to Webhook: Customize the response sent by the "Respond to Webhook" node (node ID 535) to provide meaningful feedback to the caller.
5. Activate Workflow: Set the workflow to "Active" in n8n.
6. Trigger Deployment: Send an HTTP POST request to the webhook URL with the appropriate payload to trigger your deployment logic.