This is an automated email from the ASF dual-hosted git repository. acosentino 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 01c7543 add documentation for CRC #1410 new bd79395 Merge pull request #1570 from johnpoth/crc 01c7543 is described below commit 01c7543d7a270d391c177dbddc65d21ff219fee1 Author: John Poth <poth.j...@gmail.com> AuthorDate: Thu Jun 25 17:15:36 2020 +0200 add documentation for CRC #1410 --- docs/modules/ROOT/pages/developers.adoc | 9 +++++++++ docs/modules/ROOT/pages/installation/crc.adoc | 9 +++++++++ docs/modules/ROOT/pages/installation/installation.adoc | 1 + docs/modules/ROOT/pages/uninstalling.adoc | 2 +- 4 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/developers.adoc b/docs/modules/ROOT/pages/developers.adoc index 815e0c2..23a4333 100644 --- a/docs/modules/ROOT/pages/developers.adoc +++ b/docs/modules/ROOT/pages/developers.adoc @@ -141,6 +141,15 @@ make test-integration If you want to install everything you have in your source code and see it running on Kubernetes, you need to run the following command: +=== For Red Hat CodeReady Containers (CRC) + +* You need to have https://docs.docker.com/get-docker/[Docker] installed and running (or connected to a Docker daemon) +* Run `make install-crc`: to build the project and install it in the current namespace on CRC +* You can specify a different namespace with `make install-crc project=myawesomeproject` +* To uninstall Camel K, run `kamel uninstall --all --olm=false` + +The commands assumes you have an already running CRC instance and logged in correctly. + === For Minishift * Run `make install-minishift` (or just `make install`): to build the project and install it in the current namespace on Minishift diff --git a/docs/modules/ROOT/pages/installation/crc.adoc b/docs/modules/ROOT/pages/installation/crc.adoc new file mode 100644 index 0000000..a69ccd3 --- /dev/null +++ b/docs/modules/ROOT/pages/installation/crc.adoc @@ -0,0 +1,9 @@ +[[installation-on-crc]] += Installing Camel K on Red Hat CodeReady Containers (CRC)- OpenShift 4 on your laptop + +You can run Camel K integrations on OpenShift 4 on your laptop using the CodeReady Containers cluster creation tool. +Follow the instructions in the https://code-ready.github.io/crc/[getting started guide] for the installation. + +After https://code-ready.github.io/crc/#setting-up-codeready-containers_gsg[setting up] and https://code-ready.github.io/crc/#starting-the-virtual-machine_gsg[starting] the cluster you will need to login with the `kubeadmin` user as shown in the startup logs (or setting up a user with sufficient permissions). + +You can now proceed with the xref:installation/installation.adoc#procedure[standard Camel K installation procedure]. diff --git a/docs/modules/ROOT/pages/installation/installation.adoc b/docs/modules/ROOT/pages/installation/installation.adoc index c1dd880..ebe2c8b 100644 --- a/docs/modules/ROOT/pages/installation/installation.adoc +++ b/docs/modules/ROOT/pages/installation/installation.adoc @@ -12,6 +12,7 @@ before installing it. Customized instructions are needed for the following clust - xref:installation/minikube.adoc[Minikube] - xref:installation/minishift.adoc[Minishift] +- xref:installation/crc.adoc[Red Hat CodeReady Containers (CRC)] - xref:installation/gke.adoc[Google Kubernetes Engine (GKE)] - xref:installation/openshift.adoc[OpenShift] diff --git a/docs/modules/ROOT/pages/uninstalling.adoc b/docs/modules/ROOT/pages/uninstalling.adoc index a009b1d..4358f01 100644 --- a/docs/modules/ROOT/pages/uninstalling.adoc +++ b/docs/modules/ROOT/pages/uninstalling.adoc @@ -10,7 +10,7 @@ kamel uninstall This will uninstall from the cluster namespace all Camel K resources along with the operator. -NOTE: By _default_ the resources possibly shared between clusters such as https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources[CustomResourceDefinitions (CRD)], https://kubernetes.io/docs/reference/access-authn-authz/rbac[ClusterRole] and https://docs.openshift.com/container-platform/4.1/applications/operators/olm-understanding-olm.html[Operator Lifecycle Manager(OLM)] will be **excluded**. To force the inclusion of all resources you can use the **--all** flag. +NOTE: By _default_ the resources possibly shared between clusters such as https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources[CustomResourceDefinitions (CRD)], https://kubernetes.io/docs/reference/access-authn-authz/rbac[ClusterRole] and https://docs.openshift.com/container-platform/4.1/applications/operators/olm-understanding-olm.html[Operator Lifecycle Manager(OLM)] will be **excluded**. To force the inclusion of all resources you can use the **--all* [...] To verify that all resources have been removed you can use the following command: