Chapter 2. Installing Kaoto
Get started by installing Kaoto in your environment!
This guide covers multiple installation options to get you started quickly.
2.1. Overview Copy linkLink copied to clipboard!
Choose the installation method that best fits your needs:
- VS Code Extension - Recommended for local development and testing
- Online Testing Instance - Try Kaoto without installing anything
- Podman - Run Kaoto in a containerized environment
2.2. Using Online Testing Instance Copy linkLink copied to clipboard!
The fastest way to try Kaoto is through our openly available testing instance.
Perfect for:
- Quick evaluation and testing
- Following our workshops as guides
- Learning Kaoto basics without local setup
Next steps:
- Learn more about how to use Kaoto in the Quickstart
- Explore our workshops for hands-on tutorials
2.3. Using Visual Studio Code Copy linkLink copied to clipboard!
The VS Code extension provides the most complete Kaoto experience with local development capabilities.
2.3.1. Prerequisites Copy linkLink copied to clipboard!
Before installing the Kaoto extension, ensure you have:
- Visual Studio Code - The code editor
JBang - Required for running Camel integrations locally
macOS/Linux:
curl -Ls https://sh.jbang.dev | bash -s - trust add https://github.com/apache/camelWindows:
curl -Ls https://sh.jbang.dev | bash -s - app setup add https://github.com/apache/camel
Verify the installation
jbang version
JBang is the only hard requirement. The Kaoto extension will automatically install Camel CLI, and other required dependencies as needed during extension installation and first use.
2.3.2. Installing the Kaoto VS Code Extension Copy linkLink copied to clipboard!
The Kaoto extension provides all the required functionality to create and run your integrations locally as a standalone extension.
- Open Visual Studio Code
-
Open the Extensions view on the left side panel (or press
Ctrl+Shift+X/Cmd+Shift+X) -
Type
Kaotoin the search field Click the Install button on the Kaoto extension
Result
- Visual designer for Apache Camel routes
- Integrated catalog of Camel components and patterns
- YAML and XML DSL support
- Real-time validation and error checking
2.4. Using Podman Copy linkLink copied to clipboard!
Run Kaoto in a containerized environment using Podman.
2.4.1. Prerequisites Copy linkLink copied to clipboard!
- Podman installed and running.
2.4.2. Installation Steps Copy linkLink copied to clipboard!
Pull the Kaoto image:
podman pull quay.io/kaotoio/kaoto-app:mainRun the container:
podman run -p 8080:8080 quay.io/kaotoio/kaoto-app:mainAccess Kaoto:
- Open your browser and navigate to http://localhost:8080
-
If you used a different port in the
-pparameter, adjust the URL accordingly
2.5. Verifying installation Copy linkLink copied to clipboard!
After installation, verify that Kaoto is working correctly:
2.5.1. Verifying for VS Code Extension Copy linkLink copied to clipboard!
-
Open
VS Code -
Click the
Kaotoicon in the left sidebar -
Create a new
Camel routefile -
You should see the
visual designer interface
2.5.2. Verifying for Podman Copy linkLink copied to clipboard!
- Access http://localhost:8080
-
You should see the
Kaoto web interface - Try creating a simple route to test functionality
2.5.3. Verifying for Online Instance Copy linkLink copied to clipboard!
- Visit https://red.ht/kaoto
- The Kaoto interface should load in your browser
- Try exploring the catalog and creating a test route
2.6. Troubleshooting issues Copy linkLink copied to clipboard!
VS CodeExtension not appearing:- Ensure VS Code is up to date
- Restart VS Code after installation
- Check the Extensions view to confirm installation
JBangnot found:-
Verify JBang is installed:
jbang version - Ensure your PATH includes JBang binaries
-
Verify JBang is installed:
Podmancontainer won’t start:-
Verify Podman is running:
podman ps -
Check if
port 8080is already in use -
Review Podman logs:
podman logs kaoto-app
-
Verify Podman is running:
Javaversion issues:-
Verify Java 17 or later is installed:
java -version -
Set
JAVA_HOMEenvironment variable if needed
-
Verify Java 17 or later is installed:
2.6.1. Getting Help Copy linkLink copied to clipboard!
If you encounter issues:
- Check the Kaoto documentation
- Visit the GitHub Issues page
- Join the Zulip Chat
- Ask in the Discussion Forums
2.7. Additional Resources Copy linkLink copied to clipboard!
2.7.1. Kaoto Resources Copy linkLink copied to clipboard!
- VS Code Kaoto Extension on Marketplace - Download and reviews
- Kaoto GitHub - Main project source code
- VS Code Kaoto GitHub Repository - Extension source code
- Kaoto Examples - Sample integrations and use cases
2.7.2. Apache Camel Resources Copy linkLink copied to clipboard!
- Apache Camel Documentation - Learn about Apache Camel
- Camel JBang Documentation - JBang integration guide
2.7.3. Community Copy linkLink copied to clipboard!
- Community Resources - Get involved with the Kaoto community
- Zulip Chat - Real-time chat support
- Discussion Forums - Community discussions