UISchema Design

[barnettZQG]

通用组件需求

基础表单

• Input: 基础Input表单
• Number: 数字输入表单
• Select: 固定可选值表单
• Switch: 开关选择器
• Radio: 单选表单
• DatePicker: 时间选择框
• Textarea: 多行文本输入框
• Password: 密码输入表单

业务表单

• Ignore: 当前字段存在下级字段，本级不显示。
• ClusterSelect: 集群选择器
• EnvSelect: 应用下环境选择器 （参数：appName）
• SecretSelect: 目标集群密钥选择器 （参数：clusterName）
• SecretKeySelect: Secret 资源中的Key选择，它必须与SecretSelect表单级联存在。 （参数：secretKeys）
• ComponentSelect: 应用下组件选择器 （参数：appName）
• ImageInput: 镜像输入框（针对镜像进行检测）
• ClassStorageSelect：目标集群存储类型选择器 （参数：clusterName）
• PVCSelect: 目标集群的存储卷选择 （参数：clusterName, namespace）
• CPUNumber: cpu数值输入框 支持小数点后2位，默认单位为 Core
• MemoryNumber: 内存数值输入框 2^n 数值输入方式，默认单位为MB
• K8sObjectsCode: kubernetes yaml编辑框，支持上传yaml，输出多个k8s资源对象。

组合表单

• KV: KV 组合输入框 struct{}
• Strings: 多行 Input 输入框 []string
• Structs: 多个表单组合成单行 形成 多行输入表单。[]struct{}

  支持基于Options 定义差异性子集，即不同的下级属性组成不同的表单集合。
  AddByKV:env.name|env.value
  AddBySecret:env.name|env.valueFrom

• Group: 组合（渲染为一个带标题的容器)
• InnerGroup: 行内组合容器
• TabGroup: 条件判断Tab，只有一组生效。

UISchema 数据模型

// UIParameter Structured import table simple UI model
type UIParameter struct {
	Sort        uint      `json:"sort"`
	Label       string    `json:"label"`
	Description string    `json:"description"`
	Validate    *Validate `json:"validate,omitempty"`
	JSONKey     string    `json:"jsonKey"`
	UIType      string    `json:"uiType"`
	// means disable parameter in ui
	Disable                 *bool          `json:"disable,omitempty"`
	SubParameterGroupOption []GroupOption  `json:"subParameterGroupOption,omitempty"`
	SubParameters           []*UIParameter `json:"subParameters,omitempty"`
	AdditionalParameter     *UIParameter   `json:"additionalParameter,omitempty"`
	Additional              *bool          `json:"additional,omitempty"`
}

// GroupOption define multiple data structure composition options.
type GroupOption struct {
	Label string   `json:"label"`
	Keys  []string `json:"keys"`
}

// Validate parameter validate rule
type Validate struct {
	Required     bool        `json:"required,omitempty"`
	Max          int         `json:"max,omitempty"`
	Min          int         `json:"min,omitempty"`
	Regular      string      `json:"regular,omitempty"`
	Options      []*Options  `json:"options,omitempty"`
	DefaultValue interface{} `json:"defaultValue,omitempty"`
}

// Options select option
type Options struct {
	Label string `json:"label"`
	Value string `json:"value"`
}