Add app.yaml to quickstart archetypes. Update k8s support in docs. (#…

…2141)
helidon-io · Jul 8, 2020 · f4c2619 · f4c2619
1 parent 5280d68
commit f4c2619
Show file tree

Hide file tree

Showing 11 changed files with 133 additions and 73 deletions.
diff --git a/archetypes/quickstart-mp/src/main/resources/META-INF/helidon-archetype.xml.mustache b/archetypes/quickstart-mp/src/main/resources/META-INF/helidon-archetype.xml.mustache
@@ -56,6 +56,7 @@
                 <include>Dockerfile.mustache</include>
                 <include>Dockerfile.native.mustache</include>
                 <include>Dockerfile.jlink.mustache</include>
+                <include>app.yaml.mustache</include>
                 <include>.dockerignore</include>
             </includes>
         </template-set>
@@ -67,6 +68,7 @@
                 <include>Dockerfile.mustache</include>
                 <include>Dockerfile.native.mustache</include>
                 <include>Dockerfile.jlink.mustache</include>
+                <include>app.yaml.mustache</include>
                 <include>.dockerignore</include>
             </includes>
         </template-set>

diff --git a/archetypes/quickstart-mp/src/main/resources/README.md.mustache b/archetypes/quickstart-mp/src/main/resources/README.md.mustache
@@ -64,9 +64,19 @@ Exercise the application as described above
 kubectl cluster-info                         # Verify which cluster
 kubectl get pods                             # Verify connectivity to cluster
 kubectl create -f app.yaml                   # Deploy application
+kubectl get pods                             # Wait for quickstart pod to be RUNNING
 kubectl get service helidon-quickstart-mp    # Verify deployed service
 ```
 
+Note the PORTs. You can now exercise the application as you did before but use the second
+port number (the NodePort) instead of 8080.
+
+After you’re done, cleanup.
+
+```
+kubectl delete -f app.yaml
+```
+
 ## Build a native image with GraalVM
 
 GraalVM allows you to compile your programs ahead-of-time into a native

diff --git a/archetypes/quickstart-mp/src/main/resources/app.yaml b/archetypes/quickstart-mp/src/main/resources/app.yaml
diff --git a/archetypes/quickstart-mp/src/main/resources/app.yaml.mustache b/archetypes/quickstart-mp/src/main/resources/app.yaml.mustache
@@ -0,0 +1,53 @@
+#
+# Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+kind: Service
+apiVersion: v1
+metadata:
+  name: {{artifactId}}
+  labels:
+    app: {{artifactId}}
+spec:
+  type: NodePort
+  selector:
+    app: {{artifactId}}
+  ports:
+  - port: 8080
+    targetPort: 8080
+    name: http
+---
+kind: Deployment
+apiVersion: apps/v1
+metadata:
+  name: {{artifactId}}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: {{artifactId}}
+  template:
+    metadata:
+      labels:
+        app: {{artifactId}}
+        version: v1
+    spec:
+      containers:
+      - name: {{artifactId}}
+        image: {{artifactId}}
+        imagePullPolicy: IfNotPresent
+        ports:
+        - containerPort: 8080
+---
diff --git a/archetypes/quickstart-se/src/main/resources/META-INF/helidon-archetype.xml.mustache b/archetypes/quickstart-se/src/main/resources/META-INF/helidon-archetype.xml.mustache
@@ -56,6 +56,7 @@
                 <include>Dockerfile.mustache</include>
                 <include>Dockerfile.native.mustache</include>
                 <include>Dockerfile.jlink.mustache</include>
+                <include>app.yaml.mustache</include>
                 <include>.dockerignore</include>
             </includes>
         </template-set>
@@ -67,6 +68,7 @@
                 <include>Dockerfile.mustache</include>
                 <include>Dockerfile.native.mustache</include>
                 <include>Dockerfile.jlink.mustache</include>
+                <include>app.yaml.mustache</include>
                 <include>.dockerignore</include>
             </includes>
         </template-set>

diff --git a/archetypes/quickstart-se/src/main/resources/README.md.mustache b/archetypes/quickstart-se/src/main/resources/README.md.mustache
@@ -64,9 +64,19 @@ Exercise the application as described above
 kubectl cluster-info                        # Verify which cluster
 kubectl get pods                            # Verify connectivity to cluster
 kubectl create -f app.yaml                  # Deploy application
+kubectl get pods                            # Wait for quickstart pod to be RUNNING
 kubectl get service helidon-quickstart-se   # Get service info
 ```
 
+Note the PORTs. You can now exercise the application as you did before but use the second
+port number (the NodePort) instead of 8080.
+
+After you’re done, cleanup.
+
+```
+kubectl delete -f app.yaml
+```
+
 ## Build a native image with GraalVM
 
 GraalVM allows you to compile your programs ahead-of-time into a native

diff --git a/archetypes/quickstart-se/src/main/resources/app.yaml b/archetypes/quickstart-se/src/main/resources/app.yaml
diff --git a/archetypes/quickstart-se/src/main/resources/app.yaml.mustache b/archetypes/quickstart-se/src/main/resources/app.yaml.mustache
@@ -0,0 +1,53 @@
+#
+# Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+kind: Service
+apiVersion: v1
+metadata:
+  name: {{artifactId}}
+  labels:
+    app: {{artifactId}}
+spec:
+  type: NodePort
+  selector:
+    app: {{artifactId}}
+  ports:
+  - port: 8080
+    targetPort: 8080
+    name: http
+---
+kind: Deployment
+apiVersion: apps/v1
+metadata:
+  name: {{artifactId}}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: {{artifactId}}
+  template:
+    metadata:
+      labels:
+        app: {{artifactId}}
+        version: v1
+    spec:
+      containers:
+      - name: {{artifactId}}
+        image: {{artifactId}}
+        imagePullPolicy: IfNotPresent
+        ports:
+        - containerPort: 8080
+---
diff --git a/docs/about/03_prerequisites.adoc b/docs/about/03_prerequisites.adoc
@@ -34,7 +34,7 @@ deploy to Kubernetes, you need `kubectl` and a Kubernetes cluster (you can
 |https://www.oracle.com/technetwork/java/javase/downloads[Java{nbsp}SE{nbsp}11] (http://jdk.java.net[Open{nbsp}JDK{nbsp}11]) or newer
 |https://maven.apache.org/download.cgi[Maven 3.6.1+]
 |https://docs.docker.com/install/[Docker 18.09+]
-|https://kubernetes.io/docs/tasks/tools/install-kubectl/[Kubectl 1.11.9+]
+|https://kubernetes.io/docs/tasks/tools/install-kubectl/[Kubectl 1.16.5+]
 |=======
 
 

diff --git a/docs/mp/guides/02_quickstart.adoc b/docs/mp/guides/02_quickstart.adoc
@@ -143,7 +143,7 @@ Then you can try the application as you did before.
 == Deploy the application to Kubernetes
 
 If you don't have access to a Kubernetes cluster, you can
-<<getting-started/05_kubernetes.adoc,install one on your desktop>>.
+<<about/05_kubernetes.adoc,install one on your desktop>>.
 Then deploy the example:
 
 [source,bash]

diff --git a/docs/se/guides/02_quickstart.adoc b/docs/se/guides/02_quickstart.adoc
@@ -143,7 +143,7 @@ Then you can try the application as you did before.
 == Deploy the application to Kubernetes
 
 If you don't have access to a Kubernetes cluster, you can
-<<getting-started/05_kubernetes.adoc,install one on your desktop>>.
+<<about/05_kubernetes.adoc,install one on your desktop>>.
 Then deploy the example:
 
 [source,bash]