rkbadatya / quick-start

Micronaut Quick -start Application

Micronaut 2.5.5 Documentation

• User Guide
• API Reference
• Configuration Reference
• Micronaut Guides

---

Push To Docker Registry Workflow

Workflow file: .github/workflows/maven.yml

Workflow description

For pushes to the master branch, the workflow will:

1. Setup the build environment with respect to the selected java/graalvm version.
2. Login to docker registry based on provided configuration.
3. Build, tag and push Docker image with Micronaut application to the Docker container image.

Dependencies on other GitHub Actions

• Docker login(docker/login)
• Setup GraalVM(DeLaGuardo/setup-graalvm)

Setup

Add the following GitHub secrets:

Name	Description
DOCKER_USERNAME	Username for Docker registry authentication.
DOCKER_PASSWORD	Docker registry password.
DOCKER_REPOSITORY_PATH	Path to the docker image repository inside the registry, e.g. for the image foo/bar/micronaut:0.1 it is foo/bar.
DOCKER_REGISTRY_URL	Docker registry url.

Configuration examples

Specifics on how to configure public cloud docker registries like DockerHub, Google Container Registry (GCR), AWS Container Registry (ECR), Oracle Cloud Infrastructure Registry (OCIR) and many more can be found in docker/login-action documentation.

DockerHub

• DOCKER_USERNAME - DockerHub username
• DOCKER_PASSWORD - DockerHub password or personal access token
• DOCKER_REPOSITORY_PATH - DockerHub organization or the username in case of personal registry
• DOCKER_REGISTRY_URL - No need to configure for DockerHub

See docker/login-action for GCR

Google Container Registry (GCR)

Create service account with permission to edit GCR or use predefined Storage Admin role.

• DOCKER_USERNAME - set exactly to _json_key
• DOCKER_PASSWORD - content of the service account json key file
• DOCKER_REPOSITORY_PATH - <project-id>/foo
• DOCKER_REGISTRY_URL - gcr.io

See docker/login-action for GCR

AWS Elastic Container Registry (ECR)

Create IAM user with permission to push to ECR (or use AmazonEC2ContainerRegistryFullAccess role).

• DOCKER_USERNAME - access key ID
• DOCKER_PASSWORD - secret access key
• DOCKER_REPOSITORY_PATH - no need to set
• DOCKER_REGISTRY_URL - set to <aws-account-number>.dkr.ecr.<region>.amazonaws.com

See docker/login-action for ECR

Oracle Infrastructure Cloud Registry (OCIR)

Create auth token for authentication.

• DOCKER_USERNAME - username in format <tenancy>/<username>
• DOCKER_PASSWORD - account auth token
• DOCKER_REPOSITORY_PATH - <tenancy>/<registry>/foo
• DOCKER_REGISTRY_URL - set to <region>.ocir.io

See docker/login-action for OCIR

Push GraalVM Native Image To Docker Registry Workflow

Workflow file: .github/workflows/graalvm.yml

Workflow description

For pushes to the master branch, the workflow will:

1. Setup the build environment with respect to the selected java/graalvm version.
2. Login to docker registry based on provided configuration.
3. Build, tag and push Docker image with Micronaut application to the Docker container image.

Dependencies on other GitHub Actions

• Docker login(docker/login)
• Setup GraalVM(DeLaGuardo/setup-graalvm)

Setup

Add the following GitHub secrets:

Name	Description
DOCKER_USERNAME	Username for Docker registry authentication.
DOCKER_PASSWORD	Docker registry password.
DOCKER_REPOSITORY_PATH	Path to the docker image repository inside the registry, e.g. for the image foo/bar/micronaut:0.1 it is foo/bar.
DOCKER_REGISTRY_URL	Docker registry url.

Configuration examples

Specifics on how to configure public cloud docker registries like DockerHub, Google Container Registry (GCR), AWS Container Registry (ECR), Oracle Cloud Infrastructure Registry (OCIR) and many more can be found in docker/login-action documentation.

DockerHub

• DOCKER_USERNAME - DockerHub username
• DOCKER_PASSWORD - DockerHub password or personal access token
• DOCKER_REPOSITORY_PATH - DockerHub organization or the username in case of personal registry
• DOCKER_REGISTRY_URL - No need to configure for DockerHub

See docker/login-action for GCR

Google Container Registry (GCR)

Create service account with permission to edit GCR or use predefined Storage Admin role.

• DOCKER_USERNAME - set exactly to _json_key
• DOCKER_PASSWORD - content of the service account json key file
• DOCKER_REPOSITORY_PATH - <project-id>/foo
• DOCKER_REGISTRY_URL - gcr.io

See docker/login-action for GCR

AWS Elastic Container Registry (ECR)

Create IAM user with permission to push to ECR (or use AmazonEC2ContainerRegistryFullAccess role).

• DOCKER_USERNAME - access key ID
• DOCKER_PASSWORD - secret access key
• DOCKER_REPOSITORY_PATH - no need to set
• DOCKER_REGISTRY_URL - set to <aws-account-number>.dkr.ecr.<region>.amazonaws.com

See docker/login-action for ECR

Oracle Infrastructure Cloud Registry (OCIR)

Create auth token for authentication.

• DOCKER_USERNAME - username in format <tenancy>/<username>
• DOCKER_PASSWORD - account auth token
• DOCKER_REPOSITORY_PATH - <tenancy>/<registry>/foo
• DOCKER_REGISTRY_URL - set to <region>.ocir.io

See docker/login-action for OCIR

Feature github-workflow-docker-registry documentation

• https://docs.github.com/en/free-pro-team@latest/actions

Feature jdbc-hikari documentation

• Micronaut Hikari JDBC Connection Pool documentation

Feature assertj documentation

• https://assertj.github.io/doc/

Feature http-client documentation

• Micronaut HTTP Client documentation

Feature views-thymeleaf documentation

• Micronaut Thymeleaf views documentation

• https://www.thymeleaf.org/

Feature jax-rs documentation

• Micronaut JAX-RS support documentation

Feature spring documentation

• Micronaut Spring Framework Annotations documentation

Feature dekorate-prometheus documentation

• Micronaut Dekorate Prometheus Support documentation

• https://github.com/dekorateio/dekorate#prometheus-annotations

Feature github-workflow-graal-docker-registry documentation

• https://docs.github.com/en/free-pro-team@latest/actions

Feature kubernetes documentation

• Micronaut Kubernetes Support documentation

• https://kubernetes.io/docs/home/

Feature openapi documentation

• Micronaut OpenAPI Support documentation

• https://www.openapis.org

Feature hibernate-validator documentation

• Micronaut Hibernate Validator documentation

Feature management documentation

• Micronaut Management documentation

Feature cache-ehcache documentation

• Micronaut EHCache Cache documentation

• https://www.ehcache.org/

Feature jmx documentation

• Micronaut JMX endpoints documentation

Feature dekorate-kubernetes documentation

• Micronaut Dekorate Kubernetes Support documentation

• https://github.com/dekorateio/dekorate#kubernetes

Feature dekorate-jaeger documentation

• Micronaut Dekorate Jaeger Support documentation

• https://github.com/dekorateio/dekorate#jaeger-annotations

Feature hibernate-jpa documentation

• Micronaut Hibernate JPA documentation

Feature mockito documentation

• https://site.mockito.org