Skip to content

Update POMs to reflect new build/push paradigm #1091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update POMs to reflect new build/push paradigm #1091

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85f80d6
Update POMs to reflect new build/push paradigm
ddrechse Sep 10, 2025
962420a
updt repo
ddrechse Sep 10, 2025
6c9140c
Update JKube to v1.16.2 and use generator.name property
ddrechse Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
233 changes: 233 additions & 0 deletions cloudbank-v4/OBaaS_Container_Image_Build_Guide.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
# OBaaS 2.0 Container Image Build Guide

## Overview

This guide documents the client-side container image building approach for OBaaS 2.0's hybrid architecture. Each framework uses different tooling to build and push container images to Oracle Cloud Registry, while maintaining a consistent developer experience.

## Prerequisites

- Java 17 or later
- Maven 3.8 or later
- Docker or Podman
- Oracle Cloud Registry access and authentication
- kubectl configured with cluster access

## Registry Configuration

All services use these common properties:

```xml
<properties>
<obaas.registry>us-phoenix-1.ocir.io/tenancy</obaas.registry>
<obaas.image.version>0.0.1</obaas.image.version>
</properties>
```

## Spring Boot Services (Account Service)

### Technology Stack
- **Framework**: Spring Boot 3.x
- **Build Tool**: Spring Boot Maven Plugin with Cloud Native Buildpacks
- **Package Type**: Fat JAR
- **Container Strategy**: Buildpacks (automatic optimization)

### POM Configuration

```xml
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<name>${obaas.registry}/${project.artifactId}:${obaas.image.version}</name>
<publish>false</publish>
</image>
</configuration>
</plugin>
```

### Commands

```bash
# Build JAR and container image
mvn clean package spring-boot:build-image

# Push to Oracle Cloud Registry
docker push us-phoenix-1.ocir.io/tenancy/account:0.0.1
```

### Output
- **JAR**: `target/account-0.0.1-SNAPSHOT.jar` (fat JAR with all dependencies)
- **Image**: Uses optimized buildpacks base image with automatic JVM tuning

## Helidon Services (Customer Service)

### Technology Stack
- **Framework**: Helidon MP 4.2.3
- **Build Tool**: Eclipse JKube Kubernetes Maven Plugin
- **Package Type**: Thin JAR + libs directory
- **Container Strategy**: JKube generator with Helidon detection

### POM Configuration

```xml
<properties>
<jkube.version>1.14.0</jkube.version>
</properties>

<plugin>
<groupId>org.eclipse.jkube</groupId>
<artifactId>kubernetes-maven-plugin</artifactId>
<version>${jkube.version}</version>
<configuration>
<images>
<image>
<name>${obaas.registry}/${project.artifactId}:${obaas.image.version}</name>
<build>
<from>quay.io/jkube/jkube-java:0.0.19</from>
</build>
</image>
</images>
</configuration>
</plugin>
```

### Environment Setup (macOS with Rancher Desktop)

```bash
# Set Docker host for JKube compatibility
export DOCKER_HOST=unix:///Users/$USER/.rd/docker.sock
```

### Commands

```bash
# Build thin JAR and libs
mvn clean package

# Build container image
mvn k8s:build

# Push to Oracle Cloud Registry
docker push us-phoenix-1.ocir.io/tenancy/customer-helidon:1.0-SNAPSHOT
```

### Output
- **JAR**: `target/customer-helidon.jar` (thin JAR)
- **Dependencies**: `target/libs/` (all dependencies)
- **Deployment**: `target/customer-helidon-deployment.zip`
- **Image**: Uses JKube Java base image with automatic Helidon configuration

## Alternative: Helidon with Jib

For environments where JKube has Docker connectivity issues:

### POM Configuration

```xml
<plugin>
<groupId>com.google.cloud.tools</groupId>
<artifactId>jib-maven-plugin</artifactId>
<version>3.4.0</version>
<configuration>
<to>
<image>${obaas.registry}/${project.artifactId}:${obaas.image.version}</image>
</to>
<container>
<mainClass>io.helidon.microprofile.cdi.Main</mainClass>
<ports>
<port>8080</port>
</ports>
</container>
</configuration>
</plugin>
```

### Commands

```bash
# Build and push directly (no Docker daemon required)
mvn compile jib:build
```



## Authentication

### Oracle Cloud Registry Login

```bash
docker login us-phoenix-1.ocir.io
# Username: <tenancy-namespace>/<username>
# Password: <auth-token>
```

## Troubleshooting

### Common Issues

#### Spring Boot: Buildpacks Authentication Issues
**Symptom**: "Anonymous users are only allowed read access"
**Solution**: Use separate build and push:
```bash
mvn clean package spring-boot:build-image
docker push <image-name>
```

