mirror of
https://github.com/kubevela/kubevela.git
synced 2026-02-14 18:10:21 +00:00
128 lines
4.6 KiB
Go
128 lines
4.6 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/utils/schema"
|
|
)
|
|
|
|
// UIData contains all information represent an addon for UI
|
|
type UIData struct {
|
|
Meta
|
|
|
|
APISchema *openapi3.Schema `json:"schema"`
|
|
UISchema []*schema.UIParameter `json:"uiSchema"`
|
|
|
|
// Detail is README.md in an addon
|
|
Detail string `json:"detail,omitempty"`
|
|
|
|
Definitions []ElementFile `json:"definitions"`
|
|
CUEDefinitions []ElementFile `json:"CUEDefinitions"`
|
|
ConfigTemplates []ElementFile `json:"configTemplates"`
|
|
Parameters string `json:"parameters"`
|
|
GlobalParameters string `json:"globalParameters"`
|
|
RegistryName string `json:"registryName"`
|
|
|
|
AvailableVersions []string `json:"availableVersions"`
|
|
}
|
|
|
|
// InstallPackage contains all necessary files that can be installed for an addon
|
|
type InstallPackage struct {
|
|
Meta
|
|
|
|
// Definitions and CUEDefinitions are converted as OAM X-Definitions, they will only in control plane cluster
|
|
Definitions []ElementFile `json:"definitions"`
|
|
CUEDefinitions []ElementFile `json:"CUEDefinitions"`
|
|
|
|
ConfigTemplates []ElementFile `json:"configTemplates"`
|
|
|
|
// YAMLViews and CUEViews are the instances of velaql, they will only in control plane cluster
|
|
YAMLViews []ElementFile `json:"YAMLViews"`
|
|
CUEViews []ElementFile `json:"CUEViews"`
|
|
// DefSchemas are UI schemas read by VelaUX, it will only be installed in control plane clusters
|
|
DefSchemas []ElementFile `json:"defSchemas,omitempty"`
|
|
|
|
Parameters string `json:"parameters"`
|
|
|
|
// CUETemplates and YAMLTemplates are resources needed to be installed in managed clusters
|
|
CUETemplates []ElementFile `json:"CUETemplates"`
|
|
YAMLTemplates []ElementFile `json:"YAMLTemplates,omitempty"`
|
|
AppTemplate *v1beta1.Application `json:"appTemplate"`
|
|
AppCueTemplate ElementFile `json:"appCueTemplate,omitempty"`
|
|
Notes ElementFile `json:"notes,omitempty"`
|
|
}
|
|
|
|
// WholeAddonPackage contains all infos of an addon
|
|
type WholeAddonPackage struct {
|
|
InstallPackage
|
|
|
|
APISchema *openapi3.Schema `json:"schema"`
|
|
|
|
// Detail is README.md in an addon
|
|
Detail string `json:"detail,omitempty"`
|
|
AvailableVersions []string `json:"availableVersions"`
|
|
RegistryName string `json:"registryName"`
|
|
}
|
|
|
|
// 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"`
|
|
// UXPlugins used for velaux plugins download/install with the use of addon registry.
|
|
UXPlugins map[string]string `json:"uxPlugins,omitempty"`
|
|
DeployTo *DeployTo `json:"deployTo,omitempty"`
|
|
Dependencies []*Dependency `json:"dependencies,omitempty"`
|
|
NeedNamespace []string `json:"needNamespace,omitempty"`
|
|
Invisible bool `json:"invisible"`
|
|
SystemRequirements *SystemRequirements `json:"system,omitempty"`
|
|
// Annotations used for addon maintainers to add their own description or extensions to metadata.
|
|
Annotations map[string]string `json:"annotations,omitempty"`
|
|
}
|
|
|
|
// DeployTo defines where the addon to deploy to
|
|
type DeployTo struct {
|
|
// This field keep the compatible for older case
|
|
LegacyRuntimeCluster bool `json:"runtime_cluster,omitempty"`
|
|
DisableControlPlane bool `json:"disableControlPlane"`
|
|
RuntimeCluster bool `json:"runtimeCluster"`
|
|
}
|
|
|
|
// Dependency defines the other addons it depends on
|
|
type Dependency struct {
|
|
Name string `json:"name,omitempty"`
|
|
Version string `json:"version,omitempty"`
|
|
}
|
|
|
|
// ElementFile can be addon's definition or addon's component
|
|
type ElementFile struct {
|
|
Data string
|
|
Name string
|
|
}
|
|
|
|
// SystemRequirements is this addon need version
|
|
type SystemRequirements struct {
|
|
VelaVersion string `json:"vela,omitempty"`
|
|
KubernetesVersion string `json:"kubernetes,omitempty"`
|
|
}
|