mirror of
https://github.com/kubevela/kubevela.git
synced 2026-08-27 16:17:34 +00:00
applicaiton supports specifying different versions of Definition (#1597)
* app support specify the version of definition * add e2e-test * add docs * add helm related test * fix doc * add more test * fix docs
This commit is contained in:
yangsoon
@@ -0,0 +1,110 @@
|
||||
---
|
||||
title: Specify Definition Revision in Application
|
||||
---
|
||||
|
||||
Each time the platform provider update ComponentDefinition/TraitDefinition, a corresponding DefinitionRevision will be generated.
|
||||
And the DefinitionRevision can be regarded as a snapshot of ComponentDefinition/TraitDefinition.
|
||||
|
||||
In this section, we will introduce how to specify a revision in Application.
|
||||
|
||||
## Usage of Definition
|
||||
|
||||
Suppose we need a `worker` to run a background service. And the platform provider has already provided a `worker`
|
||||
ComponentDefinition for us(The ComponentDefinition `worker` may have been updated multiple times).
|
||||
|
||||
|
||||
Assume the platform provider registered the `v1` version of the `worker` like below:
|
||||
|
||||
**Click to see how to register the v1 version of the worker**
|
||||
<details>
|
||||
|
||||
```shell
|
||||
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/definition-revision/worker-v1.yaml
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
We can use `kubectl vela show` to see the specification doc of the `worker`.
|
||||
|
||||
```shell
|
||||
$ kubectl vela show worker
|
||||
# Properties
|
||||
+-------+----------------------------------------------------+----------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+-------+----------------------------------------------------+----------+----------+---------+
|
||||
| cmd | Commands to run in the container | []string | false | |
|
||||
| image | Which image would you like to use for your service | string | true | |
|
||||
+-------+----------------------------------------------------+----------+----------+---------+
|
||||
```
|
||||
|
||||
Assume the platform provider has updated the version of the `worker` to `v2` like below.
|
||||
|
||||
**Click to see how to update**
|
||||
<details>
|
||||
|
||||
```shell
|
||||
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/docs/examples/definition-revision/worker-v2.yaml
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
The latest worker ComponentDefinition adds the `port` parameter, allowing users to specify the port exposed by the container.
|
||||
|
||||
```shell
|
||||
$ kubectl vela show worker
|
||||
# Properties
|
||||
+-------+----------------------------------------------------+----------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+-------+----------------------------------------------------+----------+----------+---------+
|
||||
| cmd | Commands to run in the container | []string | false | |
|
||||
| image | Which image would you like to use for your service | string | true | |
|
||||
| port | Which port do you want customer traffic sent to | int | true | |
|
||||
+-------+----------------------------------------------------+----------+----------+---------+
|
||||
```
|
||||
|
||||
When the platform provider updated the two versions of the worker, the corresponding DefinitionRevision will
|
||||
be generated to store the snapshot information.
|
||||
|
||||
```shell
|
||||
$ kubectl get definitionrevision -l="componentdefinition.oam.dev/name=worker"
|
||||
NAME REVISION HASH TYPE
|
||||
worker-v1 1 76486234845427dc Component
|
||||
worker-v2 2 cb22fdc3b037702e Component
|
||||
```
|
||||
|
||||
## Specify Definition Version in Application
|
||||
|
||||
We can specify the Component to use a specific version of the Definition in Application,
|
||||
By default, the application will always use the latest Definition to render the Component.
|
||||
|
||||
But the latest Definition may not be compatible with user's application, so we can specify the old version like `v1` of the worker to render the Component.
|
||||
we can specify the version of Definition in format `definitionName@version`.
|
||||
|
||||
```yaml
|
||||
# testapp.yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: testapp
|
||||
spec:
|
||||
components:
|
||||
- name: backend
|
||||
type: worker@v1
|
||||
properties:
|
||||
image: crccheck/hello-world
|
||||
```
|
||||
|
||||
```shell
|
||||
kubectl apply -f testapp.yaml
|
||||
```
|
||||
|
||||
The `v1` version of the `worker` only allows the container to expose port `8000`.
|
||||
|
||||
```shell
|
||||
$ kubectl get deployment
|
||||
NAME READY UP-TO-DATE AVAILABLE AGE
|
||||
backend 1/1 1 1 3m7s
|
||||
|
||||
$ kubectl get deployment backend -o jsonpath="{.spec.template.spec.containers[0].ports[0].containerPort}"
|
||||
8000
|
||||
```
|
||||
@@ -0,0 +1,48 @@
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: ComponentDefinition
|
||||
metadata:
|
||||
name: worker
|
||||
namespace: default
|
||||
annotations:
|
||||
definition.oam.dev/description: "Describes long-running, scalable, containerized services that running at backend. They do NOT have network endpoint to receive external network traffic."
|
||||
spec:
|
||||
workload:
|
||||
definition:
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
schematic:
|
||||
cue:
|
||||
template: |
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
spec: {
|
||||
selector: matchLabels: {
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
template: {
|
||||
metadata: labels: {
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
spec: {
|
||||
containers: [{
|
||||
name: context.name
|
||||
image: parameter.image
|
||||
|
||||
if parameter["cmd"] != _|_ {
|
||||
command: parameter.cmd
|
||||
}
|
||||
ports: [{
|
||||
containerPort: 8000
|
||||
}]
|
||||
}]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
parameter: {
|
||||
// +usage=Which image would you like to use for your service
|
||||
image: string
|
||||
// +usage=Commands to run in the container
|
||||
cmd?: [...string]
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: ComponentDefinition
|
||||
metadata:
|
||||
name: worker
|
||||
namespace: default
|
||||
annotations:
|
||||
definition.oam.dev/description: "Describes long-running, scalable, containerized services that running at backend. They do NOT have network endpoint to receive external network traffic."
|
||||
spec:
|
||||
workload:
|
||||
definition:
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
schematic:
|
||||
cue:
|
||||
template: |
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
spec: {
|
||||
selector: matchLabels: {
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
template: {
|
||||
metadata: labels: {
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
spec: {
|
||||
containers: [{
|
||||
name: context.name
|
||||
image: parameter.image
|
||||
|
||||
if parameter["cmd"] != _|_ {
|
||||
command: parameter.cmd
|
||||
}
|
||||
ports: [{
|
||||
containerPort: parameter.port
|
||||
}]
|
||||
}]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
parameter: {
|
||||
// +usage=Which image would you like to use for your service
|
||||
image: string
|
||||
// +usage=Commands to run in the container
|
||||
cmd?: [...string]
|
||||
// +usage=Which port do you want customer traffic sent to
|
||||
port: int
|
||||
}
|
||||
@@ -43,6 +43,7 @@ module.exports = {
|
||||
'end-user/traits/more',
|
||||
]
|
||||
},
|
||||
'end-user/definition-revision',
|
||||
'end-user/scopes/appdeploy',
|
||||
'end-user/scopes/rollout-plan',
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user