Skip to content

Commit

Permalink
fix: typos and service names
Browse files Browse the repository at this point in the history
Service name typos and Camel K naming updates
  • Loading branch information
kameshsampath committed Mar 6, 2021
2 parents 0c5f38b + 43d3e3a commit 233276d
Show file tree
Hide file tree
Showing 22 changed files with 80 additions and 102 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Knative Tutorial
on:
push:
branches:
- release-v1.13.0
- 'release-v1.13.*'
env:
SITE_DIR: "gh-pages"

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![Knative Tutorial](https://github.com/redhat-developer-demos/knative-tutorial/workflows/Knative%20Tutorial/badge.svg) [![Knative Serving v0.19](https://img.shields.io/badge/Knative%20Serving-v0.19-blue)](https://knative.dev/docs/serving/)
[![Knative Eventing v0.19](https://img.shields.io/badge/Knative%20Eventing-v0.19-blue)](https://knative.dev/docs/eventing/)
[![Strimzi Kafka](https://img.shields.io/badge/Strimzi%20Kafka-v0.20.0-blue)](https://strimzi.io)
[![Apache Camel-K](https://img.shields.io/badge/Apache%20Camel--K-v1.3.1-blue)](https://camel.apache.org/camel-k/latest/)
[![Apache Camel K](https://img.shields.io/badge/Apache%20Camel--K-v1.3.1-blue)](https://camel.apache.org/camel-k/latest/)
[![OpenShift Serverless](https://img.shields.io/badge/OpenShift%20Serverless-v1.13-blue)](https://www.openshift.com/learn/topics/serverless)

## Documentation
Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::ROOT:partial$serving-nav.adoc[]
.xref:eventing:index.adoc[Knative Eventing]
include::ROOT:partial$eventing-nav.adoc[]

.xref:camelk:index.adoc[Apache Camel-K]
.xref:camelk:index.adoc[Apache Camel K]
include::ROOT:partial$camelk-nav.adoc[]

.xref:advanced:index.adoc[Advanced]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*** xref:advanced:eventing-with-kafka.adoc#kn-eventing-kafka-source-to-sink[Kafka Source to Sink]
*** xref:advanced:eventing-with-kafka.adoc#kn-eventing-kafka-auto-scaling[Auto Scaling with Kafka]
** xref:advanced:eventing-with-kafka.adoc#kn-kafka-src-cleanup[Cleanup]
* EIP with Apache Camel-K
* EIP with Apache Camel K
** xref:advanced:camel-k-cbr.adoc[Content Based Routing]
*** xref:advanced:camel-k-cbr.adoc#cbr-app-overview[Application Overview]
*** xref:advanced:camel-k-cbr.adoc#label-namespace-for-default-broker[Create Broker]
Expand Down
10 changes: 5 additions & 5 deletions documentation/modules/ROOT/pages/_partials/camelk-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
* xref:camelk:setup.adoc[Setup]
** xref:camelk:setup.adoc#install-camel-k[Install Camel-K ]
* xref:camelk:camel-k-basics.adoc[Camel-K with Knative Serving]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-integration[Deploy Camel-K integration]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-kn-integration[Deploy Camel-K Knative Integration]
** xref:camelk:setup.adoc#install-camel-k[Install Apache Camel K ]
* xref:camelk:camel-k-basics.adoc[Camel K with Knative Serving]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-integration[Deploy Camel K integration]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-kn-integration[Deploy Camel K Knative Integration]
** xref:camelk:camel-k-basics.adoc#camelk-gs-cleanup[Cleanup]
* xref:camelk:camel-k-eventing.adoc[Camel-K with Knative Eventing]
* xref:camelk:camel-k-eventing.adoc[Camel K with Knative Eventing]
** xref:camelk:camel-k-eventing.adoc#deploy-camel-k-source[Deploy Knative CamelSource]
** xref:camelk:camel-k-eventing.adoc#logging-ce-messages[View CloudEvents Messages]
** xref:camelk:camel-k-eventing.adoc#camel-k-es-sink[CamelSource to Sink]
Expand Down
8 changes: 4 additions & 4 deletions documentation/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@ a|
ifndef::workshop[]
a|
[.tile]
.xref:camelk:index.adoc[Apache Camel-K]
.xref:camelk:index.adoc[Apache Camel K]
* xref:camelk:setup.adoc[Setup]
* xref:camelk:camel-k-basics.adoc#deploy-camel-k-kn-integration[Camel-K with Knative Serving]
* xref:camelk:camel-k-eventing.adoc[Camel-K with Knative Eventing]
* xref:camelk:camel-k-basics.adoc#deploy-camel-k-kn-integration[Camel K with Knative Serving]
* xref:camelk:camel-k-eventing.adoc[Camel K with Knative Eventing]
* xref:camelk:camel-k-eventing.adoc#camel-k-es-sink[CamelSource to Sink]
a|
[.tile]
.xref:advanced:index.adoc[Advanced]
* xref:advanced:deploy-apache-kafka.adoc[Deploy Apache Kafka]
* xref:advanced:eventing-with-kafka.adoc[Knative Eventing with Apache Kafka]
* xref:advanced:camel-k-cbr.adoc[Content Based Routing with Camel-K]
* xref:advanced:camel-k-cbr.adoc[Content Based Routing with Camel K]
endif::[]
|===
2 changes: 1 addition & 1 deletion documentation/modules/advanced/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*** xref:eventing-with-kafka.adoc#kn-eventing-kafka-source-to-sink[Kafka Source to Sink]
*** xref:eventing-with-kafka.adoc#kn-eventing-kafka-auto-scaling[Auto Scaling with Kafka]
** xref:eventing-with-kafka.adoc#kn-kafka-src-cleanup[Cleanup]
* EIP with Apache Camel-K
* EIP with Apache Camel K
** xref:camel-k-cbr.adoc[Content Based Routing]
*** xref:camel-k-cbr.adoc#cbr-app-overview[Application Overview]
*** xref:camel-k-cbr.adoc#label-namespace-for-default-broker[Create Broker]
Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/advanced/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ This tutorial helps in undertanding some advanced concepts and application with
As pre-requisite to this tutorial, its highly recommended that you have completed:

* xref:ROOT:index.adoc[Knative Tutorial Basics]
* xref:camelk:index.adoc[Integrations with Apache Camel-K]
* xref:camelk:index.adoc[Integrations with Apache Camel K]
4 changes: 2 additions & 2 deletions documentation/modules/advanced/pages/setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ include::knative-tutorial:ROOT:partial$prereq-cli.adoc[]
endif::[]

[#install-camel-k]
== Install Camel-k
== Install Camel K

Download the latest camel-k release from https://github.com/apache/camel-k/releases/latest[here]. Extract the content and add the binary `kamel` to the PATH.
Download the latest Apache Camel K release from https://github.com/apache/camel-k/releases/latest[here]. Extract the content and add the binary `kamel` to the PATH.

[IMPORTANT]
====
Expand Down
10 changes: 5 additions & 5 deletions documentation/modules/camelk/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
* xref:camelk:setup.adoc[Setup]
** xref:camelk:setup.adoc#install-camel-k[Install Camel-K ]
* xref:camelk:camel-k-basics.adoc[Camel-K with Knative Serving]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-integration[Deploy Camel-K integration]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-kn-integration[Deploy Camel-K Knative Integration]
** xref:camelk:setup.adoc#install-camel-k[Install Camel K ]
* xref:camelk:camel-k-basics.adoc[Camel K with Knative Serving]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-integration[Deploy Camel K integration]
** xref:camelk:camel-k-basics.adoc#deploy-camel-k-kn-integration[Deploy Camel K Knative Integration]
** xref:camelk:camel-k-basics.adoc#camelk-gs-cleanup[Cleanup]
* xref:camelk:camel-k-eventing.adoc[Camel-K with Knative Eventing]
* xref:camelk:camel-k-eventing.adoc[Camel K with Knative Eventing]
** xref:camelk:camel-k-eventing.adoc#deploy-camel-k-source[Deploy Knative CamelSource]
** xref:camelk:camel-k-eventing.adoc#logging-ce-messages[View CloudEvents Messages]
** xref:camelk:camel-k-eventing.adoc#camel-k-es-sink[CamelSource to Sink]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,20 @@
kubectl::
+
--
[#camelk-get-k8s-int]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
kubectl -n {tutorial-namespace} get integrations.camel.apache.org
----
copyToClipboard::camelk-get-k8s-int[]
--
oc::
+
--
[#camelk-oc-get-k8s-int]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
-----
oc -n {tutorial-namespace} get get integrations.camel.apache.org
----
copyToClipboard::camelk-oc-get-k8s-int[]
-----
--
====
#end::integrations[]
Expand All @@ -30,17 +28,16 @@ copyToClipboard::camelk-oc-get-k8s-int[]
kubectl::
+
--
[#camelk-get-k8s-svc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
kubectl -n {tutorial-namespace} get svc
----
copyToClipboard::camelk-get-k8s-svc[]
--
oc::
+
--
[#camelk-oc-get-k8s-svc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
oc -n {tutorial-namespace} get svc
Expand All @@ -56,22 +53,20 @@ copyToClipboard::camelk-oc-get-k8s-svc[]
kubectl::
+
--
[#camelk-get-k8s-dc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
kubectl -n {tutorial-namespace} get deployments
----
copyToClipboard::camelk-get-k8s-dc[]
--
oc::
+
--
[#camelk-oc-get-k8s-dc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
oc -n {tutorial-namespace} get get deployments
----
copyToClipboard::camelk-oc-get-k8s-dc[]
--
====
#end::deployments[]
3 changes: 1 addition & 2 deletions documentation/modules/camelk/pages/_partials/extras.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#tag::config-k8s-local-registry[]

[#knative-{k8s-cli}-untag-repo]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
K8S_LOCAL_REGISTRY=`{k8s-cli} get svc -n kube-system registry -ojsonpath='{.spec.clusterIP}'` && \
Expand All @@ -11,6 +11,5 @@ val="pass:[${K8S_LOCAL_REGISTRY}]" && \
| yq w - data.registriesSkippingTagResolving $val \
| {k8s-cli} apply -f -
----
copyToClipboard::knative-{k8s-cli}-untag-repo[]

#end::config-k8s-local-registry[]
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,28 @@ We need to know the knative service `{svc-name}` domain name that needs to be pa
kubectl::
+
--
[#camelk-{doc-sec}-svc-by-k8s]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
SVC_URL=`kubectl -n {tutorial-namespace} get ksvc {svc-name} -ojsonpath='{.status.domain}'`
----
copyToClipboard::camelk-{doc-sec}-svc-by-k8s[]
--
oc::
+
--
[#camelk-{doc-sec}-svc-by-oc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
SVC_URL=`oc -n {tutorial-namespace} get ksvc {svc-name} -ojsonpath='{.status.domain}'`
----
copyToClipboard::camelk-{doc-sec}-svc-by-oc[]
--
====
#end::set-svc-url[]

#tag::invoke-svc[]
[#camelk-{file-name}-call-svc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
curl -v -H pass:["Host:${SVC_URL}"] -H 'fileName: {file-name}' $IP_ADDRESS
----
copyToClipboard::camelk-{file-name}-call-svc[]
#end::invoke-svc[]
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
[it-name='']

#tag::integration-status[]
[#camelk-{it-name}-{k8s-cli}-get-int-status]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
{k8s-cli} -n {kube-ns} get integrations.camel.apache.org {it-name}
----
copyToClipboard::camelk-{it-name}-{k8s-cli}-get-int-status[]
#end::integration-status[]
33 changes: 12 additions & 21 deletions documentation/modules/camelk/pages/_partials/prereqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The following checks ensures that each chapter exercises are done with right env
minikube::
+
--
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
minikube ssh -- docker run -i --rm --privileged --pid=host debian nsenter -t 1 -m -u -n -i hwclock -s
Expand All @@ -36,110 +37,100 @@ chmod +x ~/.wakeup
=====
* Make sure to be connected to minikube docker daemon
[#camelk-set-k8s-docker-env]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
eval $(minikube docker-env)
----
copyToClipboard::camelk-set-k8s-docker-env[]
* Make sure right Kubernetes is used, it should be v1.12+
[#camelk-set-k8s-version]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
kubectl version
----
copyToClipboard::camelk-set-k8s-version[]
* Make sure to be on `{tutorial-namespace}` namespace or use you night need to use `--namespace {tutorial-namespace}` in all commands
[TIP]
=====
If you are on minikube then **kubens** utility can be used to switch to kubernetes namespace like:
[#camelk-set-k8s-ns]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
kubens {tutorial-namespace}
----
copyToClipboard::camelk-set-k8s-ns[]
=====
--
minishift::
+
--
[#camelk-minishift-set-tz]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
minishift stop && \
minishift start --timezone 'Asia/Kolkata' #<1>
----
copyToClipboard::camelk-minishift-set-tz[]
<1> Set it to your local timezone
* Make sure to be connected to minishift docker daemon
[#camelk-minishift-docker-oc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
eval $(minishift docker-env) && eval $(minishift oc-env)
----
copyToClipboard::camelk-minishift-docker-oc[]
* Make sure right OpenShift client is used, it should be `v3.11+ kubernetes v1.11.0+` or above
[#camelk-which-oc]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
oc version
----
copyToClipboard::camelk-which-oc[]
* Make sure to be on `{tutorial-namespace}` OpenShift project
[#camelk-which-oc-project]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
oc project -q
----
copyToClipboard::camelk-which-oc-project[]
If you are not on `{tutorial-namespace}` project, use the following command to change to `{tutorial-namespace}` project
[#camelk-change-oc-project]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
oc project {tutorial-namespace}
----
copyToClipboard::camelk-change-oc-project[]
--
====

* Make sure right `kamel` version, preferred is `{kamel-version}` or above
[#camelk-kamel-version]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
kamel version
----
copyToClipboard::camelk-kamel-version[]

* Make sure AWS CLI is installed and has the right version, at the time of doing this tutorial it was `aws-cli/1.16.50 Python/3.7.1 Darwin/18.2.0 botocore/1.12.40`
[#camelk-aws-cli-version]
[.console-input]
[source,bash,subs="+macros,+attributes"]
----
$ aws --version
----
copyToClipboard::camelk-aws-cli-version[]

* Make sure right maven version is used (only for Java exercises), recommended maven version is `{maven-version}`
[.console-input]
[#camelk-maven-version]
----
./mvnw --version
----
copyToClipboard::camelk-maven-version[]
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
#tag::camel-k-demos[]
All the demo sources that will be used in the chapters of this module are available under `pass:[$TUTORIAL_HOME]/{camelk-repo}` folder.

[#camelk-download-sources-path-copy]
[.console-input]
[source,bash,subs="+macros,+attributes"]
-----
cp pass:[$TUTORIAL_HOME]/{camelk-repo}
-----
copyToClipboard::camelk-download-sources-path-copy[]
#end::camel-k-demos[]

0 comments on commit 233276d

Please sign in to comment.