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:

  1. scaler: {
  3.     type: "trait"
  5.     annotations: {}
  7.     labels: {}
  9.     description: "Manually scale K8s pod for your workload which follows the pod spec in path 'spec.template'."
  11.     attributes: {
  13.         podDisruptive: false
  15.         appliesToWorkloads: ["*"]
  17.     }
  19. }
  21. template: {
  23.     parameter: {
  25.         // +usage=Specify the number of workload
  27.         replicas: *1 | int
  29.     }
  31.     // +patchStrategy=retainKeys
  33.     patch: spec: replicas: parameter.replicas
  35. }

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:

  1. - jsonKey: string         field name
  3.   label: string           show name in UI
  5.   description: string     help info
  7.   uiType: string          the react component type in UI
  9.   sort: int               sort number
  11.   validate:               data validate rule.
  13.     required: bool
  15.     max: int
  17.     min: int
  19.     regular: string
  21.     options:              Optional, for select forms
  23.     - label: string
  25.       value: string
  27.   subParameters:
  29.     ...

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
  • K8sObjectsCode

Combination form

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

How to expand

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