docs: update examples to reflect kusion modules (#154)

KusionStack · Mar 28, 2024 · a6e8836 · a6e8836
1 parent e8671c4
commit a6e8836
Show file tree

Hide file tree

Showing 15 changed files with 103 additions and 78 deletions.
diff --git a/example/nginx/dev/kcl.mod b/example/nginx/dev/kcl.mod
@@ -3,7 +3,8 @@ name = "nginx"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+kam = { git = "https://github.com/KusionStack/kam.git", tag = "0.1.0" }
+network = { oci = "oci://ghcr.io/kusionstack/network", tag = "0.1.0" }
 
 [profile]
 entries = ["main.k"]

diff --git a/example/nginx/dev/main.k b/example/nginx/dev/main.k
@@ -1,7 +1,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
-import catalog.models.schema.v1.workload.network as n
+import kam.v1.app_configuration as ac
+import kam.v1.workload as wl
+import kam.v1.workload.container as c
+import network as n
 
 nginx: ac.AppConfiguration {
     workload: wl.Service {
@@ -15,12 +15,16 @@ nginx: ac.AppConfiguration {
             }
         }
         replicas: 1
-        ports: [
-            n.Port {
-                port: 80
-                protocol: "TCP"
-                public: True
-            }
-        ]
+    }
+    accessories: {
+        "network": n.Network {
+            ports: [
+                n.Port {
+                    port: 80
+                    protocol: "TCP"
+                    public: True
+                }
+            ]
+        }
     }
 }
diff --git a/example/service-multi-stack/base/base.k b/example/service-multi-stack/base/base.k
@@ -1,7 +1,7 @@
-import catalog.models.schema.v1 as ac
-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
+import kam.v1.app_configuration as ac
+import kam.v1.workload as wl
+import kam.v1.workload.container as c
+import network as n
 
 echoserver: ac.AppConfiguration {
     workload: wl.Service {
@@ -15,10 +15,14 @@ echoserver: ac.AppConfiguration {
             }
         }
         replicas: 1
-        ports: [
-            n.Port {
-                port: 80
-            }
-        ]
+    }
+    accessories: {
+        "network": n.Network {
+            ports: [
+                n.Port {
+                    port: 80
+                }
+            ]
+        }
     }
 }
diff --git a/example/service-multi-stack/dev/kcl.mod b/example/service-multi-stack/dev/kcl.mod
@@ -3,7 +3,8 @@ name = "service-multi-stack-dev"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+kam = { git = "https://github.com/KusionStack/kam.git", tag = "0.1.0" }
+network = { oci = "oci://ghcr.io/kusionstack/network", tag = "0.1.0" }
 
 [profile]
 entries = ["../base/base.k", "main.k"]