#### Helidon: Docker Connectivity Issues
**Symptom**: "No DOCKER_HOST given"
**Solution**: Export Docker host for Rancher Desktop:
```bash
export DOCKER_HOST=unix:///Users/$USER/.rd/docker.sock
```

#### JKube: Wrong Image Name
**Symptom**: Image tagged as `example/customer-helidon:latest`
**Solution**: Add build configuration to JKube plugin as shown above

## OBaaS 2.0 Hybrid Workflow

### Phase 1: Client-Side (Build & Push)

```bash
# Spring Boot
mvn clean package spring-boot:build-image
docker push us-phoenix-1.ocir.io/tenancy/account:0.0.1

# Helidon
mvn clean package k8s:build
docker push us-phoenix-1.ocir.io/tenancy/customer-helidon:1.0-SNAPSHOT
```

### Phase 2: Server-Side (Deploy)

```bash
# Orchestrated deployment via OBaaS server
mvn obaas:deploy
```

## Benefits by Framework

### Spring Boot
- **Mature Tooling**: Built-in buildpacks support
- **Automatic Optimization**: JVM tuning, security updates
- **Cross-Platform**: Works on any OS
- **Layer Caching**: Efficient rebuilds

### Helidon
- **Thin JAR Benefits**: Better Docker layer caching
- **Framework Support**: JKube has native Helidon detection
- **Flexibility**: Choice between JKube and Jib
- **Lightweight**: Smaller base images

## Performance Comparison

| Aspect | Spring Boot | Helidon |
|--------|-------------|---------|
| **Build Time** | ~30-60 seconds | ~30-45 seconds |
| **Image Size** | ~150-200 MB | ~120-150 MB |
| **Startup Time** | ~3-5 seconds | ~2-4 seconds |
| **Memory Usage** | Higher (fat JAR) | Lower (thin JAR) |
| **Layer Caching** | Good | Excellent |

Both approaches provide fast, reliable container image building suitable for enterprise CI/CD pipelines and local development workflows.
15 changes: 15 additions & 0 deletions cloudbank-v4/account/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@
<name>account</name>
<description>Account Application</description>

<properties>
<obaas.registry>us-phoenix-1.ocir.io/maacloud</obaas.registry>
<!-- obaas.namespace>account</obaas.namespace -->
<obaas.image.version>0.0.2</obaas.image.version>
</properties>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
Expand Down Expand Up @@ -49,6 +55,15 @@
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<name>${obaas.registry}/${project.artifactId}:${obaas.image.version}</name>
<publish>false</publish>
<env>
<BP_JVM_VERSION>21</BP_JVM_VERSION>
</env>
</image>
</configuration>
</plugin>
<plugin>
<groupId>org.graalvm.buildtools</groupId>
Expand Down
35 changes: 0 additions & 35 deletions cloudbank-v4/customer-helidon/Dockerfile
View file
Open in desktop

This file was deleted.

29 changes: 28 additions & 1 deletion cloudbank-v4/customer-helidon/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
<artifactId>customer-helidon</artifactId>
<version>1.0-SNAPSHOT</version>

<properties>
<helidon-maven-plugin.version>4.0.14</helidon-maven-plugin.version>
<jkube.version>1.14.0</jkube.version>
<obaas.registry>us-phoenix-1.ocir.io/maacloud</obaas.registry>
<obaas.image.version>1.0-SNAPSHOT</obaas.image.version>
</properties>

<dependencies>
<dependency>
<groupId>io.helidon.microprofile.bundles</groupId>
Expand Down Expand Up @@ -208,6 +215,25 @@
</execution>
</executions>
</plugin>
<!-- Helidon Maven Plugin for native image support -->
<plugin>
<groupId>io.helidon.build-tools</groupId>
<artifactId>helidon-maven-plugin</artifactId>
<version>${helidon-maven-plugin.version}</version>
</plugin>
<!-- Eclipse JKube for container image building -->
<plugin>
<groupId>org.eclipse.jkube</groupId>
<artifactId>kubernetes-maven-plugin</artifactId>
<version>${jkube.version}</version>
<configuration>
<images>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this did not work for me, instead, remove the configuration section from here and instead add a property (up above) as follows:

   <properties>
        <jkube.version>1.16.2</jkube.version>
        <jkube.generator.name>${obaas.registry}/${project.artifactId}:${obaas.image.version}</jkube.generator.name>
   ...

<image>
<name>${obaas.registry}/${project.artifactId}:${obaas.image.version}</name>
</image>
</images>
</configuration>
</plugin>
</plugins>

<pluginManagement>
Expand Down Expand Up @@ -240,4 +266,5 @@
</build>


</project>

</project>