feat: update base example applications

.gitignore

@@ -20,4 +20,6 @@ report/
 
 kusion_state.json
 
-changed_list.txt
+changed_list.txt
+
+*.lock

README.md

@@ -1,16 +1,14 @@
-# Konfig
+# 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)
 
-[English](README.md) | [Chinese](README-zh.md)
-
-This is a example repository for [Kusion](https://github.com/KusionStack/kusion), where you can use the examples provided to quickly learn how to use Kusion.
+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).
 
 ## Getting Started
 
-If you are new to Kusion, please visit [Getting Started](https://kusionstack.io/docs/user_docs/getting-started/) to learn about Kusion. It includes installation instructions, quick start guide, and some basic concepts.
+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.
 
-All the examples are located in the `example`` directory, and you can find corresponding tutorials in the [User Guide](https://kusionstack.io/docs/user_docs/guides/).
+All guided tutorials use applications in this repository, located in the `example` directory.
 
 ## Deploying Examples
 
-You can execute the `kusion apply` command in different example directories to deploy different examples. Some examples have prerequisites, such as an accessible Kubernetes cluster or an account of a specific cloud provider. Please refer to the tutorials in the [User Guide](https://kusionstack.io/docs/user_docs/guides/) for specific prerequisites.
+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.

example/nginx/dev/kcl.mod → example/samplejob/prod/kcl.mod

@@ -1,5 +1,5 @@
 [package]
-name = "nginx"
+name = "samplejob"
 edition = "0.1.0"
 version = "0.1.0"
 

example/samplejob/prod/main.k

@@ -0,0 +1,16 @@
+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 {
+    workload: wl.Job {
+        containers: {
+            "busybox": c.Container {
+                # The target image
+                image: "busybox:1.28"
+                # Run the following command as defined
+                command: ["/bin/sh", "-c", "echo hello"]
+            }
+        }
+    }
+}

example/nginx/project.yaml → example/samplejob/project.yaml

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

example/multi-stack/base/base.k → example/service-multistack/base/base.k

@@ -3,21 +3,21 @@ import catalog.models.schema.v1.workload as wl
 import catalog.models.schema.v1.workload.network as n
 import catalog.models.schema.v1.workload.container as c
 
-helloworld: ac.AppConfiguration {
+echoserver: ac.AppConfiguration {
     workload: wl.Service {
         containers: {
-            "helloworld": c.Container {
+            "server": c.Container {
                 image = "<no value>"
                 resources: {
-                    "cpu": "500m"
-                    "memory": "512Mi"
+                    "cpu": "250m"
+                    "memory": "256Mi"
                 }
             }
         }
         replicas: 1
         ports: [
             n.Port {
-                port: 8080
+                port: 80
             }
         ]
     }

example/multi-stack/prod/kcl.mod → example/service-multistack/dev/kcl.mod

@@ -1,5 +1,5 @@
 [package]
-name = "multi-stack"
+name = "service-multistack"
 edition = "0.5.0"
 version = "0.1.0"
 

example/service-multistack/dev/main.k

@@ -0,0 +1,9 @@
+import catalog.models.schema.v1 as ac
+
+# main.k declares customized configurations for dev stack.
+echoserver: ac.AppConfiguration {
+    workload.containers.server: {
+        # dev stack use latest echoserver image
+        image = "cilium/echoserver"
+    }
+}

example/multi-stack/dev/kcl.mod → example/service-multistack/prod/kcl.mod

@@ -1,5 +1,5 @@
 [package]
-name = "multi-stack"
+name = "service-multistack"
 edition = "0.5.0"
 version = "0.1.0"
 

example/service-multistack/prod/main.k

@@ -0,0 +1,16 @@
+import catalog.models.schema.v1 as ac
+
+# main.k declares customized configurations for prod stack.
+helloworld: ac.AppConfiguration {
+    # replicas is 2 for prod
+    workload.replicas = 2
+    workload.containers.server: {
+        # prod stack use older stable echoserver image
+        image = "cilium/echoserver:1.10.3"
+        # also prod stack require more resources
+        resources = {
+            "cpu": "500m"
+            "memory": "512Mi"
+        }
+    }
+}

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

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

example/service-multistack/project.yaml

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

example/simpleservice/prod/kcl.mod

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

example/nginx/dev/main.k → example/simpleservice/prod/main.k

@@ -1,27 +1,21 @@
 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
 
-nginx: ac.AppConfiguration {
+# main.k declares desired configurations for prod stack.
+simplesvc: ac.AppConfiguration {
     workload: wl.Service {
         containers: {
-            nginx: c.Container {
+            "nginx": c.Container {
+                # use nginx:1.25.2 as target image
                 image = "nginx:1.25.2"
+                # resource requirements for nginx container
                 resources: {
                     "cpu": "500m"
                     "memory": "512Mi"
                 }
             }
         }
         replicas: 1
-        ports: [
-            n.Port {
-                type: "aliyun"
-                port: 80
-                protocol: "TCP"
-                public: True
-            }
-        ]
     }
 }

example/simpleservice/prod/stack.yaml

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

example/multi-stack/project.yaml → example/simpleservice/project.yaml

@@ -1,4 +1,4 @@
 # The project basic info
-name: multi-stack
+name: simpleservice
 generator:
   type: AppConfiguration

example/wordpress/dev/main.k

@@ -10,6 +10,7 @@ import catalog.models.schema.v1.accessories.database as db
 
 # main.k declares reusable configurations for all stacks.
 wordpress: ac.AppConfiguration {
+    # the main workload configurations
     workload: wl.Service {
         containers: {
             wordpress: c.Container {
@@ -31,6 +32,7 @@ wordpress: ac.AppConfiguration {
             }
         ]
     }
+    # database accessory configurations
     database: db.Database {
         type: "alicloud"
         engine: "MySQL"

hack/lib/common.py

@@ -15,6 +15,7 @@
 NAME = "name"
 KUSION_CMD = "kusion"
 COMPILE_CMD = "compile"
+BUILD_CMD = "build"
 PREVIEW_CMD = "preview"
 APPLY_CMD = "apply"
 NO_STYLE_FLAG = "--no-style"

hack/test_correctness.py

@@ -14,7 +14,7 @@ def test_correctness(stack_dir):
         print(f"Ignore stack {stack_dir}.")
         return
     print(f"Test correctness of stack {stack_dir}...")
-    cmd = [KUSION_CMD, COMPILE_CMD]
+    cmd = [KUSION_CMD, BUILD_CMD]
     process = subprocess.run(
         cmd, capture_output=True, cwd=Path(stack_dir), env=dict(os.environ)
     )