diff --git a/example/service-multi-stack/dev/main.k b/example/service-multi-stack/dev/main.k
@@ -1,4 +1,4 @@
-import catalog.models.schema.v1 as ac
+import kam.v1.app_configuration as ac
 
 # main.k declares customized configurations for dev stack.
 echoserver: ac.AppConfiguration {

diff --git a/example/service-multi-stack/prod/kcl.mod b/example/service-multi-stack/prod/kcl.mod
@@ -3,7 +3,9 @@ name = "service-multi-stack-prod"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+kam = { git = "https://github.com/KusionStack/kam.git", tag = "0.1.0" }
+network = { oci = "oci://ghcr.io/kusionstack/network", tag = "0.1.0" }
 
 [profile]
 entries = ["../base/base.k", "main.k"]
+
diff --git a/example/service-multi-stack/prod/main.k b/example/service-multi-stack/prod/main.k
@@ -1,4 +1,4 @@
-import catalog.models.schema.v1 as ac
+import kam.v1.app_configuration as ac
 
 # main.k declares customized configurations for prod stack.
 echoserver: ac.AppConfiguration {

diff --git a/example/simple-job/dev/kcl.mod b/example/simple-job/dev/kcl.mod
@@ -3,7 +3,8 @@ name = "simple-job"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+kam = { git = "https://github.com/KusionStack/kam.git", tag = "0.1.0" }
 
 [profile]
 entries = ["main.k"]
+
diff --git a/example/simple-job/dev/main.k b/example/simple-job/dev/main.k
@@ -1,6 +1,6 @@
-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 kam.v1.app_configuration as ac
+import kam.v1.workload as wl
+import kam.v1.workload.container as c
 
 helloworld: ac.AppConfiguration {
     workload: wl.Job {

diff --git a/example/simple-service/dev/kcl.mod b/example/simple-service/dev/kcl.mod
@@ -3,7 +3,10 @@ name = "simple-service"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+kam = { git = "https://github.com/KusionStack/kam.git", tag = "0.1.0" }
+network = { oci = "oci://ghcr.io/kusionstack/network", tag = "0.1.0" }
+opsrule = { oci = "oci://ghcr.io/kusionstack/opsrule", tag = "0.1.0" }
+monitoring = { oci = "oci://ghcr.io/kusionstack/monitoring", tag = "0.1.0" }
 
 [profile]
 entries = ["main.k"]

diff --git a/example/simple-service/dev/main.k b/example/simple-service/dev/main.k
@@ -1,10 +1,10 @@
-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
+import kam.v1.app_configuration as ac
+import kam.v1.workload as wl
+import kam.v1.workload.container as c
+import kam.v1.workload.container.probe as p
+import monitoring as m
+import opsrule as o
+import network as n
 
 helloworld: ac.AppConfiguration {
     workload: wl.Service {
@@ -29,20 +29,21 @@ helloworld: ac.AppConfiguration {
             }
         }
         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"
+    accessories: {
+        "network": n.Network {
+            ports: [
+                n.Port {
+                    port: 8080
+                    targetPort: 80
+                }
+            ]
+        }
+        "monitoring": m.Prometheus {
+            path:           "/metrics"
+        }
+        "opsRule": o.OpsRule {
+            maxUnavailable: "30%"
+        }
     }
 }
diff --git a/example/wordpress-cloud-rds/prod/kcl.mod b/example/wordpress-cloud-rds/prod/kcl.mod
@@ -3,7 +3,9 @@ name = "wordpress-cloud-rds"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+mysql = { oci = "oci://ghcr.io/kusionstack/mysql", tag = "0.1.0" }
+kam = { git = "https://github.com/KusionStack/kam.git", tag = "0.1.0" }
+network = { oci = "oci://ghcr.io/kusionstack/network", tag = "0.1.0" }
 
 [profile]
 entries = ["main.k"]

diff --git a/example/wordpress-cloud-rds/prod/main.k b/example/wordpress-cloud-rds/prod/main.k
@@ -1,8 +1,8 @@
-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
+import kam.v1.app_configuration as ac
+import kam.v1.workload as wl
+import kam.v1.workload.container as c
+import network as n
+import mysql as m
 
 # main.k declares customized configurations for prod stacks.
 wordpress: ac.AppConfiguration {
@@ -23,14 +23,16 @@ wordpress: ac.AppConfiguration {
             }
         }
         replicas: 1
-        ports: [
-            n.Port {
-                port: 80
-            }
-        ]
     }
-    database: {
-        wordpress: mysql.MySQL {
+    accessories: {
+        "network": n.Network {
+            ports: [
+                n.Port {
+                    port: 80
+                }
+            ]
+        }
+        "mysql": m.MySQL {
             type: "cloud"
             version: "8.0"
         }

diff --git a/example/wordpress-local-db/prod/kcl.mod b/example/wordpress-local-db/prod/kcl.mod
@@ -3,7 +3,9 @@ name = "wordpress-local-db"
 version = "0.1.0"
 
 [dependencies]
-catalog = { git = "https://github.com/KusionStack/catalog.git", tag = "0.1.2" }
+kam = { git = "https://github.com/KusionStack/kam.git", tag = "0.1.0" }
+network = { oci = "oci://ghcr.io/kusionstack/network", tag = "0.1.0" }
+mysql = { oci = "oci://ghcr.io/kusionstack/mysql", tag = "0.1.0" }
 
 [profile]
 entries = ["main.k"]

diff --git a/example/wordpress-local-db/prod/main.k b/example/wordpress-local-db/prod/main.k
@@ -1,8 +1,8 @@
-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
+import kam.v1.app_configuration as ac
+import kam.v1.workload as wl
+import kam.v1.workload.container as c
+import network as n
+import mysql as m
 
 # main.k declares customized configurations for prod stack. 
 wordpress: ac.AppConfiguration {
@@ -19,15 +19,17 @@ wordpress: ac.AppConfiguration {
             }
         }
         replicas: 1
-        ports: [
-            n.Port {
-                port: 80
-            }
-        ]
     }
-    database: {
-        wordpress: mysql.MySQL {
-            type: "local"
+    accessories: {
+        "network": n.Network {
+            ports: [
+                n.Port {
+                    port: 80
+                }
+            ]
+        }
+        "mysql": m.MySQL {
+            type:   "local"
             version: "8.0"
         }
     }