[GitHub] lburgazzoli closed pull request #20: CAMEL-12798: Add getting started guide
lburgazzoli closed pull request #20: CAMEL-12798: Add getting started guide
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/README.md b/README.md
index 8b8c432..b360da8 100644
@@ -2,7 +2,74 @@
Apache Camel K (a.k.a. Kamel) is a lightweight integration framework built from Apache Camel that runs natively on Kubernetes and is specifically designed for serverless and microservice architectures.
+## Getting Started
+You can run Camel K integrations on a Kubernetes or Openshift cluster, so you can choose to create a development cluster or use a cloud instance
+for Camel K.
+### Creating a Development Cluster
+There are various options for creating a development cluster:
+You can run Camel K integrations on Openshift using the Minishift cluster creation tool.
+Follow the instructions in the [getting started guide](https://github.com/minishift/minishift#getting-started) for the installation.
+After installing the `minishift` binary, you need to enable the `admin-user` addon:
+minishift addons enable admin-user
+Then you can start the cluster with:
+Minikube and Kubernetes are not yet supported (but support is coming soon).
+### Setting Up the Cluster
+To start using Camel K you need the **"kamel"** binary, that can be used to both configure the cluster and run integrations.
+There's currently no release channel for the "kamel" binary, so you need to **build it from source!** Refer to the [building section](#building)
+for information on how to do it.
+Once you have the "kamel" binary, log into your cluster using the "oc" or "kubectl" tool and execute the following command to install Camel K:
+This will configure the cluster with the Camel K custom resource definitions and install the operator on the current namespace.
+**Note:** Custom Resource Definitions (CRD) are cluster-wide objects and you need admin rights to install them. Fortunately this
+operation can be done once per cluster. So, if the `kamel install` operation fails, you'll be asked to repeat it when logged as admin.
+For Minishift, this means executing `oc login -u system:admin` before first-time installation only.
+### Running a Integration
+After the initial setup, you can run a Camel integration on the cluster executing:
+kamel run Sample.java
+A "Sample.java" file is included in the root of this repository. You can change the content of the file and execute the command again to see the changes.
+### Monitoring the Status
+Camel K integrations follow a lifecycle composed of several steps before getting into the `Running` state.
+You can check the status of all integrations by executing the following command:
In order to build the project follow these steps:
- this project is supposed to be cloned in `$GOPATH/src/github.com/apache/camel-k`
diff --git a/build/Makefile b/build/Makefile
index 0aad657..ce662c1 100644
@@ -22,6 +22,7 @@ clean:
rm -f camel-k-operator
rm -f kamel
+ rm -rf tmp/_maven_output
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
Apache Git Services