You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by as...@apache.org on 2021/01/26 14:33:48 UTC
[camel-k] branch master updated: doc: local development environment
This is an automated email from the ASF dual-hosted git repository.
astefanutti pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-k.git
The following commit(s) were added to refs/heads/master by this push:
new 3b51630 doc: local development environment
3b51630 is described below
commit 3b5163027cd8077bfd9b67c027a87b6779840041
Author: Pasquale Congiusti <pa...@gmail.com>
AuthorDate: Tue Jan 26 11:30:21 2021 +0100
doc: local development environment
Added a section to instruct how to run a Camel K operator locally.
---
docs/modules/ROOT/nav-end.adoc | 3 +-
.../ROOT/pages/{ => contributing}/developers.adoc | 4 ++
.../ROOT/pages/contributing/local-development.adoc | 59 ++++++++++++++++++++++
3 files changed, 65 insertions(+), 1 deletion(-)
diff --git a/docs/modules/ROOT/nav-end.adoc b/docs/modules/ROOT/nav-end.adoc
index 03d45be..d3c6f62 100644
--- a/docs/modules/ROOT/nav-end.adoc
+++ b/docs/modules/ROOT/nav-end.adoc
@@ -14,4 +14,5 @@
** xref:architecture/traits.adoc[Traits]
** xref:architecture/sources.adoc[Sources]
* xref:uninstalling.adoc[Uninstalling]
-* xref:developers.adoc[Contributing]
+* xref:contributing/developers.adoc[Contributing]
+** xref:contributing/local-development.adoc[Local development]
diff --git a/docs/modules/ROOT/pages/developers.adoc b/docs/modules/ROOT/pages/contributing/developers.adoc
similarity index 97%
rename from docs/modules/ROOT/pages/developers.adoc
rename to docs/modules/ROOT/pages/contributing/developers.adoc
index 2a0cda3..80463ca 100644
--- a/docs/modules/ROOT/pages/developers.adoc
+++ b/docs/modules/ROOT/pages/contributing/developers.adoc
@@ -155,6 +155,10 @@ To add additional dependencies to your routes:
./kamel run -d camel:dns examples/dns.js
----
+[[local-development]]
+== Local development environment
+If you need to develop and test your Camel K operator locally, you can follow the link:local-development.html[local development procedure].
+
[[debugging]]
== Debugging and Running from IDE
diff --git a/docs/modules/ROOT/pages/contributing/local-development.adoc b/docs/modules/ROOT/pages/contributing/local-development.adoc
new file mode 100644
index 0000000..1229590
--- /dev/null
+++ b/docs/modules/ROOT/pages/contributing/local-development.adoc
@@ -0,0 +1,59 @@
+[[development-environment]]
+= Local development environment
+
+If you plan to contribute to Camel K, you will end up needing to run and troubleshoot your operator code locally. Here a guideline that will help you configure your local operator running.
+
+[[local-operator]]
+== Running operator locally
+
+As soon as you build your operator locally you will ask yourself how to test it. The idea is that you execute it locally and instruct it to **watch** a namespace on a Kubernetes cluster (it may be remote or any local environment). Let's use a namespace called ``operator-test``.
+
+* We start by setting the environment variable ``WATCH_NAMESPACE`` with the namespace you'd like your operator to watch.
+----
+export WATCH_NAMESPACE=operator-test
+----
+
+* The next step is to install an ``IntegrationPlatform`` on the cluster namespace. You probably need to tweak the registry parameters in order to be able to authenticate against an image repository (see below paragraph for local repository instructions).
+----
+./kamel install --skip-operator-setup -n operator-test --registry my-registry:5000
+----
+
+* Finally, assuming you've builded your application correctly we can run the operator:
+-----
+./kamel operator
+-----
+
+* Test the local operator by creating a test `Integration`.
+-----
+./kamel run xyz.abc -n operator-test
+-----
+
+IMPORTANT: make sure no other Camel K Operators are watching that namespace, neither you have a global Camel K Operator installed on your cluster.
+
+[[local-minikube]]
+== Local operator and local cluster
+
+If you want to run a local operator togheter with ``Minikube`` you will need an additional step in order to let the local operator being able to push images in the local registry. We need to expose the local registry as described in https://minikube.sigs.k8s.io/docs/handbook/registry/#docker-on-windows[this procedure]:
+
+* Enable the addon registry (this should be already in place):
+----
+minikube addons enable registry
+----
+
+* Get the ``Pod`` name that is in charge to run the registry and proxy the registry 5000 port to be used locally.
+----
+kubectl get pods -n kube-system
+NAME READY STATUS RESTARTS AGE
+...
+registry-fttbv 1/1 Running 40 89d
+...
+
+kubectl port-forward --namespace kube-system registry-fttbv 5000:5000
+----
+
+* Update the ``IntegrationPlatform`` to instruct it to use the ``localhost`` registry:
+----
+./kamel install --skip-operator-setup -n operator-test --registry localhost:5000 --force
+----
+
+A similar procedure may work if you use other local environments. The idea is to expose the docker registry and be able to use it from your local operator.
\ No newline at end of file