Merge pull request #619 from kubero-dev/main-refactored

Kubero V3 refactoring

Author: mms-gianni

.dockerignore

@@ -1,4 +1,4 @@
-**/node_modules_AAAA
+**/node_modules
 Dockerfile
 .dockerignore
 .git
@@ -9,4 +9,4 @@ docker-compose.*
 kind.*
 .eslintrc.js
 README.md
-**/dist_AAAAA
+**/dist

.github/workflows/docker-prerelease.yaml

@@ -74,7 +74,7 @@ jobs:
       # https://github.com/docker/build-push-action
       - name: Build and push Docker image
         id: kubero-build-and-push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: true

.github/workflows/jest-codecov.yaml

@@ -0,0 +1,20 @@
+name: 'Jest Codecov'
+on:
+  workflow_dispatch:
+defaults:
+  run:
+    working-directory: ./server
+jobs:
+  codecov:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4         # checkout the repo
+      - name: Install dependencies        # install dependencies
+        run: yarn install --frozen-lockfile
+      - run: yarn build                   # install packages
+      - run: yarn test                    # run tests (configured to use jest-junit reporter)
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          directory: server/coverage
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/jest-pr.yaml

@@ -0,0 +1,29 @@
+name: 'Jest PR Test'
+on:
+  pull_request:
+  workflow_dispatch:
+permissions:
+  pull-requests: write
+defaults:
+  run:
+    working-directory: ./server
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4         # checkout the repo
+      - name: Install dependencies        # install dependencies
+        run: yarn install --frozen-lockfile
+      - run: yarn build                   # install packages
+      - run: yarn test:ci                 # run tests (configured to use jest-junit reporter)
+      - name: Jest Coverage Comment
+        uses: MishaKav/jest-coverage-comment@main
+        with:
+          coverage-summary-path: server/coverage/coverage-summary.json
+          junitxml-path: server/reports/jest-junit.xml
+      - uses: actions/upload-artifact@v4  # upload test results
+        if: ${{ !cancelled() }}           # run this step even if previous step failed
+        with:
+          name: test-results              # Name of the check run which will be created
+          path: server/reports/jest-junit.xml
+          reporter: jest-junit            # Format of test results

.github/workflows/jest-report.yaml

@@ -0,0 +1,20 @@
+name: 'Jest Test Report'
+on:
+  workflow_run:
+    workflows: ['Jest PR Test']                     # runs after 'Jest PR Test' workflow
+    types:
+      - completed
+permissions:
+  contents: read
+  actions: read
+  checks: write
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: dorny/test-reporter@v2
+      with:
+        artifact: test-results            # artifact name
+        name: JEST Tests                  # Name of the check run which will be created
+        path: '*.xml'                     # Path to test results (inside artifact .zip)
+        reporter: jest-junit              # Format of test results

.github/workflows/stargazers.yaml

@@ -8,14 +8,21 @@ jobs:
     name: 'stargazers'
     runs-on: ubuntu-latest
     steps:
-      - name: 💌 Send email, you star
+      - name: Send email
         uses: dawidd6/[email protected]
         with:
           server_address: smtp.gmail.com
           server_port: 465
           username: ${{ secrets.GMAIL_USER }}
           password: ${{ secrets.GMAIL_PASS }}
-          subject: Your a star ✨
-          body: ${{ github.actor }} just starred your mail-on-star repo!!! ${{ github.repository }}
+          subject: ${{ github.event.repository.stargazers_count }} ✨ ${{ github.actor }} stared ${{ github.repository }}
+          body: | 
+            ${{ github.actor }} just starred your mail-on-star repo!!! 
+            ${{ github.event.repository.html_url }}
+            Forks: ${{ github.event.repository.forks_count }}
+            Stars: ${{ github.event.repository.stargazers_count }}
+            Issues: ${{ github.event.repository.open_issues_count }}
+            
+            ${{ github.repository }}
           to: ${{ secrets.GMAIL_ADDRESS }}
           from: ${{ secrets.GMAIL_ADDRESS }}

CONTRIBUTING.md

@@ -13,17 +13,22 @@ Willing to contribute something, but you don't know where to start? Have a look
 5. Open a PR
 
 ## Techstack
-**Infrastructure**
-- [Kubernetes](https://kubernetes.io/)
-- [Operator SDK](https://sdk.operatorframework.io/)
-- [Helm (Operator)](https://helm.sh/)
-- [Kind (Development)](https://kind.sigs.k8s.io/)
-
-**Code**
-- [Express](https://expressjs.com/)
-- [TypeScript](https://www.typescriptlang.org/)
-- [Vue.js](https://vuejs.org/)
-- [Vuetify](https://vuetifyjs.com/en/)
+- Backend
+  - [NestJS](https://nestjs.com/)
+  - [TypeScript](https://www.typescriptlang.org/)
+  - [Jest](https://jestjs.io/)
+- Frontend
+  - [Vue.js](https://vuejs.org/)
+  - [Vuetify](https://vuetifyjs.com/en/)
+- CLI
+  - [Go](https://golang.org/)
+  - [Cobra](https://cobra.dev/)
+- Operator
+  - [Operator SDK](https://sdk.operatorframework.io/)
+  - [Helm](https://helm.sh/)
+- Infrastructure 
+  - [Kubernetes](https://kubernetes.io/)
+  - [Kind (Development)](https://kind.sigs.k8s.io/)
 
 
 ## Development setup for the Kubero UI

Dockerfile

@@ -8,8 +8,7 @@ COPY server ./server
 RUN cd /build/server && \
     yarn install
 RUN cd /build/server && \
-    yarn build && \
-    yarn swaggergen
+    yarn build
 
 ## Client
 COPY client ./client
@@ -18,7 +17,7 @@ RUN cd /build/client && \
 RUN cd /build/client && \
     yarn build 
 
-FROM build AS release
+FROM node:22-alpine AS release
 ARG VERSION=unknown
 
 LABEL maintainer='www.kubero.dev'
@@ -30,13 +29,15 @@ WORKDIR /app/
 
 COPY --from=build /build/server/dist /app/server
 COPY --from=build /build/server/package.json /app/server/package.json
-COPY --from=build /build/server/src/modules/templates /app/server/modules/templates
+COPY --from=build /build/server/src/deployments/templates /app/server/deployments/templates
 COPY --from=build /build/server/node_modules /app/server/node_modules
-COPY --from=build /build/server/swagger.json /app/swagger.json
+
+# temporary fix for the public folder
+COPY --from=build /build/server/dist/public /app/server/public
 
 
 RUN echo -n $VERSION > /app/server/VERSION
 
 WORKDIR /app/server
 
-CMD [ "node", "index.js" ]
+CMD [ "node", "main" ]

README.md

@@ -4,40 +4,36 @@
 
 [![License](https://img.shields.io/github/license/kubero-dev/kubero?style=flat-square&color=blue")](https://github.com/kubero-dev/kubero/blob/main/LICENSE) 
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/kubero-dev/kubero?style=flat-square&color=brightgreen)](https://github.com/kubero-dev/kubero/releases/latest)
+[![codecov](https://codecov.io/github/kubero-dev/kubero/branch/main-refactored/graph/badge.svg?token=3J3CWUXG5Z&style=flat-square)](https://codecov.io/github/kubero-dev/kubero)
 [![Discord](https://img.shields.io/discord/1051249947472826408?style=flat-square)](https://discord.gg/tafRPMWS4r)
 [![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/kubero-dev/kubero?style=flat-square)](https://github.com/kubero-dev/kubero/releases/latest)
 [![Demo](https://img.shields.io/badge/demo-up-sucess?style=flat-square&color=blue)](https://demo.kubero.dev)
 
 Kubero [pronounced: Kube Hero] is a self-hosted PaaS (Platform as a Service) that allows any developer to deploy their application on Kubernetes without specialized knowledge. Kubero follows the principles of 12-factor apps. It is possible to run apps based on existing containers or from source code.
 
-> [!NOTE] 
-> Kubero v3.0.0 is on the way! 
-> 
-> We're gearing up for the Kubero v3.0.0 release! 🎉 This major update features a rewritten backend, now powered by NestJS, bringing best practices and maintainability.
-
 ![](https://raw.githubusercontent.com/kubero-dev/docs/refs/heads/main/static/assets/screenshots/createapp.gif)
 
 More [Screenshots](https://www.kubero.dev/docs/screenshots) and a full video on
 [YouTube](https://www.youtube.com/watch?v=kmqhddc6UlI)
 
 ## Features ([DEMO](https://demo.kubero.dev))
-- **CI/CD Pipelines:** Create unlimited pipelines with up to 4 separate staging environments for all your applications.  
-- **GitOps Review Apps:** Automatically build, start, and clean up review apps when opening or closing pull requests.  
-- **Automatic Redeployments:** Trigger app redeployments on pushes to branches or tags.  
-- **Docker Deployments:** Deploy Docker containers on Kubernetes without needing Helm charts.  
-- **App Templates:** Deploy popular applications like WordPress and Grafana with ready-to-use templates.  
-- **Add-ons Integration:** Seamlessly deploy add-ons such as PostgreSQL and Redis alongside your applications.  
-- **API & CLI:** Integrate seamlessly with existing tools and CI/CD workflows.  
-- **Metrics & Monitoring:** Access integrated metrics to monitor application health.  
-- **Notifications:** Get build and deployment updates via Discord, Slack, or Webhooks.  
-- **Vulnerability Scans:** Perform scheduled or triggered scans for running applications.  
-- **Application Logs:** View logs directly from the web UI for easy monitoring.  
-- **Safe Restarts:** Restart applications safely and easily through the web UI.  
-- **Web Console:** Use the built-in container web console for direct access.  
-- **Scheduled Tasks:** Easily create and manage cronjobs.  
-- **Multi-Tenancy:** Support for managing multiple tenants.  
-- **Single Sign-On (SSO):** Authenticate securely with GitHub and OAuth2.  
-- **Basic Auth:** Configure Basic Auth for your applications with ease. 
+- **CI/CD Pipelines** <br> Create unlimited pipelines with up to 4 separate staging environments for all your applications.  
+- **GitOps Review Apps** <br>  Automatically build, start, and clean up review apps when opening or closing pull requests.  
+- **Automatic Redeployments** <br> Trigger app redeployments on pushes to branches or tags.  
+- **Docker Deployments** <br> Deploy Docker containers on Kubernetes without needing Helm charts.  
+- **App Templates** <br> Deploy popular applications like WordPress and Grafana with ready-to-use templates.  
+- **Add-ons Integration** <br> Seamlessly deploy add-ons such as PostgreSQL and Redis alongside your applications.  
+- **API & CLI** <br> Integrate seamlessly with existing tools and CI/CD workflows.  
+- **Metrics & Monitoring** <br> Access integrated metrics to monitor application health.  
+- **Notifications** <br> Get build and deployment updates via Discord, Slack, or Webhooks.  
+- **Vulnerability Scans** <br> Perform scheduled or triggered scans for running applications.  
+- **Application Logs** <br> View logs directly from the web UI for easy monitoring.  
+- **Safe Restarts** <br> Restart applications safely and easily through the web UI.  
+- **Web Console** <br> Use the built-in container web console for direct access.  
+- **Scheduled Tasks** <br> Easily create and manage cronjobs.  
+- **Multi-Tenancy** <br> Support for managing multiple tenants.  
+- **Single Sign-On (SSO)** <br> Authenticate securely with GitHub and OAuth2.  
+- **Basic Auth** <br> Configure Basic Auth for your applications with ease. 
 
 
 ## Basic Concept 
@@ -134,11 +130,28 @@ Basically *everything* that can be packaged in a single container can be deploye
 
 Kubero starts now building your app. Once the build is complete, Kubero will launch the final container and make it accessible via the configured domain. 
 
-## Documentation
-https://www.kubero.dev/docs/quickstart
-
-## Roadmap
-https://github.com/orgs/kubero-dev/projects/1/views/3
+## Techstack
+
+- Backend
+  - [NestJS](https://nestjs.com/)
+  - [TypeScript](https://www.typescriptlang.org/)
+  - [Jest](https://jestjs.io/)
+- Frontend
+  - [Vue.js](https://vuejs.org/)
+  - [Vuetify](https://vuetifyjs.com/en/)
+- CLI
+  - [Go](https://golang.org/)
+  - [Cobra](https://cobra.dev/)
+- Operator
+  - [Operator SDK](https://sdk.operatorframework.io/)
+  - [Helm](https://helm.sh/)
+- Infrastructure 
+  - [Kubernetes](https://kubernetes.io/)
+  - [Kind (Development)](https://kind.sigs.k8s.io/)
+
+## Links
+- Documentation https://www.kubero.dev/docs/
+- Roadmap https://github.com/orgs/kubero-dev/projects/1/views/3
 
 ## Community
 [![kubero Discord server Banner](https://discordapp.com/api/guilds/1051249947472826408/widget.png?style=banner2)](https://discord.gg/tafRPMWS4r)

SECURITY.md

@@ -5,6 +5,7 @@
 | Version | Supported          |
 | ------- | ------------------ |
 | 2.X.X   | :white_check_mark: |
+| 2.X.X   | EOL 31.03.2025     |
 | 1.X.X   | EOL 28.09.2024     |
 | 0.X.X   |                    |
 

client/package.json

@@ -3,8 +3,8 @@
   "private": true,
   "license": "GPL-3.0",
   "scripts": {
-    "dev": "vite",
-    "watch": "vue-tsc --noEmit && vite build --watch",
+    "run": "vite",
+    "dev": "vue-tsc --noEmit && vite build --watch",
     "build": "vue-tsc --noEmit && vite build",
     "preview": "vite preview",
     "lint": "eslint . --fix --ignore-path .gitignore"
@@ -44,8 +44,8 @@
     "sass": "^1.60.0",
     "typescript": "^5.0.0",
     "unplugin-fonts": "^1.0.3",
-    "vite": "^5.1.8",
-    "vite-plugin-vuetify": "^1.0.0",
-    "vue-tsc": "^2.1.0"
+    "vite": "^6.3.4",
+    "vite-plugin-vuetify": "^2.1.1",
+    "vue-tsc": "^2.2.10"
   }
 }

client/src/components/apps/addons.vue

@@ -281,7 +281,7 @@ export default defineComponent({
             this.dialog = true;
         },
         loadStorageClasses() {
-            axios.get(`/api/config/storageclasses`)
+            axios.get(`/api/kubernetes/storageclasses`)
             .then(response => {
                 for (let storageClass of response.data) {
                     this.availableStorageClasses.push({

client/src/components/apps/alerts.vue

@@ -84,7 +84,7 @@ export default {
             }, 10000);
         },
         loadRules() {
-            axios.get(`/api/rules/${this.pipeline}/${this.phase}/${this.app}`)
+            axios.get(`/api/metrics/rules/${this.pipeline}/${this.phase}/${this.app}`)
             .then(response => {
                 this.rules = response.data
             })

client/src/components/apps/appstats.vue

@@ -480,7 +480,7 @@ export default defineComponent({
     },
     methods: {
         loadUptimes() {
-            axios.get(`/api/uptimes/${this.pipeline}/${this.phase}`)
+            axios.get(`/api/metrics/uptimes/${this.pipeline}/${this.phase}`)
             .then(response => {
                 this.uptimes = response.data;
                 this.loadMetrics();
@@ -491,7 +491,7 @@ export default defineComponent({
         },
 
         loadMetrics() {
-            axios.get(`/api/metrics/${this.pipeline}/${this.phase}/${this.app}`)
+            axios.get(`/api/metrics/resources/${this.pipeline}/${this.phase}/${this.app}`)
             .then(response => {
                 for (var i = 0; i < response.data.length; i++) {
                     if (response.data[i].cpu.percentage != null && response.data[i].memory.percentage != null) {

client/src/components/apps/buildsform.vue

@@ -137,7 +137,7 @@ export default defineComponent({
         const repoB64 = btoa(this.appData?.spec.gitrepo.ssh_url)
         //const provider = this.appData?.spec.gitrepo.provider
         const provider = "github" // TODO: FIX: get provider from appData
-        axios.get(`/api/repo/${provider}/${repoB64}/references/list`)
+        axios.get(`/api/repo/${provider}/${repoB64}/references`)
         .then(response => {
             this.references = response.data
         })

client/src/components/apps/console.vue

@@ -109,7 +109,7 @@ export default defineComponent({
     }),
     methods: {
         loadPods() {
-            axios.get(`/api/status/pods/${this.pipeline}/${this.phase}/${this.app}`).then((response) => {
+            axios.get(`/api/apps/${this.pipeline}/${this.phase}/${this.app}/pods`).then((response) => {
                 //this.loadContainers();
                 for (let pod of response.data) {
                     const p = {name: pod.name, containers: pod.containers.map((c: any) => c.name)} as Pod;
@@ -258,7 +258,7 @@ export default defineComponent({
             });
         },
         execInContainer(){
-            axios.post(`/api/console/${this.pipeline}/${this.phase}/${this.app}/exec`, {
+            axios.post(`/api/apps/${this.pipeline}/${this.phase}/${this.app}/console`, {
                 podName: this.pod.name,
                 containerName: this.container,
                 command: this.command,