Release/2.5.0

.github/workflows/lint-check.yml

@@ -1,7 +1,9 @@
 name: Lint Check
 
 on:
-  push
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ develop ]
 
 jobs:
   lint:

.gitignore

@@ -8,7 +8,7 @@ node_modules
 *.DS_Store
 deployment/helm
 deployment/compose
-docker-compose.yaml
+/docker-compose.yaml
 *.egg-info
 *.idea
 /build

README.md

@@ -7,7 +7,9 @@ Can scaffold and maintain your cloud solution on top of Cloudharness without wri
 Kubernetes templates, with in place common utilities and applications already configured for you.
 
 What building your cloud solution with CloudHarness gives to you:
+
 - Common framework and utilities to develop and deploy micro-service application
+
   - Helm chart automatic generation
     - deployments
     - services
@@ -23,11 +25,13 @@ What building your cloud solution with CloudHarness gives to you:
     - databases (postgreql)
     - access gatekeepers configuration
     - secrets and configmaps
+
   * Automatic build and push of images
   * REST-API scaffolding building based on OpenApi
   * Continuous deployment script generation
   * Debug backend applications running on Kubernetes
   * Python cluster access utilities
+
 * Prebuilt support applications and shared library to:
   * Log in and user management - based on Keycloak
   * Submit batch and asynchronous workflows - based on Argo
@@ -43,17 +47,18 @@ What building your cloud solution with CloudHarness gives to you:
 
 The microservice architecture is a great to get code separation and flexible development, but may not be of easy implementation, especially for small development teams/projects.
 In particular, these questions may rise:
- - How do I create a deployment for my microservices?
- - How do I orchestrate my microservices?
- - How to create consistent api documentation?
- - Do I need to be an experienced devops to create a micro-service based application?
- - Wouldn't it be nice to develop a plain database/backend/frontend application without infrastructure boilerplate but still be able to configure everything I want when needed?
- - How to run batch operations like ETL processes easily and efficiently in a cloud environment?
- - How to manage databases without being locked to a specific vendor solution?
- - How to perform database backups?
- - How to manage secret data?
- - What about having a precounfigured account management application?
- - Sooner rather than later I'll need an orchestration queue. Why not have that just ready to use?
+
+- How do I create a deployment for my microservices?
+- How do I orchestrate my microservices?
+- How to create consistent api documentation?
+- Do I need to be an experienced devops to create a micro-service based application?
+- Wouldn't it be nice to develop a plain database/backend/frontend application without infrastructure boilerplate but still be able to configure everything I want when needed?
+- How to run batch operations like ETL processes easily and efficiently in a cloud environment?
+- How to manage databases without being locked to a specific vendor solution?
+- How to perform database backups?
+- How to manage secret data?
+- What about having a precounfigured account management application?
+- Sooner rather than later I'll need an orchestration queue. Why not have that just ready to use?
 
 # Command line tools
 
@@ -63,30 +68,34 @@ CloudHarness provides the following command line tools to help application scaff
 * `harness-application` - create a new CloudHarness REST application.
 * `harness-generate` - generates server and client code for all CloudHarness REST applications.
 * `harness-test` - run end to end tests
-  
+
 # Get started
 
 ## Prerequisites
 
 ### Operative system
 
 Cloudharness can be used on all major operative systems.
+
 - Linux: supported and tested
 - MacOS: supported and tested
 - Windows/WSL2: supported and tested
 - Windows native: mostly working, unsupported
 
 ### Python
-Python 3.9 must be installed.
+
+Python 3.10+ must be installed.
 
 It is recommended to setup a virtual environment.
 With conda:
+
 ```bash
 conda create --name ch python=3.12
 conda activate ch
 ```
 
 ### Docker
+
 [Docker](https://www.docker.com) is required to build locally.
 
 ### Kubernetes command line client
@@ -110,6 +119,7 @@ conda activate ch
 A node environment with npm is required for developing web applications and to run end to end tests.
 
 Recommended:
+
 - node >= v14.0.0
 - npm >= 8.0.0
 
@@ -120,26 +130,31 @@ A JRE is needed to run the code generators based on openapi-generator.
 For more info, see [here](https://openapi-generator.tech/docs/installation).
 
 ## CloudHarness command line tools
+
 To use the cli tools, install requirements first:
 
 ```bash
 bash install.sh
 ```
-### Generate deployment
 
-To generate a deployment, run `harness-deployment`. See [below](#Deployment) for more.
+### Create a new REST application
 
-### Create new REST application
-To create a new REST application, run `harness-application` from the root of your solution.
+`harness-application` is a command-line tool used to create new applications based on predefined code templates. It allows users to quickly scaffold applications with backend, frontend, and database configurations.
+More information can be found [here](./docs/applications/harness-application.md).
 
 ### Generate server and client code from openapi
-To (re)generate the code for your applications, run `harness-generate` from the root.
-The script will look for all openapi applications, and regenerate the Flask server code and documentation.
-Note: the script will eventually override any manually modified file. To avoid that, define a file openapi-generator-ignore.
+
+To (re)generate the code for your applications, run `harness-generate`.
+`harness-generate` is a command-line tool used to generate client code, server stubs, and model libraries for applications.
+More information can be found [here](./docs/applications/harness-generate.md)
+
+### Generate deployment
+
+To generate a deployment, run `harness-deployment`. See [below](#build-and-deploy) for more information.
 
 # Extend CloudHarness to build your project
 
-CloudHarness is born to be extended. 
+CloudHarness is born to be extended.
 
 The quickest way to start is to install Cloud Harness, copy the *blueprint* folder and build from that with the cli tools, such as
 `harness-application`, `harness-generate`, `harness-deployment`.
@@ -150,10 +165,11 @@ See the [developers documentation](docs/dev.md#start-your-project) for more info
 
 The script `harness-deployment` scans your applications and configurations to create the build and deploy artifacts.
 Created artifacts include:
- - Helm chart (or docker compose configuration file)
- - Skaffold build and run configuration
- - Visual Studio Code debug and run configuration
- - Codefresh pipeline yaml specification (optional)
+
+- Helm chart (or docker compose configuration file)
+- Skaffold build and run configuration
+- Visual Studio Code debug and run configuration
+- Codefresh pipeline yaml specification (optional)
 
 With your project folder structure looking like
 
@@ -193,5 +209,4 @@ Then, you can selectively add files related to configuration that you want to pe
 
 For more information about how to configure a deployment, see [here](./build-deploy/helm-configuration.md)
 
-
-[![Codefresh build status]( https://g.codefresh.io/api/badges/pipeline/tarelli/Cloudharness%2Funittests?type=cf-1&key=eyJhbGciOiJIUzI1NiJ9.NWFkNzMyNDIzNjQ1YWMwMDAxMTJkN2Rl.-gUEkJxH6NCCIRgSIgEikVDte-Q0BsGZKEs4uahgpzs)]( https://g.codefresh.io/pipelines/edit/new/builds?id=6034cfce1036693697cd602b&pipeline=unittests&projects=Cloudharness&projectId=6034cfb83bb11c399e85c71b)
+[![Codefresh build status](https://g.codefresh.io/api/badges/pipeline/tarelli/Cloudharness%2Funittests?type=cf-1&key=eyJhbGciOiJIUzI1NiJ9.NWFkNzMyNDIzNjQ1YWMwMDAxMTJkN2Rl.-gUEkJxH6NCCIRgSIgEikVDte-Q0BsGZKEs4uahgpzs)](https://g.codefresh.io/pipelines/edit/new/builds?id=6034cfce1036693697cd602b&pipeline=unittests&projects=Cloudharness&projectId=6034cfb83bb11c399e85c71b)

application-templates/django-app/backend/django_baseapp/asgi.py → application-templates/django-base/backend/django_baseapp/asgi.py

@@ -11,7 +11,7 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "__APP_NAME__.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_baseapp.settings")
 
 application = get_asgi_application()
 
@@ -21,6 +21,6 @@
 init_services()
 
 # start the kafka event listener
-from cloudharness_django.services.events import init_listner  # noqa E402
+from cloudharness_django.services.events import init_listener  # noqa E402
 
-init_listner()
+init_listener()

application-templates/django-app/backend/django_baseapp/wsgi.py → application-templates/django-base/backend/django_baseapp/wsgi.py

@@ -21,6 +21,6 @@
 init_services()
 
 # start the kafka event listener
-from cloudharness_django.services.events import init_listner  # noqa E402
+from cloudharness_django.services.events import init_listener  # noqa E402
 
-init_listner()
+init_listener()

application-templates/django-app/Dockerfile → application-templates/django-fastapi/Dockerfile

@@ -7,11 +7,11 @@ ENV APP_DIR=/app
 
 WORKDIR ${APP_DIR}
 COPY frontend/package.json ${APP_DIR}
-COPY frontend/package-lock.json ${APP_DIR}
-RUN npm ci
+COPY frontend/yarn.lock ${APP_DIR}
+RUN yarn install --frozen-lockfile --timeout 60000
 
 COPY frontend ${APP_DIR}
-RUN npm run build
+RUN yarn build
 
 #####
 

application-templates/django-app/README.md → application-templates/django-fastapi/README.md

@@ -31,7 +31,7 @@ See [backend/README.md#Develop]
 
 ### Frontend
 
-Backend code is inside the *frontend* directory.
+Frontend code is inside the *frontend* directory.
 
 Frontend is by default generated as a React web application, but no constraint about this specific technology.
 

application-templates/django-fastapi/api/genapi.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+ROOT_PATH=$(realpath "$(dirname "$BASH_SOURCE")/../../..")
+harness-generate servers --app-name "__APP_NAME__" "$ROOT_PATH"

application-templates/django-app/backend/django_baseapp/urls.py → application-templates/django-fastapi/backend/django_baseapp/urls.py

@@ -1,4 +1,4 @@
-"""MNP Checkout URL Configuration
+"""URL Configuration
 
 The `urlpatterns` list routes URLs to views. For more information please see:
     https://docs.djangoproject.com/en/3.2/topics/http/urls/

application-templates/django-ninja/Dockerfile

@@ -0,0 +1,35 @@
+ARG CLOUDHARNESS_FRONTEND_BUILD
+ARG CLOUDHARNESS_DJANGO
+
+FROM $CLOUDHARNESS_FRONTEND_BUILD AS frontend
+
+ARG APP_DIR=/app
+
+WORKDIR ${APP_DIR}
+COPY frontend/package.json .
+COPY frontend/yarn.lock .
+RUN yarn install --timeout 60000
+
+COPY frontend .
+RUN yarn build
+
+#####
+
+FROM $CLOUDHARNESS_DJANGO
+
+WORKDIR ${APP_DIR}
+RUN mkdir -p ${APP_DIR}/static/www
+
+COPY backend/requirements.txt ${APP_DIR}
+RUN --mount=type=cache,target=/root/.cache python -m pip install --upgrade pip &&\
+    pip3 install --no-cache-dir -r requirements.txt --prefer-binary
+
+COPY backend/requirements.txt backend/setup.py ${APP_DIR}
+RUN python3 -m pip install -e .
+
+COPY backend ${APP_DIR}
+RUN python3 manage.py collectstatic --noinput
+
+COPY --from=frontend /app/dist ${APP_DIR}/static/www
+
+ENTRYPOINT uvicorn --workers ${WORKERS} --host 0.0.0.0 --port ${PORT} django_baseapp.asgi:application