Add EditorTemplate to editor.ui.k8s.appscode.com/v1alpha1

EditorTemplate is a read-only, create-only action resource that loads the editor
model, manifest and resources for an existing installation identified by its
metadata. It wraps kubepack.dev/lib-app/pkg/editor.LoadResourceEditorModel
(chart_template.go loadEditorModel2) and is served by kube-ui-server under a new
editor.ui.k8s.appscode.com API group.

Signed-off-by: Tamal Saha <tamal@appscode.com>

Author: tamalsaha

Makefile

@@ -23,7 +23,7 @@ COMPRESS ?= no
 # CRD_OPTIONS          ?= "crd:trivialVersions=true"
 CRD_OPTIONS          ?= "crd:allowDangerousTypes=true,crdVersions={v1}"
 CODE_GENERATOR_IMAGE ?= ghcr.io/appscode/gengo:release-1.32
-API_GROUPS           ?= core:v1alpha1 identity:v1alpha1 management:v1alpha1 meta:v1alpha1 node:v1alpha1 ui:v1alpha1
+API_GROUPS           ?= core:v1alpha1 editor:v1alpha1 identity:v1alpha1 management:v1alpha1 meta:v1alpha1 node:v1alpha1 ui:v1alpha1
 
 # Where to push the docker image.
 REGISTRY ?= appscode

apis/editor/doc.go

@@ -0,0 +1,21 @@
+/*
+Copyright AppsCode Inc. and Contributors
+
+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 editor
+
+const (
+	GroupName = "editor.ui.k8s.appscode.com"
+)

apis/editor/install/install.go

@@ -0,0 +1,30 @@
+/*
+Copyright AppsCode Inc. and Contributors
+
+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 install
+
+import (
+	"kmodules.xyz/resource-metadata/apis/editor/v1alpha1"
+
+	"k8s.io/apimachinery/pkg/runtime"
+	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
+)
+
+// Install registers the API group and adds types to a scheme
+func Install(scheme *runtime.Scheme) {
+	utilruntime.Must(v1alpha1.AddToScheme(scheme))
+	utilruntime.Must(scheme.SetVersionPriority(v1alpha1.SchemeGroupVersion))
+}

apis/editor/v1alpha1/doc.go

@@ -0,0 +1,23 @@
+/*
+Copyright AppsCode Inc. and Contributors
+
+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 v1alpha1 is the v1alpha1 version of the API.
+
+// +k8s:deepcopy-gen=package,register
+// +k8s:openapi-gen=true
+// +k8s:defaulter-gen=TypeMeta
+// +groupName=editor.ui.k8s.appscode.com
+package v1alpha1

apis/editor/v1alpha1/editortemplate_types.go

@@ -0,0 +1,80 @@
+/*
+Copyright AppsCode Inc. and Contributors
+
+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 v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	releasesapi "x-helm.dev/apimachinery/apis/releases/v1alpha1"
+)
+
+const (
+	ResourceKindEditorTemplate = "EditorTemplate"
+	ResourceEditorTemplate     = "editortemplate"
+	ResourceEditorTemplates    = "editortemplates"
+)
+
+// EditorTemplate loads the editor model, manifest and resources for an existing
+// installation identified by its metadata. It is the aggregated-API equivalent
+// of kubepack.dev/lib-app/pkg/editor.LoadResourceEditorModel (see
+// chart_template.go loadEditorModel2).
+//
+// +genclient
+// +genclient:nonNamespaced
+// +genclient:onlyVerbs=create
+// +k8s:openapi-gen=true
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:scope=Cluster
+type EditorTemplate struct {
+	metav1.TypeMeta `json:",inline"`
+	// Request identifies the installation to load.
+	// +optional
+	Request *EditorTemplateRequest `json:"request,omitempty"`
+	// Response holds the loaded editor template.
+	// +optional
+	Response *EditorTemplateResponse `json:"response,omitempty"`
+}
+
+type EditorTemplateRequest struct {
+	releasesapi.ModelMetadata `json:",inline"`
+	// ChartRef optionally selects the chart source. When unset, the resource
+	// editor chart resolved from the metadata resource is used.
+	// +optional
+	ChartRef *releasesapi.ChartSourceFlatRef `json:"chartRef,omitempty"`
+}
+
+type EditorTemplateResponse struct {
+	// Manifest is the rendered manifest of the existing installation.
+	// +optional
+	Manifest string `json:"manifest,omitempty"`
+	// Values is the editor model (values) of the existing installation.
+	// +optional
+	Values *runtime.RawExtension `json:"values,omitempty"`
+	// Resources holds the individual resources of the existing installation.
+	// +optional
+	Resources []EditorTemplateResource `json:"resources,omitempty"`
+}
+
+type EditorTemplateResource struct {
+	// +optional
+	Filename string `json:"filename,omitempty"`
+	// +optional
+	Key string `json:"key,omitempty"`
+	// +optional
+	Data *runtime.RawExtension `json:"data,omitempty"`
+}