Update Devfile doc for Kubernetes and add quarkus doc #3483
Conversation
|
@cdrage Added a separate doc, as i was thinking this document is getting quite bigger |
|
|
||
| In this example we will be deploying a https://github.com/odo-devfiles/quarkus-ex[quarkus component] that uses GraalVM and JDK1.8+. | ||
|
|
||
| Before you start make sure you have running openshift/kubernetes cluster and do not forget to login if it is openshift cluster. |
There was a problem hiding this comment.
This seems better suited for a Note highlighted section. Also
Before you start, make sure you have a running openshift/kubernetes cluster and do not forget to login, if it is a openshift cluster.
| ---- | ||
|
|
||
|
|
||
| Continue devloping your application and just run `odo push`, refresh your browser to view the latest changes. |
There was a problem hiding this comment.
You can now continue developing your application. Just run odo push and refresh your browser to view the latest changes.
|
|
||
|
|
||
| Continue devloping your application and just run `odo push`, refresh your browser to view the latest changes. | ||
| You can also run `odo watch` to watch changes in the source code, just refreshing the browser will render the source code changes. |
There was a problem hiding this comment.
You can also run odo watch to watch changes in the source code. Just refreshing the browser will render the source code changes.
|
|
||
| Continue devloping your application and just run `odo push`, refresh your browser to view the latest changes. | ||
| You can also run `odo watch` to watch changes in the source code, just refreshing the browser will render the source code changes. | ||
| Run `odo delete` to delete the application from cluster. |
|
Hey @adisky I don't believe we need a separate document for this. I recommend that you modify the file: https://github.com/openshift/odo/blob/master/docs/public/deploying-a-devfile-using-odo.adoc and add it as another example below the other spring boot / nodejs examples. Please follow the similar "template" as the other examples. Unfortunately the OpenShift docs team is quite specific on the format haha. |
@cdrage template here you mean, the steps needs to be the same? |
Add starting doc for quarkus app
update the doc with odo watch
update quarkus doc with formatting changes.
adisky
force-pushed
the
quarkus-doc
branch
2 times, most recently
from
fd7ab47
to
1cbccb2
Compare
Add quarkus doc Update for kubernetes update new v2 registry update output of odo catalog list components
adisky
changed the title
| @@ -133,15 +125,28 @@ Alternatively, you can pass in `--starter` to `odo create` to have odo download | |||
|
|
|||
| . Create a URL in order to access the deployed component: | |||
| + | |||
| * Run below for Kubernetes cluster | |||
There was a problem hiding this comment.
Maybe simply For Kubernetes cluster?
There was a problem hiding this comment.
Honestly, I don't think this matters much... We could actually keep this the same and just remove --host as by default it will use the default hostname? Or add a small note saying: If using Kubernetes, you have to pass in --host
|
|
||
| * Enable experimental mode for odo. This can be done by: `odo preference set experimental true` | ||
|
|
||
| * Before proceeding, you must know your cluster domain name to specify host for ingress. |
There was a problem hiding this comment.
We should provide link where users can learn how to do that, or what the ingress host is.
There was a problem hiding this comment.
I also think so, tried an exact way to determine cluster domain name, what i understand till now it is much dependent on the way cluster is deployed.
I have also seen this issue to add document details on how to get --host for url #3463
| You can also run `odo watch` to watch changes in the source code. Just refreshing the browser will render the source code changes. | ||
| + | ||
| Run `odo delete` to delete the application from cluster. | ||
|
|
||
| == Deploying a Java Spring Boot® component locally to Docker |
There was a problem hiding this comment.
I would remove this whole section. Docker is not fully supported, and it might just confuse users
There was a problem hiding this comment.
Agreed with Tomas ^^ we no longer need Docker
| * Enable experimental mode for odo. This can be done by: `odo preference set experimental true` | ||
|
|
||
| == Creating a project |
There was a problem hiding this comment.
Please, do NOT remove this section. We must have a section for creating a project in each .adoc / markdown file that corresponds to a tutorial.
There was a problem hiding this comment.
You can simply remove / copy and paste this section after the Prerequisites for OpenShift cluster parts.
|
|
||
| * Before proceeding, you must know your ingress domain cluster name. For example: `apps-crc.testing` is the cluster domain name for https://github.com/code-ready/crc[Red Hat CodeReady Containers] | ||
| ==== Prerequisites for Openshift Cluster |
There was a problem hiding this comment.
Prerequisites for an OpenShift cluster
| ✓ New project created and now using project : myproject | ||
| ---- | ||
| + | ||
| ==== Prerequisites for Kubernetes Cluster |
There was a problem hiding this comment.
Prerequisites for a Kubernetes cluster
| @@ -133,15 +125,28 @@ Alternatively, you can pass in `--starter` to `odo create` to have odo download | |||
|
|
|||
| . Create a URL in order to access the deployed component: | |||
| + | |||
| * Run below for Kubernetes cluster | |||
There was a problem hiding this comment.
Honestly, I don't think this matters much... We could actually keep this the same and just remove --host as by default it will use the default hostname? Or add a small note saying: If using Kubernetes, you have to pass in --host
| @@ -197,7 +202,7 @@ NOTE: You must use your cluster host domain name when creating your URL. | |||
| ✓ Successfully deleted component | |||
| ---- | |||
|
|
|||
| == Deploying a Node.js® component to an OpenShift cluster | |||
| == Deploying a Node.js® component to an OpenShift/Kubernetes cluster | |||
| ---- | ||
| + | ||
|
|
||
| NOTE: You must use your cluster host domain name when creating your URL. |
There was a problem hiding this comment.
See other commments above, perhaps we can change these sections to say: "If deploying to Kubernetes, you must provide a cluster host name with --host" or something like that.
| @@ -304,6 +322,101 @@ NOTE: You must use your cluster host domain name when creating your URL. | |||
| ✓ Successfully deleted component | |||
| ---- | |||
|
|
|||
| == Deploying a Quarkus Application on Kubernetes/Openshift cluster | |||
|
|
|||
| In this example we will be deploying a https://github.com/odo-devfiles/quarkus-ex[quarkus component] that uses GraalVM and JDK1.8+. | |||
|
|
||
| In this example we will be deploying a https://github.com/odo-devfiles/quarkus-ex[quarkus component] that uses GraalVM and JDK1.8+. | ||
|
|
||
| . Download the example quarkus component. |
There was a problem hiding this comment.
Remove period at the end of the sentence, capitalize Quarkus
| $ git clone https://github.com/odo-devfiles/quarkus-ex && cd quarkus-ex | ||
| ---- | ||
|
|
||
| . Create an quarkus odo component |
There was a problem hiding this comment.
Should be Create a Quarkus component maybe?
| You can also run `odo watch` to watch changes in the source code. Just refreshing the browser will render the source code changes. | ||
| + | ||
| Run `odo delete` to delete the application from cluster. | ||
|
|
||
| == Deploying a Java Spring Boot® component locally to Docker |
There was a problem hiding this comment.
Agreed with Tomas ^^ we no longer need Docker
Removed docker doc Addressed review comments.
|
@girishramnani It partially fixes it, It only add docs, for tests i would create a separate PR. |
Added description for ingress.
|
|
||
| Create a project to keep your source code, tests, and libraries | ||
| organized in a separate single unit. | ||
| * Creating a project to keep your source code, tests, and libraries organized in a separate single unit. |
| + | ||
| Ingress ip is usually the external ip of ingress controller service, for minikube or crc clusters running in a virtual machine you can get it by |
There was a problem hiding this comment.
I feel like this can be shortened?
IP needs to be capitalized. Same for CRC and Minikube.
I feel as though since people are developing against Kubernetes and OpenShift already, they already know what an Ingress is. So we can remove that part. The part about minikube or crc looks good though.
| @@ -131,17 +140,17 @@ Alternatively, you can pass in `--starter` to `odo create` to have odo download | |||
| README.md devfile.yaml pom.xml src | |||
| ---- | |||
|
|
|||
| . Create a URL in order to access the deployed component: | |||
| . Create an URL in order to access the deployed component: | |||
| @@ -238,17 +247,17 @@ In this example we will be deploying an https://github.com/odo-devfiles/nodejs-e | |||
| Please use odo push command to create the component with source deployed | |||
| ---- | |||
|
|
|||
| . Create a URL in order to access the deployed component: | |||
| . Create an URL in order to access the deployed component: | |||
| ✓ URL mynodejs-8080.apps-crc.testing created for component: mynodejs | ||
|
|
||
| To apply the URL configuration changes, please use odo push | ||
| ---- | ||
| + | ||
| NOTE: You must use your cluster host domain name when creating your URL. | ||
| NOTE: If deploying on kubernetes, you need to pass ingress domain name via `--host` flag. |
There was a problem hiding this comment.
Kubernetes needs to be capitalized.
| Global preference was successfully updated | ||
| ---- | ||
| + | ||
| == Deploying a Quarkus Application on OpenShift / Kubernetes cluster |
There was a problem hiding this comment.
to an OpenShift / Kubernetes cluster
| ---- | ||
|
|
||
| . Create a component configuration using the `java-spring-boot` component-type named `mydockerspringboot`: | ||
| . Create a Quarkus odo component |
There was a problem hiding this comment.
random space added to end of sentence?
| @@ -349,65 +339,58 @@ Alternatively, you can pass in `--starter` to `odo create` to have odo download | |||
| Please use odo push command to create the component with source deployed | |||
| ---- | |||
|
|
|||
| . Create a URL in order to access the deployed component: | |||
| . Create an URL in order to access the deployed component: | |||
Address review commens
|
@cdrage Thanks for review, comments addressed |
Codecov Report
@@ Coverage Diff @@
## master #3483 +/- ##
==========================================
- Coverage 46.45% 45.91% -0.54%
==========================================
Files 112 114 +2
Lines 11237 11530 +293
==========================================
+ Hits 5220 5294 +74
- Misses 5513 5722 +209
- Partials 504 514 +10
Continue to review full report at Codecov.
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: girishramnani The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
openshift-ci-robot
added
the
lgtm
|
No point having this sit in the merge queue, so going to merge this manually. Thanks @adisky ! |
|
@adisky: The following tests failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
What type of PR is this?
/kind documentation
[skip ci]
What does does this PR do / why we need it:
Adds document for quarkus component.
Updates v2 registry,
odo catalog list componentoutputAnd additions to deploy on kubernetes
Which issue(s) this PR fixes:
#2800
How to test changes / Special notes to the reviewer: