Merge branch 'main' into chore/upgrade_docusaurus_version

jguionnet · jguionnet · commit 19568df4ba55 · 2025-08-11T18:26:27.000-07:00
Resolved conflict in docs/end-user/definition-version-control.md by:
- Keeping the proper closing code block markers
- Including the new CUE-based definitions section from main
diff --git a/docs/end-user/components/cloud-services/provision-and-consume-database.md b/docs/end-user/components/cloud-services/provision-and-consume-database.md
@@ -66,6 +66,11 @@ Deploy and verify the application.
 
 ```shell
 $ vela ls
+```
+
+The output would look like the below: 
+
+```shell
 APP   	COMPONENT     	TYPE       	TRAITS         	PHASE         	HEALTHY  	STATUS	CREATED-TIME
 webapp	express-server	webservice 	service-binding	running     	healthy  	      	2021-09-08 16:50:41 +0800 CST
 ├─    	sample-db     	alibaba-rds	               	running     	healthy  	      	2021-09-08 16:50:41 +0800 CST
@@ -74,6 +79,11 @@ webapp	express-server	webservice 	service-binding	running     	healthy
 
 ```shell
 $ vela port-forward webapp
+```
+
+The output would look like the below: 
+
+```shell
 Forwarding from 127.0.0.1:8080 -> 80
 Forwarding from [::1]:8080 -> 80
 
diff --git a/docs/end-user/components/cloud-services/provision-and-initiate-database.md b/docs/end-user/components/cloud-services/provision-and-initiate-database.md
@@ -93,6 +93,11 @@ After the application is successfully deployed, you can access the web applicati
 
 ```shell
 $ vela ls
+```
+
+The output would look like the below: 
+
+```shell
 APP           	COMPONENT	TYPE               	TRAITS         	PHASE  	HEALTHY	STATUS                                       	CREATED-TIME
 favorite-links	web      	webservice         	service-binding	running	healthy	Ready:1/1                                    	2022-02-21 14:15:45 +0800 CST
 └─            	db       	alibaba-rds-preview	               	running	healthy	Cloud resources are deployed and ready to use	2022-02-21 14:15:45 +0800 CST
@@ -101,6 +106,10 @@ favorite-links	web      	webservice         	service-binding	running	healthy	Rea
 
 ```shell
 $ vela port-forward favorite-links 4000:4000
+```
+The output would look like the below: 
+
+```shell
 Forwarding from 127.0.0.1:4000 -> 4000
 Forwarding from [::1]:4000 -> 4000
 
