Skip to content

Commit

Permalink
documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
kameshsampath committed Feb 18, 2020
1 parent bc7fb41 commit c8ee8a3
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions docs/src/main/asciidoc/getting-started-knative.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ For this guide you need:

== Solution

We recommend to follow the instructions in the next sections and build the application step by step.
However, you can go right to the completed example.
We recommend to follow the instructions in the next sections and build the application step by step. However, you can go right to the completed example.

Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].

Expand All @@ -57,40 +56,40 @@ Nexus is used for caching maven artifacts so that Apache Maven builds are faster
kubectl apply -f k8s/nexus.yaml
----

Wait for some time to have nexus initialize and run. You can watch the status via `kubectl get pods -w`, use kbd:[Ctrl+c] to terminate the watch
Wait for some time to have Nexus initialize and run. You can watch the status via `kubectl get pods -w`, use kbd:[Ctrl+c] to terminate the watch.

== Why skaffold ?
== Why Skaffold ?

As vanilla Kubernetes does not have a easy and developer friendly way to build and deploy application to local cluster, without the need to push the image to external container registry. We will be using skaffold to help us build and deploy the Quarkus application onto Kubernetes.
As vanilla Kubernetes does not have an easy and developer friendly way to build and deploy application to a local cluster like minikube, without the need to push the image to external container registry. We will be using Skaffold to help us build and deploy the Quarkus application onto Kubernetes.

== Build and deploy application

[IMPORTANT]
====
The container image will not be pushed to remote container registry, and hence the container image url has to be `dev.local`, to make Knative deploy it without trying to pull it from external container registry.
The container image will not be pushed to a remote container registry, and hence the container image url has to be `dev.local`, to make Knative deploy it without trying to pull it from external container registry.
====

To run Knative Quarkus application, we need to use the multi stage docker build; to build the quarkus application container image and use it in Kubernetes application deployment.
To run Knative Quarkus applications, we need to use the multi stage docker build; to build the Quarkus application container image and use it in Kubernetes application deployment.

The following commands starts a one time deployment of Quarkus application and runs starts the Knative service after successful container image build.
The following command start a one time deployment of Quarkus application and runs starts the Knative service after successful container image build.

[NOTE]
====
If you want to deploy Quarkus JVM image then run the following command before running skaffold:
If you want to deploy a Quarkus JVM image (using HotSpot), then run the following command before running Skaffold:
[source,bash]
----
cp src/main/docker/Dockerfile.jvm Dockerfile
----
If you want to deploy Quarkus Native image then run the following command before running skaffold:
If you want to deploy a Quarkus Native executable image (using GraalVM), then run the following command before running Skaffold:
[source,bash]
----
cp src/main/docker/Dockerfile.native Dockerfile
----
It is very important to note that the Dockerfile in src/main/docker folder has been modified Dockerfiles to support multi stage Docker build.The multi stage Docker build helps in building and containerization of application with one Dockerfile.
It is very important to note that the Dockerfile in `src/main/docker` folder has been modified Dockerfiles to support multi stage Docker build.The multi stage Docker build helps in building and containerization of application with single Dockerfile.
====

[source,bash]
Expand Down

0 comments on commit c8ee8a3

Please sign in to comment.