Skip to main content
Version: v1.2

UI-Schema

KubeVela designs and implements the UI-Schema specification for the scalability of components, workflow steps, and operation and maintenance feature resources, in the case of variable input parameters, to achieve a more native UI experience.

At present, the UI-Schema specification mainly acts on the data input side and will be extended to the data visualization side in the future.

How UI-Schema works#

The components, workflow steps, and operation and maintenance feature types with different UI-Schema working principles are defined through CUE, which we call XDefinition, and almost every definition includes the definition of input parameters. for example:

scaler: {
type: "trait"
annotations: {}
labels: {}
description: "Manually scale K8s pod for your workload which follows the pod spec in path 'spec.template'."
attributes: {
podDisruptive: false
appliesToWorkloads: ["*"]
}
}
template: {
parameter: {
// +usage=Specify the number of workload
replicas: *1 | int
}
// +patchStrategy=retainKeys
patch: spec: replicas: parameter.replicas
}

In the above example, the user input parameter is replicas.

In the UI we want the user to be able to set the number of replicas via a number input form.

ui schema

Its workflow is in the figure above. The API Schema is generated through the defined CUE, and then the default UI Schema is generated through the API Schema. If there is a custom UI Schema, the default configuration is patched with the custom configuration. The UI renders the front-end page based on the final UI Schema.

The spec are as follows:

- jsonKey: string The field name
label: string The show name in UI
description: string The help info in UI
uiType: string The react component type in UI
sort: int The sort number
disabled: bool Disable this field.
style:
colSpan: int Defines the number of grids for the form, with 24 representing 100% width.
validate: The value validate rule, It must be defined as a whole.
defaultValue: any The default values.
required: bool
max: int The max value for number.
min: int The min value for number.
maxLength: int The max length for string.
minLength: int The min length for string.
pattern: string
options: Optional, for select forms
- label: string
value: string
immutable: bool Set the immutable is true, indicates that the parameter cannot be changed.
subParameters:
- jsonKey: string
...

Supported react component types#

Basic form#

  • Input
  • Number
  • Select
  • Switch
  • Radio
  • DatePicker
  • Textarea
  • Password

Business form#

  • Ignore: There are subordinate fields, and the current field is not displayed.
  • ClusterSelect
  • EnvSelect
  • SecretSelect
  • SecretKeySelect
  • ComponentSelect
  • ImageInput
  • ClassStorageSelect
  • PVCSelect
  • CPUNumber
  • MemoryNumber
  • DiskNumber
  • K8sObjectsCode

Combination form#

  • KV
  • Strings
  • Structs
  • Group: render as a titled container
  • TabGroup

Example#

Ref:https://github.com/kubevela/catalog/tree/master/addons/velaux/schemas

How to expand#

UI-Schema mainly extends front-end react components, refer to https://github.com/kubevela/velaux/tree/main/src/extends

Last updated on by Jianbo Sun