From b0c9e4b78a6e1b34a9d0d56a4fcf94a0a8a3ec00 Mon Sep 17 00:00:00 2001 From: Hongchao Deng Date: Fri, 13 Nov 2020 12:28:25 -0800 Subject: [PATCH] update descriptions of capabilities --- charts/vela-core/templates/defwithtemplate/autoscale.yaml | 4 ++-- charts/vela-core/templates/defwithtemplate/manualscale.yaml | 5 ++--- charts/vela-core/templates/defwithtemplate/metrics.yaml | 6 +----- charts/vela-core/templates/defwithtemplate/rollout.yaml | 5 +++-- charts/vela-core/templates/defwithtemplate/route.yaml | 3 +-- charts/vela-core/templates/defwithtemplate/task.yaml | 2 +- charts/vela-core/templates/defwithtemplate/webservice.yaml | 2 +- charts/vela-core/templates/defwithtemplate/worker.yaml | 2 +- hack/vela-templates/definitions/autoscale.yaml | 4 ++-- hack/vela-templates/definitions/manualscale.yaml | 5 ++--- hack/vela-templates/definitions/metrics.yaml | 6 +----- hack/vela-templates/definitions/rollout.yaml | 5 +++-- hack/vela-templates/definitions/route.yaml | 3 +-- hack/vela-templates/definitions/task.yaml | 2 +- hack/vela-templates/definitions/webservice.yaml | 2 +- hack/vela-templates/definitions/worker.yaml | 2 +- 16 files changed, 24 insertions(+), 34 deletions(-) diff --git a/charts/vela-core/templates/defwithtemplate/autoscale.yaml b/charts/vela-core/templates/defwithtemplate/autoscale.yaml index 1dab45898..8db3037cb 100644 --- a/charts/vela-core/templates/defwithtemplate/autoscale.yaml +++ b/charts/vela-core/templates/defwithtemplate/autoscale.yaml @@ -3,11 +3,11 @@ kind: TraitDefinition metadata: name: autoscale annotations: - definition.oam.dev/description: "Automatically scale workloads" + definition.oam.dev/description: "Automatically scale the app following certain triggers or metrics" spec: appliesToWorkloads: - webservice - - backend + - worker workloadRefPath: spec.workloadRef definitionRef: name: autoscalers.standard.oam.dev diff --git a/charts/vela-core/templates/defwithtemplate/manualscale.yaml b/charts/vela-core/templates/defwithtemplate/manualscale.yaml index 67ba35e66..4a7f73c7b 100644 --- a/charts/vela-core/templates/defwithtemplate/manualscale.yaml +++ b/charts/vela-core/templates/defwithtemplate/manualscale.yaml @@ -2,13 +2,12 @@ apiVersion: core.oam.dev/v1alpha2 kind: TraitDefinition metadata: annotations: - definition.oam.dev/description: "Scale replica for workload" + definition.oam.dev/description: "Manually scale the app" name: scaler spec: appliesToWorkloads: - webservice - - containerizedworkloads.core.oam.dev - - deployments.apps + - worker definitionRef: name: manualscalertraits.core.oam.dev workloadRefPath: spec.workloadRef diff --git a/charts/vela-core/templates/defwithtemplate/metrics.yaml b/charts/vela-core/templates/defwithtemplate/metrics.yaml index e917a027b..a5a2ea22d 100644 --- a/charts/vela-core/templates/defwithtemplate/metrics.yaml +++ b/charts/vela-core/templates/defwithtemplate/metrics.yaml @@ -3,16 +3,12 @@ kind: TraitDefinition metadata: name: metric annotations: - definition.oam.dev/description: "Add metric monitoring for workload" + definition.oam.dev/description: "Configure metrics targets to be monitored for the app" spec: appliesToWorkloads: - webservice - backend - task - - containerizedworkloads.core.oam.dev - - clonesetworkloads.apps.kruise.io - - deployments.apps - - statefulsets.apps definitionRef: name: metricstraits.standard.oam.dev workloadRefPath: spec.workloadRef diff --git a/charts/vela-core/templates/defwithtemplate/rollout.yaml b/charts/vela-core/templates/defwithtemplate/rollout.yaml index 6dca0977c..fb8ac73db 100644 --- a/charts/vela-core/templates/defwithtemplate/rollout.yaml +++ b/charts/vela-core/templates/defwithtemplate/rollout.yaml @@ -2,10 +2,11 @@ apiVersion: core.oam.dev/v1alpha2 kind: TraitDefinition metadata: name: rollout + annotations: + definition.oam.dev/description: "Configure canary deployment strategy to release the app" spec: appliesToWorkloads: - - podspecworkload.standard.oam.dev - - deployments.apps + - webservice definitionRef: name: canaries.flagger.app workloadRefPath: spec.targetRef diff --git a/charts/vela-core/templates/defwithtemplate/route.yaml b/charts/vela-core/templates/defwithtemplate/route.yaml index 339c64508..dfc3b3d19 100644 --- a/charts/vela-core/templates/defwithtemplate/route.yaml +++ b/charts/vela-core/templates/defwithtemplate/route.yaml @@ -3,11 +3,10 @@ kind: TraitDefinition metadata: name: route annotations: - definition.oam.dev/description: "Add a route for workload" + definition.oam.dev/description: "Configure route policy to the app" spec: appliesToWorkloads: - webservice - - deployments.apps workloadRefPath: spec.workloadRef definitionRef: name: routes.standard.oam.dev diff --git a/charts/vela-core/templates/defwithtemplate/task.yaml b/charts/vela-core/templates/defwithtemplate/task.yaml index da3ca1748..bc2e3c79d 100644 --- a/charts/vela-core/templates/defwithtemplate/task.yaml +++ b/charts/vela-core/templates/defwithtemplate/task.yaml @@ -3,7 +3,7 @@ kind: WorkloadDefinition metadata: name: task annotations: - definition.oam.dev/description: "One-time task/job" + definition.oam.dev/description: "One-off task to run a piece of code or script to completion" spec: definitionRef: name: jobs diff --git a/charts/vela-core/templates/defwithtemplate/webservice.yaml b/charts/vela-core/templates/defwithtemplate/webservice.yaml index d36f81ee4..64ea23c19 100644 --- a/charts/vela-core/templates/defwithtemplate/webservice.yaml +++ b/charts/vela-core/templates/defwithtemplate/webservice.yaml @@ -3,7 +3,7 @@ kind: WorkloadDefinition metadata: name: webservice annotations: - definition.oam.dev/description: "Long running service with network routes" + definition.oam.dev/description: "Long-running scalable service with stable endpoint to receive external traffic" spec: definitionRef: name: deployments.apps diff --git a/charts/vela-core/templates/defwithtemplate/worker.yaml b/charts/vela-core/templates/defwithtemplate/worker.yaml index f90052ed8..c787a30c1 100644 --- a/charts/vela-core/templates/defwithtemplate/worker.yaml +++ b/charts/vela-core/templates/defwithtemplate/worker.yaml @@ -3,7 +3,7 @@ kind: WorkloadDefinition metadata: name: worker annotations: - definition.oam.dev/description: "Backend worker without ports exposed" + definition.oam.dev/description: "Long-running scalable backend worker without network endpoint" spec: definitionRef: name: deployments.apps diff --git a/hack/vela-templates/definitions/autoscale.yaml b/hack/vela-templates/definitions/autoscale.yaml index 3cf897d5d..0a47d3996 100644 --- a/hack/vela-templates/definitions/autoscale.yaml +++ b/hack/vela-templates/definitions/autoscale.yaml @@ -3,11 +3,11 @@ kind: TraitDefinition metadata: name: autoscale annotations: - definition.oam.dev/description: "Automatically scale workloads" + definition.oam.dev/description: "Automatically scale the app following certain triggers or metrics" spec: appliesToWorkloads: - webservice - - backend + - worker workloadRefPath: spec.workloadRef definitionRef: name: autoscalers.standard.oam.dev diff --git a/hack/vela-templates/definitions/manualscale.yaml b/hack/vela-templates/definitions/manualscale.yaml index 68ec2907d..d876cd4e8 100644 --- a/hack/vela-templates/definitions/manualscale.yaml +++ b/hack/vela-templates/definitions/manualscale.yaml @@ -2,13 +2,12 @@ apiVersion: core.oam.dev/v1alpha2 kind: TraitDefinition metadata: annotations: - definition.oam.dev/description: "Scale replica for workload" + definition.oam.dev/description: "Manually scale the app" name: scaler spec: appliesToWorkloads: - webservice - - containerizedworkloads.core.oam.dev - - deployments.apps + - worker definitionRef: name: manualscalertraits.core.oam.dev workloadRefPath: spec.workloadRef diff --git a/hack/vela-templates/definitions/metrics.yaml b/hack/vela-templates/definitions/metrics.yaml index a5c3a2e7f..1c7a37d8f 100644 --- a/hack/vela-templates/definitions/metrics.yaml +++ b/hack/vela-templates/definitions/metrics.yaml @@ -3,16 +3,12 @@ kind: TraitDefinition metadata: name: metric annotations: - definition.oam.dev/description: "Add metric monitoring for workload" + definition.oam.dev/description: "Configure metrics targets to be monitored for the app" spec: appliesToWorkloads: - webservice - backend - task - - containerizedworkloads.core.oam.dev - - clonesetworkloads.apps.kruise.io - - deployments.apps - - statefulsets.apps definitionRef: name: metricstraits.standard.oam.dev workloadRefPath: spec.workloadRef diff --git a/hack/vela-templates/definitions/rollout.yaml b/hack/vela-templates/definitions/rollout.yaml index 03419abd5..97bcff4a2 100644 --- a/hack/vela-templates/definitions/rollout.yaml +++ b/hack/vela-templates/definitions/rollout.yaml @@ -2,10 +2,11 @@ apiVersion: core.oam.dev/v1alpha2 kind: TraitDefinition metadata: name: rollout + annotations: + definition.oam.dev/description: "Configure canary deployment strategy to release the app" spec: appliesToWorkloads: - - podspecworkload.standard.oam.dev - - deployments.apps + - webservice definitionRef: name: canaries.flagger.app workloadRefPath: spec.targetRef diff --git a/hack/vela-templates/definitions/route.yaml b/hack/vela-templates/definitions/route.yaml index e3d02742d..e32080a4e 100644 --- a/hack/vela-templates/definitions/route.yaml +++ b/hack/vela-templates/definitions/route.yaml @@ -3,11 +3,10 @@ kind: TraitDefinition metadata: name: route annotations: - definition.oam.dev/description: "Add a route for workload" + definition.oam.dev/description: "Configure route policy to the app" spec: appliesToWorkloads: - webservice - - deployments.apps workloadRefPath: spec.workloadRef definitionRef: name: routes.standard.oam.dev diff --git a/hack/vela-templates/definitions/task.yaml b/hack/vela-templates/definitions/task.yaml index 9c20939c8..6b915834e 100644 --- a/hack/vela-templates/definitions/task.yaml +++ b/hack/vela-templates/definitions/task.yaml @@ -3,7 +3,7 @@ kind: WorkloadDefinition metadata: name: task annotations: - definition.oam.dev/description: "One-time task/job" + definition.oam.dev/description: "One-off task to run a piece of code or script to completion" spec: definitionRef: name: jobs diff --git a/hack/vela-templates/definitions/webservice.yaml b/hack/vela-templates/definitions/webservice.yaml index dfe49575f..6ab1172a1 100644 --- a/hack/vela-templates/definitions/webservice.yaml +++ b/hack/vela-templates/definitions/webservice.yaml @@ -3,7 +3,7 @@ kind: WorkloadDefinition metadata: name: webservice annotations: - definition.oam.dev/description: "Long running service with network routes" + definition.oam.dev/description: "Long-running scalable service with stable endpoint to receive external traffic" spec: definitionRef: name: deployments.apps diff --git a/hack/vela-templates/definitions/worker.yaml b/hack/vela-templates/definitions/worker.yaml index 1ebc45c2c..885e9f12e 100644 --- a/hack/vela-templates/definitions/worker.yaml +++ b/hack/vela-templates/definitions/worker.yaml @@ -3,7 +3,7 @@ kind: WorkloadDefinition metadata: name: worker annotations: - definition.oam.dev/description: "Backend worker without ports exposed" + definition.oam.dev/description: "Long-running scalable backend worker without network endpoint" spec: definitionRef: name: deployments.apps