commit | 4b678fc9579224afb6875bcdbd8fc10933b7dedf | [log] [tgz] |
---|---|---|
author | Kuthumi Pepple <kuthumipepple@gmail.com> | Thu Jul 07 00:24:14 2022 +0100 |
committer | Andrea Cosentino <ancosen@gmail.com> | Fri Jul 15 15:13:25 2022 +0200 |
tree | 8a7a9d9568d1a9584c8f31809137d8c7f4e9a326 | |
parent | d40652ce9e225a08c90dc5c64979ef430db0f200 [diff] |
update generic-examples/README.md
This repository contains a collection of Camel K examples useful to understand how it works, common use cases and the idiomatic programming model.
You can find more information about Apache Camel and Apache Camel K on the official Camel website.
To better work on all examples, make sure you have all them locally by checking out the git repository:
git clone git@github.com:apache/camel-k-examples.git
We suggest you to open the examples with VSCode because it provides useful extensions for working with Camel K files. If you've already installed it on your machine, after cloning the repository, you can open the examples on the IDE executing:
code camel-k-examples
We suggest you to install the following extensions for VSCode (The IDE should automatically prompt to ask you to install them):
All examples require that you are connected to a Kubernetes/OpenShift cluster, even a local instance such as Minikube or CRC. Some advanced examples may have additional requirements.
Ensure that you've followed the Camel K installation guide for your specific cluster before looking at the examples.
All examples need at least the following CLI tools installed on your system:
kubectl
: the Kubernetes default CLI tool that can be downloaded from the Kubernetes releases page.kamel
: the Apache Camel K CLI that can be downloaded from the Camel K release page.We are providing also a folder containing multiple generic examples in Generic Examples folder.
In the Kamelets folder, you'll get a set of examples based on Kamelets.
Examples are contained in directories ordered by level of difficulty.
Most examples provide a readme.didact.md
file instead of the standard readme file. For those, if you're using VSCode with Didact installed, you can right click on the readme.didact.md
file and hit “Didact: Start Didact Tutorial from File”.
This is the current list of examples: