feat: merge develop-0.10.0 into main

.github/workflows/main.yml → .github/workflows/deploy/deploy.yml

@@ -1,7 +1,6 @@
+name: "Deploy"
+
 on:
-  pull_request:
-    branches:
-      - main
   push:
     branches:
       - main
@@ -18,6 +17,8 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: 3.9
+      - name: Install Pytest Html
+        run: python3 -m pip install pytest-html pyyaml -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host mirrors.aliyun.com
       - name: Git Diff
         id: git-diff
         uses: technote-space/get-diff-action@v6
@@ -77,6 +78,7 @@ jobs:
       - name: Test Correctness
         env:
           CHANGED_STACKS: ${{ needs.get-changed-project-stack.outputs.changed_stacks }}
+          WORKSPACE_FILE_DIR: workspaces
         run: python3 -m pytest -v hack/test_correctness.py --junitxml ./hack/report/test-correctness.xml --html ./hack/report/test-correctness.html
       - name: Upload Report
         if: always()
@@ -101,12 +103,15 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: 3.9
+      - name: Install Pytest Html
+        run: python3 -m pip install pytest-html pyyaml -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host mirrors.aliyun.com
       - name: Setup K3d&K3s
         uses: nolar/setup-k3d-k3s@v1
       - name: Preview
         id: preview
         env:
           CHANGED_STACKS: ${{ needs.get-changed-project-stack.outputs.changed_stacks }}
+          WORKSPACE_FILE_DIR: workspaces
         run: |
           #edit the profile in the post step does not work, source kusion env file manually
           source "$HOME/.kusion/.env"
@@ -132,12 +137,15 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: 3.9
+      - name: Install Pytest Html
+        run: python3 -m pip install pytest-html pyyaml -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host mirrors.aliyun.com
       - name: Setup K3d&K3s
         uses: nolar/setup-k3d-k3s@v1
       - name: Apply
         id: apply
         env:
           CHANGED_STACKS: ${{ needs.get-changed-project-stack.outputs.changed_stacks }}
+          WORKSPACE_FILE_DIR: workspaces
         run: |
           #edit the profile in the post step does not work, source kusion env file manually
           source "$HOME/.kusion/.env"

.gitignore

@@ -22,4 +22,7 @@ kusion_state.json
 
 changed_list.txt
 
-*.lock
+*#.lock
+
+# kusion state
+kusion_state.yaml

README.md

@@ -1,14 +1,16 @@
 # konfig
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=488867056&machine=standardLinux32gb&devcontainer_path=.devcontainer.json)
 
