mirror of
https://github.com/kubevela/kubevela.git
synced 2026-03-05 19:22:03 +00:00
53006b4137
* move addon api to pkg/addon Signed-off-by: qiaozp <chivalry.pp@gmail.com> * reviewable Signed-off-by: qiaozp <chivalry.pp@gmail.com> * license Signed-off-by: qiaozp <chivalry.pp@gmail.com> * reviewable Signed-off-by: qiaozp <chivalry.pp@gmail.com>
74 lines
2.4 KiB
Go
74 lines
2.4 KiB
Go
/*
|
|
Copyright 2021 The KubeVela Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package addon
|
|
|
|
import (
|
|
"github.com/getkin/kin-openapi/openapi3"
|
|
|
|
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
|
|
"github.com/oam-dev/kubevela/pkg/apiserver/rest/utils"
|
|
)
|
|
|
|
// Addon contains all information represent an addon
|
|
type Addon struct {
|
|
Meta
|
|
|
|
APISchema *openapi3.Schema `json:"schema"`
|
|
UISchema []*utils.UIParameter `json:"uiSchema"`
|
|
|
|
// More details about the addon, e.g. README
|
|
Detail string `json:"detail,omitempty"`
|
|
Definitions []ElementFile `json:"definitions"`
|
|
CUEDefinitions []ElementFile `json:"cue_definitions"`
|
|
Parameters string `json:"parameters"`
|
|
CUETemplates []ElementFile `json:"cue_templates"`
|
|
YAMLTemplates []ElementFile `json:"yaml_templates,omitempty"`
|
|
DefSchemas []ElementFile `json:"def_schemas,omitempty"`
|
|
AppTemplate *v1beta1.Application `json:"app_template"`
|
|
}
|
|
|
|
// Meta defines the format for a single addon
|
|
type Meta struct {
|
|
Name string `json:"name" validate:"required"`
|
|
Version string `json:"version"`
|
|
Description string `json:"description"`
|
|
Icon string `json:"icon"`
|
|
URL string `json:"url,omitempty"`
|
|
Tags []string `json:"tags,omitempty"`
|
|
DeployTo *DeployTo `json:"deployTo,omitempty"`
|
|
Dependencies []*Dependency `json:"dependencies,omitempty"`
|
|
NeedNamespace []string `json:"needNamespace,omitempty"`
|
|
Invisible bool `json:"invisible"`
|
|
}
|
|
|
|
// DeployTo defines where the addon to deploy to
|
|
type DeployTo struct {
|
|
ControlPlane bool `json:"control_plane"`
|
|
RuntimeCluster bool `json:"runtime_cluster"`
|
|
}
|
|
|
|
// Dependency defines the other addons it depends on
|
|
type Dependency struct {
|
|
Name string `json:"name,omitempty"`
|
|
}
|
|
|
|
// ElementFile can be addon's definition or addon's component
|
|
type ElementFile struct {
|
|
Data string
|
|
Name string
|
|
}
|