doc: Quickstart with external Dockerfile

Signed-off-by: Marc Nuri <[email protected]>
rohanKanojia · Apr 24, 2020 · 13f5571 · 13f5571
1 parent 664e0a6
commit 13f5571
Show file tree

Hide file tree

Showing 5 changed files with 176 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -39,6 +39,7 @@ Usage:
 * Fix #88: Unreachable statement in DockerAssemblyManager
 * Fix #122: Bug 561261 - jkube-kit - insecure yaml load leading to RCE (CWE-502)
 * Fix #152: kubernetes namespace is ignored in debug goal
+* Fix #163: Added Quickstart for external Dockerfile
 
 ### 0.2.0 (2020-03-05)
 * Fix #71: script to extract changelog information for notifications

diff --git a/quickstarts/maven/docker-file-provided/pom.xml b/quickstarts/maven/docker-file-provided/pom.xml
@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2019 Red Hat, Inc.
+    This program and the accompanying materials are made
+    available under the terms of the Eclipse Public License 2.0
+    which is available at:
+
+        https://www.eclipse.org/legal/epl-2.0/
+
+    SPDX-License-Identifier: EPL-2.0
+
+    Contributors:
+      Red Hat, Inc. - initial API and implementation
+
+-->
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.2.6.RELEASE</version>
+    </parent>
+
+    <groupId>org.eclipse.jkube.quickstarts.maven</groupId>
+    <artifactId>docker-file-provided</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <name>Eclipse JKube :: Quickstarts :: Maven :: Docker File Provided</name>
+    <packaging>jar</packaging>
+
+    <description>Minimal Example with Spring Boot and a provided external Dockerfile</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+    <profiles>
+        <profile>
+            <id>kubernetes</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.eclipse.jkube</groupId>
+                        <artifactId>kubernetes-maven-plugin</artifactId>
+                        <version>${project.version}</version>
+                        <configuration>
+                            <images>
+                                <image>
+                                    <name>jkube/docker-file-provided</name>
+                                    <build>
+                                        <contextDir>${project.basedir}</contextDir>
+                                        <dockerFile>src/main/docker/Dockerfile</dockerFile>
+                                    </build>
+                                </image>
+                            </images>
+                            <enricher>
+                                <config>
+                                    <jkube-service>
+                                        <type>NodePort</type>
+                                        <name>${artifactId}</name>
+                                        <port>8080:8080</port>
+                                    </jkube-service>
+                                </config>
+                            </enricher>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+        <profile>
+            <id>openshift</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.eclipse.jkube</groupId>
+                        <artifactId>openshift-maven-plugin</artifactId>
+                        <version>${project.version}</version>
+                        <configuration>
+                            <images>
+                                <image>
+                                    <name>jkube/docker-file-provided</name>
+                                    <build>
+                                        <contextDir>${project.basedir}</contextDir>
+                                        <dockerFile>src/main/docker/Dockerfile</dockerFile>
+                                    </build>
+                                </image>
+                            </images>
+                            <enricher>
+                                <config>
+                                    <jkube-service>
+                                        <type>NodePort</type>
+                                        <name>${artifactId}</name>
+                                        <port>8080:8080</port>
+                                    </jkube-service>
+                                </config>
+                            </enricher>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+
+</project>
diff --git a/quickstarts/maven/docker-file-provided/src/main/docker/Dockerfile b/quickstarts/maven/docker-file-provided/src/main/docker/Dockerfile
@@ -0,0 +1,4 @@
+FROM fabric8/s2i-java:latest-java11
+EXPOSE 8080/tcp
+COPY maven/*.jar /opt/app.jar
+ENTRYPOINT [ "java", "-jar", "/opt/app.jar" ]
diff --git a/...r-file-provided/src/main/java/org/eclipse/jkube/maven/sample/spring/boot/Application.java b/...r-file-provided/src/main/java/org/eclipse/jkube/maven/sample/spring/boot/Application.java
@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2019 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at:
+ *
+ *     https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.jkube.maven.sample.spring.boot;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}
diff --git a/...le-provided/src/main/java/org/eclipse/jkube/maven/sample/spring/boot/HelloController.java b/...le-provided/src/main/java/org/eclipse/jkube/maven/sample/spring/boot/HelloController.java
@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2019 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at:
+ *
+ *     https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.jkube.maven.sample.spring.boot;
+
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+    @RequestMapping("/")
+    public String index() {
+        return "Greetings from Spring Boot with provided Dockerfile!";
+    }
+
+}