-konfig repository contains various example applications code, you can use these example applications to quickly try out and learn how to use [Kusion](https://github.com/KusionStack/kusion).
+konfig contains various example applications code, you can use these example applications to quickly try out and learn how to use [Kusion](https://github.com/KusionStack/kusion).
 
-## Getting Started
+If you're new to Kusion, it's a good idea to start by [Getting Started](https://www.kusionstack.io/docs/kusion/getting-started/install-kusion), which includes quickstart installation, guided tutorials and deployment instructions. Then you can go to [User Guides](https://www.kusionstack.io/docs) to find more Kusion practical application scenarios, and konfig holds the corresponding examples of the user guides.
 
-If you're new to Kusion, start by reviewing the [Getting Started](https://www.kusionstack.io/docs/user_docs/getting-started/) page, which includes quickstart installation, guided tutorials and deployment instructions.
+## konfig examples
 
-All guided tutorials use applications in this repository, located in the `example` directory.
-
-## Deploying Examples
-
-You can experiment with the different examples by entering each directory and running `kusion apply`. Some examples have prerequisites, e.g. accessible Kubernetes cluster or account for cloud provider. Please refer to guided tutorials in the [User Guide](https://www.kusionstack.io/docs/user_docs/guides/) for specific prerequisites.
+| name                                               | description                                                                    |user guide|
+|----------------------------------------------------|--------------------------------------------------------------------------------|----------|
+| [nginx](example/nginx)                             | An exposing nginx service.                                                     |[Expose Application Service Deployed on CSP Kubernetes](https://www.kusionstack.io/docs/kusion/user-guides/cloud-resources/expose-service)|
+| [simple-job](example/simple-job)                   | An one-off or recurring execution task.                                        |[Schedule a Job](https://www.kusionstack.io/docs/kusion/user-guides/working-with-k8s/job)|
+| [service-multi-stack](example/service-multi-stack) | A project which contains multiple stacks.                                      |[Deploy Application Securely and Efficiently via GitHub Actions](https://www.kusionstack.io/docs/kusion/user-guides/github-actions/deploy-application-via-github-actions)|
+| [simple-service](example/simple-service)           | A simple service only contains workload resources.                             |[Deploy Application](https://www.kusionstack.io/docs/kusion/user-guides/working-with-k8s/deploy-application)|
+| [wordpress-cloud-rds](example/wordpress-cloud-rds) | The wordpress application which contains workload and cloud database resource. |[Deliver the WordPress Application with Cloud RDS](https://www.kusionstack.io/docs/next/kusion/user-guides/cloud-resources/database)|
+| [wordpress-local-db](example/wordpress-lcoal-db)   | The wordpress application which contains workload and local database resource. |[Deliver the WordPress Application on Kubernetes](https://www.kusionstack.io/docs/kusion/getting-started/deliver-wordpress)|

example/sample-job/prod/kcl.mod → example/nginx/dev/kcl.mod

@@ -1,10 +1,10 @@
 [package]
-name = "sample-job"
-edition = "0.1.0"
+name = "nginx"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.1" }
+catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+
 [profile]
 entries = ["main.k"]
 

example/simple-service/prod/main.k → example/nginx/dev/main.k

@@ -1,21 +1,26 @@
 import catalog.models.schema.v1 as ac
 import catalog.models.schema.v1.workload as wl
 import catalog.models.schema.v1.workload.container as c
+import catalog.models.schema.v1.workload.network as n
 
-# main.k declares desired configurations for prod stack.
-simplesvc: ac.AppConfiguration {
+nginx: ac.AppConfiguration {
     workload: wl.Service {
         containers: {
-            "nginx": c.Container {
-                # use nginx:1.25.2 as target image
+            wordpress: c.Container {
                 image = "nginx:1.25.2"
-                # resource requirements for nginx container
                 resources: {
                     "cpu": "500m"
                     "memory": "512Mi"
                 }
             }
         }
         replicas: 1
+        ports: [
+            n.Port {
+                port: 80
+                protocol: "TCP"
+                public: True
+            }
+        ]
     }
 }

example/simple-service/prod/stack.yaml → example/nginx/dev/stack.yaml

@@ -1,2 +1,2 @@
 # The stack basic info
-name: prod
+name: dev

example/nginx/project.yaml

@@ -0,0 +1,4 @@
+# The project basic info
+name: nginx
+generator:
+  type: AppConfiguration

example/service-multi-stack/dev/kcl.mod

@@ -1,10 +1,10 @@
 [package]
-name = "service-multi-stack"
-edition = "0.5.0"
+name = "service-multi-stack-dev"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.0" }
+catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+
 [profile]
 entries = ["../base/base.k", "main.k"]
 

example/service-multi-stack/prod/kcl.mod

@@ -1,10 +1,9 @@
 [package]
-name = "service-multi-stack"
-edition = "0.5.0"
+name = "service-multi-stack-prod"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.0" }
+catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
 
 [profile]
 entries = ["../base/base.k", "main.k"]

example/wordpress/dev/kcl.mod → example/simple-job/dev/kcl.mod

@@ -1,10 +1,9 @@
 [package]
-name = "wordpress"
-edition = "0.5.0"
+name = "simple-job"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.0" }
+catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
 
 [profile]
-entries = ["main.k","platform.k"]
+entries = ["main.k"]

example/sample-job/prod/main.k → example/simple-job/dev/main.k

@@ -2,7 +2,7 @@ import catalog.models.schema.v1 as ac
 import catalog.models.schema.v1.workload as wl
 import catalog.models.schema.v1.workload.container as c
 
-samplejob: ac.AppConfiguration {
+helloworld: ac.AppConfiguration {
     workload: wl.Job {
         containers: {
             "busybox": c.Container {

example/sample-job/project.yaml → example/simple-job/project.yaml

@@ -1,4 +1,4 @@
 # The project basic info
-name: sample-job
+name: simple-job
 generator:
   type: AppConfiguration

example/simple-service/prod/kcl.mod → example/simple-service/dev/kcl.mod

@@ -1,10 +1,10 @@
 [package]
 name = "simple-service"
-edition = "0.1.0"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.1" }
+catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+
 [profile]
 entries = ["main.k"]
 

example/simple-service/dev/main.k

@@ -0,0 +1,48 @@
+import catalog.models.schema.v1 as ac
+import catalog.models.schema.v1.workload as wl
+import catalog.models.schema.v1.workload.container as c
+import catalog.models.schema.v1.workload.container.probe as p
+import catalog.models.schema.v1.workload.network as n
+import catalog.models.schema.v1.monitoring as m
+import catalog.models.schema.v1.trait as t
+
+helloworld: ac.AppConfiguration {
+    workload: wl.Service {
+        containers: {
+            "helloworld": c.Container {
+                image: "gcr.io/google-samples/gb-frontend:v4"
+                env: {
+                    "env1": "VALUE"
+                    "env2": "VALUE2"
+                }
+                resources: {
+                    "cpu": "500m"
+                    "memory": "512M"
+                }
+                # Configure an HTTP readiness probe
+                readinessProbe: p.Probe {
+                    probeHandler: p.Http {
+                        url: "http://localhost:80"
+                    }
+                    initialDelaySeconds: 10
+                }
+            }
+        }
+        replicas: 2
+        # Comment the following block to un-expose service 
+        ports: [
+            n.Port {
+                port: 8080
+                targetPort: 80
+            }
+        ]
+    }
+    # Comment the following block to remove opsRule 
+    opsRule: t.OpsRule {
+        maxUnavailable: "30%"
+    }
+    # Comment the following block to disable monitoring 
+    monitoring: m.Prometheus{
+        path:           "/metrics"
+    }
+}

example/sample-job/prod/stack.yaml → example/simple-service/dev/stack.yaml

@@ -1,2 +1,2 @@
 # The stack basic info
-name: prod
+name: dev

example/wordpress-cloud-rds/prod/kcl.mod

@@ -0,0 +1,10 @@
+[package]
+name = "wordpress-cloud-rds"
+version = "0.1.0"
+
+[dependencies]
+catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+
+[profile]
+entries = ["main.k"]
+

example/wordpress-cloud-rds/prod/main.k

@@ -0,0 +1,38 @@
+import catalog.models.schema.v1 as ac
+import catalog.models.schema.v1.workload as wl
+import catalog.models.schema.v1.workload.container as c
+import catalog.models.schema.v1.workload.network as n
+import catalog.models.schema.v1.accessories.mysql
+
+# main.k declares customized configurations for prod stacks.
+wordpress: ac.AppConfiguration {
+    workload: wl.Service {
+        containers: {
+            wordpress: c.Container {
+                image: "wordpress:6.3"
+                env: {
+                    "WORDPRESS_DB_HOST": "$(KUSION_DB_HOST_WORDPRESS_MYSQL)"
+                    "WORDPRESS_DB_USER": "$(KUSION_DB_USERNAME_WORDPRESS_MYSQL)"
+                    "WORDPRESS_DB_PASSWORD": "$(KUSION_DB_PASSWORD_WORDPRESS_MYSQL)"
+                    "WORDPRESS_DB_NAME": "mysql"
+                }
+                resources: {
+                    "cpu": "500m"
+                    "memory": "512Mi"
+                }
+            }
+        }
+        replicas: 1
+        ports: [
+            n.Port {
+                port: 80
+            }
+        ]
+    }
+    database: {
+        wordpress: mysql.MySQL {
+            type: "cloud"
+            version: "8.0"
+        }
+    }
+}

example/wordpress-cloud-rds/prod/stack.yaml

@@ -0,0 +1,2 @@
+# The stack basic info
+name: prod

example/wordpress/project.yaml → example/wordpress-cloud-rds/project.yaml

@@ -1,4 +1,4 @@
 # The project basic info
-name: wordpress
+name: wordpress-cloud-rds
 generator:
   type: AppConfiguration

example/wordpress-local-db/prod/kcl.mod

@@ -0,0 +1,10 @@
+[package]
+name = "wordpress-local-db"
+version = "0.1.0"
+
+[dependencies]
+catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+
+[profile]
+entries = ["main.k"]
+

example/wordpress-local-db/prod/main.k

@@ -0,0 +1,34 @@
+import catalog.models.schema.v1 as ac
+import catalog.models.schema.v1.workload as wl
+import catalog.models.schema.v1.workload.container as c
+import catalog.models.schema.v1.workload.network as n
+import catalog.models.schema.v1.accessories.mysql
+
+# main.k declares customized configurations for prod stack. 
+wordpress: ac.AppConfiguration {
+    workload: wl.Service {
+        containers: {
+            wordpress: c.Container {
+                image: "wordpress:6.3"
+                env: {
+                    "WORDPRESS_DB_HOST": "$(KUSION_DB_HOST_WORDPRESS_MYSQL)"
+                    "WORDPRESS_DB_USER": "$(KUSION_DB_USERNAME_WORDPRESS_MYSQL)"
+                    "WORDPRESS_DB_PASSWORD": "$(KUSION_DB_PASSWORD_WORDPRESS_MYSQL)"
+                    "WORDPRESS_DB_NAME": "mysql"
+                }
+            }
+        }
+        replicas: 1
+        ports: [
+            n.Port {
+                port: 80
+            }
+        ]
+    }
+    database: {
+        wordpress: mysql.MySQL {
+            type: "local"
+            version: "8.0"
+        }
+    }
+}

example/wordpress-local-db/prod/stack.yaml

@@ -0,0 +1,2 @@
+# The stack basic info
+name: prod

example/wordpress-local-db/project.yaml

@@ -0,0 +1,4 @@
+# The project basic info
+name: wordpress-local-db
+generator:
+  type: AppConfiguration