{"id":11784,"date":"2025-09-01T19:29:41","date_gmt":"2025-09-01T19:29:41","guid":{"rendered":"https:\/\/putridparrot.com\/blog\/?p=11784"},"modified":"2025-09-01T19:29:41","modified_gmt":"2025-09-01T19:29:41","slug":"a-simple-web-api-in-various-languages-and-deployable-to-kubernetes-java","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/a-simple-web-api-in-various-languages-and-deployable-to-kubernetes-java\/","title":{"rendered":"A simple web API in various languages and deployable to Kubernetes (Java)"},"content":{"rendered":"<p>Continuing this short series of writing a simple echo service web API along with the docker and k8s requirements, we\u2019re now going to turn our attention to a Java implementation.<\/p>\n<p><strong>Implementation<\/strong><\/p>\n<p>I&#8217;m going to be using JetBrains IntelliJ. <\/p>\n<ul>\n<li>Create a new Java Project, selecting Maven as the build system<\/li>\n<li>We&#8217;re going to use Sprint Boot, so add the following to the pom.xml\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\n&lt;dependencies&gt;\r\n  &lt;dependency&gt;\r\n    &lt;groupId&gt;org.springframework.boot&lt;\/groupId&gt;\r\n    &lt;artifactId&gt;spring-boot-starter-web&lt;\/artifactId&gt;\r\n    &lt;version&gt;3.5.5&lt;\/version&gt;\r\n  &lt;\/dependency&gt;\r\n&lt;\/dependencies&gt;\r\n<\/pre>\n<\/li>\n<li>We&#8217;re also going to want to use the Spring Boot Maven plugin to generate our JAR and Manifest\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\n&lt;build&gt;\r\n  &lt;plugins&gt;\r\n    &lt;plugin&gt;\r\n      &lt;groupId&gt;org.springframework.boot&lt;\/groupId&gt;\r\n      &lt;artifactId&gt;spring-boot-maven-plugin&lt;\/artifactId&gt;\r\n      &lt;version&gt;3.5.5&lt;\/version&gt;\r\n      &lt;executions&gt;\r\n        &lt;execution&gt;\r\n          &lt;goals&gt;\r\n            &lt;goal&gt;repackage&lt;\/goal&gt;\r\n          &lt;\/goals&gt;\r\n        &lt;\/execution&gt;\r\n      &lt;\/executions&gt;\r\n    &lt;\/plugin&gt;\r\n  &lt;\/plugins&gt;\r\n&lt;\/build&gt;\r\n<\/pre>\n<\/li>\n<li>Let&#8217;s delete the supplied Main.java file and replace with one named EchoServiceApplication.java which looks like this\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\npackage com.putridparrot;\r\n\r\nimport org.springframework.boot.SpringApplication;\r\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\r\n\r\nimport java.util.HashMap;\r\nimport java.util.Map;\r\n\r\n@SpringBootApplication\r\npublic class EchoServiceApplication {\r\n    public static void main(String&#x5B;] args) {\r\n        SpringApplication app = new SpringApplication(EchoServiceApplication.class);\r\n        Map&lt;String, Object&gt; props = new HashMap&lt;&gt;();\r\n        props.put(&quot;server.port&quot;, System.getenv(&quot;PORT&quot;));\r\n        app.setDefaultProperties(props);\r\n        app.run(args);\r\n    }\r\n}\r\n<\/pre>\n<p>We&#8217;re setting the PORT here from the environment variable as this will be supplied via the Dockerfile\n<\/li>\n<li>Next add a new file named EchoController.java which will look like this\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\npackage com.putridparrot;\r\n\r\nimport org.springframework.web.bind.annotation.*;\r\n\r\n@RestController\r\npublic class EchoController {\r\n\r\n    @GetMapping(&quot;\/echo&quot;)\r\n    public String echo(@RequestParam(name = &quot;text&quot;, defaultValue = &quot;&quot;) String text) {\r\n        return String.format(&quot;Java Echo: %s&quot;, text);\r\n    }\r\n\r\n    @GetMapping(&quot;\/readyz&quot;)\r\n    public String readyz() {\r\n        return &quot;OK&quot;;\r\n    }\r\n\r\n    @GetMapping(&quot;\/livez&quot;)\r\n    public String livez() {\r\n        return &quot;OK&quot;;\r\n    }\r\n}\r\n<\/pre>\n<\/li>\n<\/ul>\n<p><strong>Dockerfile<\/strong><\/p>\n<p>Next up we need to create our Dockerfile<\/p>\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\nFROM maven:3.9.11-eclipse-temurin-21 AS builder\r\n\r\nWORKDIR \/app\r\n\r\nCOPY . .\r\nRUN mvn clean package -DskipTests\r\n\r\nFROM eclipse-temurin:21-jre AS runtime\r\n\r\nWORKDIR \/app\r\n\r\nCOPY --from=builder \/app\/target\/echo_service-1.0-SNAPSHOT.jar .\/echo-service.jar\r\n\r\nENV PORT=8080\r\nEXPOSE 8080\r\n\r\nENTRYPOINT &#x5B;&quot;java&quot;, &quot;-jar&quot;, &quot;echo-service.jar&quot;]\r\n<\/pre>\n<p>Note: In Linux port 80 might be locked down, hence we use port 8080 &#8211; to override the default port in phx we also set the environment variable PORT.<\/p>\n<p>To build this, run<\/p>\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\ndocker build -t putridparrot.echo_service:v1 .\r\n<\/pre>\n<p>Don\u2019t forget to change the name to your preferred name.<\/p>\n<p>To test this, run<\/p>\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\ndocker run -p 8080:8080 putridparrot.echo_service:v1\r\n<\/pre>\n<p><strong>Kubernetes<\/strong><\/p>\n<p>If all wen well we&#8217;ve not tested our application and see it working from a docker image, so now we need to create the deployment etc. for Kubernete&#8217;s. Let&#8217;s assume you&#8217;ve pushed you image to Docker or another container registry such as Azure &#8211; I&#8217;m call my container registry <em>putridparrotreg<\/em>.<\/p>\n<p>I&#8217;m also not going to use helm at this point as I just want a (relatively) simple yaml file to run from kubectl, so create a deployment.yaml file, we&#8217;ll store all the configurations, deployment, service and ingress in this one file jus for simplicity.<\/p>\n<pre class=\"brush: plain; title: ; notranslate\" title=\"\">\r\napiVersion: apps\/v1\r\nkind: Deployment\r\nmetadata:\r\n  name: echo\r\n  namespace: dev\r\n  labels:\r\n    app: echo\r\nspec:\r\n  replicas: 1\r\n  selector:\r\n    matchLabels:\r\n      app: echo\r\n  template:\r\n    metadata:\r\n      labels:\r\n        app: echo\r\n    spec:\r\n      containers:\r\n      - name: echo\r\n        image: putridparrotreg\/putridparrot.echo_service:v1\r\n        ports:\r\n        - containerPort: 8080\r\n        resources:\r\n          requests:\r\n            memory: &quot;100Mi&quot;\r\n            cpu: &quot;100m&quot;\r\n          limits:\r\n            memory: &quot;200Mi&quot;\r\n            cpu: &quot;200m&quot;\r\n        livenessProbe:\r\n          httpGet:\r\n            path: \/livez\r\n            port: 8080\r\n          initialDelaySeconds: 30\r\n          periodSeconds: 10\r\n        readinessProbe:\r\n          httpGet:\r\n            path: \/readyz\r\n            port: 8080\r\n          initialDelaySeconds: 5\r\n          periodSeconds: 5\r\n\r\n---\r\napiVersion: v1\r\nkind: Service\r\nmetadata:\r\n  name: echo_service\r\n  namespace: dev\r\n  labels:\r\n    app: echo\r\nspec:\r\n  type: ClusterIP\r\n  selector:\r\n    app: echo \r\n  ports:\r\n  - name: http\r\n    port: 80\r\n    targetPort: 8080\r\n    protocol: TCP\r\n---\r\napiVersion: networking.k8s.io\/v1\r\nkind: Ingress\r\nmetadata:\r\n  name: echo-ingress\r\n  namespace: dev\r\n  annotations:\r\n    kubernetes.io\/ingress.class: &quot;nginx&quot;\r\n    nginx.ingress.kubernetes.io\/rewrite-target: \/\r\nspec:\r\n  rules:\r\n  - host: mydomain.com\r\n    http:\r\n      paths:\r\n      - path: \/\r\n        pathType: Prefix\r\n        backend:\r\n          service:\r\n            name: echo_service\r\n            port:\r\n              number: 80\r\n<\/pre>\n<p>Don&#8217;t forget to change the &#8220;host&#8221; and image to suit, also this assume you created a namespace &#8220;dev&#8221; for your app. See <a href=\"https:\/\/putridparrot.com\/blog\/creating-a-local-container-registry\/\" target=\"_blank\">Creating a local container registry<\/a> for information on setting up your own container registry.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Continuing this short series of writing a simple echo service web API along with the docker and k8s requirements, we\u2019re now going to turn our attention to a Java implementation. Implementation I&#8217;m going to be using JetBrains IntelliJ. Create a new Java Project, selecting Maven as the build system We&#8217;re going to use Sprint Boot, [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[102,161,314],"tags":[],"class_list":["post-11784","post","type-post","status-publish","format-standard","hentry","category-docker","category-java","category-kubernetes"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/11784","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=11784"}],"version-history":[{"count":5,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/11784\/revisions"}],"predecessor-version":[{"id":11790,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/11784\/revisions\/11790"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=11784"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=11784"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=11784"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}