diff --git a/docs/end-user/components/cloud-services/provision-cloud-resources-by-crossplane.md b/docs/end-user/components/cloud-services/provision-cloud-resources-by-crossplane.md
@@ -5,10 +5,33 @@ title: Crossplane
 The guide [Deploy Cloud Services](../../../tutorials/consume-cloud-services.md) shows how to provision cloud resources by Terraform in
 CLI and VelaUX. This tutorial will talk about how to provision Cloud Resources by [Crossplane](https://crossplane.io/).
 
+At present, considering the Crossplane Addon is still in experimental stage, please execute the below statement to activate addon registry by vela cli and use them. 
+
+```shell
+vela addon registry add experimental --type helm --endpoint=https://kubevela.github.io/catalog/experimental/
+```
+
+You can view the registry added by executing: 
+
+```shell
+vela addon registry list
+```
+
+The output would look like the below: 
+
+```shell
+Name            Type    URL                                                                                                      
+experimental    helm    https://kubevela.github.io/catalog/experimental/ 
+```
+
 Let's take cloud provider AWS as an example.
 
 ## Enable addon `crossplane-aws`
 
+:::note
+Enabling the Crossplane AWS add-on may override your Terraform definition if the Terraform add-on was already enabled. 
+:::
+
 ```shell
 vela addon enable crossplane-aws
 ```
@@ -46,7 +69,7 @@ metadata:
 spec:
   components:
     - name: dev
-      type: crossplane-aws-s3
+      type: aws-s3
       properties:
         name: kubevela-test-0714
         acl: private
@@ -58,7 +81,7 @@ After the application gets `running`, you can check the bucket by AWS [cli](http
 ```shell
 $ vela ls
 APP   	COMPONENT	TYPE  	             TRAITS	PHASE  	HEALTHY	STATUS	CREATED-TIME
-s3-poc	dev      	crossplane-aws-s3	      	running	healthy	      	2022-06-16 15:37:15 +0800 CST
+s3-poc	dev      	aws-s3	      	     running	      healthy	      	2022-06-16 15:37:15 +0800 CST
 
 $ aws s3 ls
 2022-06-16 15:37:17 kubevela-test-0714
diff --git a/docs/end-user/definition-version-control.md b/docs/end-user/definition-version-control.md
@@ -56,7 +56,8 @@ spec:
 ```
 
 2. Create a `configmap-component` ComponentDefinition with `2.0.5` version
-```apiVersion: core.oam.dev/v1beta1
+```
+apiVersion: core.oam.dev/v1beta1
 kind: ComponentDefinition
 metadata:
   name: configmap-component
@@ -90,7 +91,8 @@ my-component-v2.5.0                2          e61e9b5e55b01c2b   Component
 ```
 
 4. Create Application using `configmap-component@v1.2` version and enable the Auto Update using `app.oam.dev/autoUpdate` annotation.
-```apiVersion: core.oam.dev/v1beta1
+```
+apiVersion: core.oam.dev/v1beta1
 kind: Application
 metadata:
   name: test-app
@@ -142,4 +144,39 @@ spec:
 my-component-v1.2.5                1          1a4f3ac77e4fcfef   Component
 my-component-v1.2.7                3          86d7fb1a36566dea   Component
 my-component-v2.5.0                2          e61e9b5e55b01c2b   Component
-`
+```
+
+## Adding a `version` Field in CUE-based Definitions
+Include the version field inside the attributes section in your .cue file to enable semantic versioning. If you do not require semantic versioning, you may omit the version field.
+Example:
+```
+"configmap-creater": {
+    type: "component"
+    attributes: {
+        workload: definition: {
+            apiVersion: "v1"
+            kind:       "ConfigMap"
+        }
+        version: "1.1.1"
+    }
+}
+
+template: {
+    output: {
+        apiVersion: "v1"
+        kind:       "ConfigMap"
+        metadata: {
+            name: parameter.name
+            namespace: context.namespace
+        }
+        data: parameter.data
+    }
+
+    parameter: {
+        // +usage=Name of the ConfigMap.
+        name: string
+        // +usage=Data to be stored in the ConfigMap.
+        data: [string]: string
+    }
+}
+```
diff --git a/docs/reference/addons/terraform.md b/docs/reference/addons/terraform.md
@@ -18,6 +18,11 @@ KubeVela can support the following cloud providers by enabling the Terraform pro
 
 ```shell
 $ vela addon list | grep terraform-
+```
+
+The output would look like the below:
+
+```shell
 terraform-alibaba        	KubeVela	Kubernetes Terraform Controller for Alibaba Cloud                                                    	[1.0.2, 1.0.1]                      	enabled (1.0.2)
 terraform-tencent        	KubeVela	Kubernetes Terraform Controller Provider for Tencent Cloud                                           	[1.0.0, 1.0.1]                      	enabled (1.0.0)
 terraform-aws            	KubeVela	Kubernetes Terraform Controller for AWS                                                              	[1.0.0, 1.0.1]                      	enabled (1.0.0)
diff --git a/docs/resources/custom-ui-schema.jpg b/docs/resources/custom-ui-schema.jpg
diff --git a/docs/resources/java-war.jpg b/docs/resources/java-war.jpg
diff --git a/docs/tutorials/custom-image-delivery.md b/docs/tutorials/custom-image-delivery.md
@@ -13,7 +13,7 @@ If so, you could change the `webservice` definition.
 
 > This way is only suitable for the UI users.
 
-![image](https://static.kubevela.net/images/1.5/custom-ui-schema.jpg)
+![image](../resources/custom-ui-schema.jpg)
 
 On the definition detail page, users could customize the UI schema to setting the UI forms. For example, if you want to hide the ExposeType field, only need to set the disable is `true`.
 
@@ -297,7 +297,7 @@ spec:
       type: deploy
 ```
 
-![java-app](https://static.kubevela.net/images/1.5/java-war.jpg)
+![java-app](../resources/java-war.jpg)
 
 This example includes three components, and the order service depends on the catalog and the customer services. The developer only needs to care about the war package URL and the tomcat/JRE version, they are familiar to the Java developer. The developer should upload the war package to a repository, such as Jfrog. Get a download URL to assign to the `warURL` field.
 
diff --git a/versioned_docs/version-v1.10/end-user/definition-version-control.md b/versioned_docs/version-v1.10/end-user/definition-version-control.md
@@ -56,7 +56,8 @@ spec:
 ```
 
 2. Create a `configmap-component` ComponentDefinition with `2.0.5` version
-```apiVersion: core.oam.dev/v1beta1
+```
+apiVersion: core.oam.dev/v1beta1
 kind: ComponentDefinition
 metadata:
   name: configmap-component
@@ -90,7 +91,8 @@ my-component-v2.5.0                2          e61e9b5e55b01c2b   Component
 ```
 
 4. Create Application using `configmap-component@v1.2` version and enable the Auto Update using `app.oam.dev/autoUpdate` annotation.
-```apiVersion: core.oam.dev/v1beta1
+```
+apiVersion: core.oam.dev/v1beta1
 kind: Application
 metadata:
   name: test-app
@@ -142,4 +144,39 @@ spec:
 my-component-v1.2.5                1          1a4f3ac77e4fcfef   Component
 my-component-v1.2.7                3          86d7fb1a36566dea   Component
 my-component-v2.5.0                2          e61e9b5e55b01c2b   Component
-````
+````
+
+## Adding a `version` Field in CUE-based Definitions
+Include the version field inside the attributes section in your .cue file to enable semantic versioning. If you do not require semantic versioning, you may omit the version field.
+Example:
+```
+"configmap-creater": {
+    type: "component"
+    attributes: {
+        workload: definition: {
+            apiVersion: "v1"
+            kind:       "ConfigMap"
+        }
+        version: "1.1.1"
+    }
+}
+
+template: {
+    output: {
+        apiVersion: "v1"
+        kind:       "ConfigMap"
+        metadata: {
+            name: parameter.name
+            namespace: context.namespace
+        }
+        data: parameter.data
+    }
+
+    parameter: {
+        // +usage=Name of the ConfigMap.
+        name: string
+        // +usage=Data to be stored in the ConfigMap.
+        data: [string]: string
+    }
+}
+```
