feat: add developer portal (#1351)

feat: enable a developer portal to go along kusion server

---------

Co-authored-by: Yang Yang <yy449738@antgroup.com>

Author: hai-tian

.gitignore

@@ -59,5 +59,10 @@ air.toml
 # frontend
 frontend/
 
+# ui
+ui/build/*
+!ui/build/.gitkeep
+node_modules/
+
 # Terraform provider binary folder
 .terraform/ 

Dockerfile

@@ -1,7 +1,15 @@
+# Build portal
+FROM node:18 AS portal-builder
+COPY ui /src/ui
+WORKDIR /src/ui
+RUN npm install
+RUN npm run build
+
 FROM golang:1.22 AS build
 COPY / /src
+COPY --from=portal-builder /src/ui/build /src/ui/build
 WORKDIR /src
-RUN --mount=type=cache,target=/go/pkg --mount=type=cache,target=/root/.cache/go-build make build-local-linux
+RUN --mount=type=cache,target=/go/pkg --mount=type=cache,target=/root/.cache/go-build SKIP_BUILD_PORTAL=true make build-local-linux
 
 FROM ubuntu:22.04 AS base
 # Install KCL Dependencies
@@ -18,4 +26,5 @@ RUN /usr/local/bin/kusion
 
 FROM base
 COPY --from=build /src/_build/bundles/kusion-linux/bin/kusion /usr/local/bin/kusion
+COPY --from=build /src/ui/build /usr/local/bin/ui/build
 RUN /usr/local/bin/kusion

Makefile

@@ -25,6 +25,25 @@ KCLVM_URL_BASE_MIRRORS:=
 CCRED=\033[0;31m
 CCEND=\033[0m
 
+# Check if the SKIP_BUILD_PORTAL flag is set to control the portal building process.
+# If the flag is not set, the BUILD_PORTAL variable is assigned the value 'build-portal'.
+# If the flag is set, the BUILD_PORTAL variable remains empty.
+ifndef SKIP_BUILD_PORTAL
+	BUILD_PORTAL = build-portal
+else
+	BUILD_PORTAL =
+endif
+
+# Show the portal build status
+show-portal-status:
+	@if [ "$(BUILD_PORTAL)" = "build-portal" ]; then \
+		echo "🚀 Building the portal as SKIP_BUILD_PORTAL is not set."; \
+		echo ""; \
+	else \
+		echo "⏭️  Skipping the portal build as SKIP_BUILD_PORTAL is set."; \
+		echo ""; \
+	fi
+
 help:  ## This help message :)
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
@@ -66,7 +85,7 @@ clean:  ## Clean build bundles
 
 build-all: build-local-darwin-all build-local-linux-all build-local-darwin-arm64-all build-local-windows-all ## Build all platforms (darwin, linux, windows)
 
-build-local-darwin:  ## Build kusion tool chain for macOS
+build-local-darwin: show-portal-status $(BUILD_PORTAL) ## Build kusion tool chain for macOS
 	# Delete old artifacts
 	-rm -f ./pkg/version/z_update_version.go
 	-rm -rf ./_build/bundles/kusion-darwin
@@ -87,7 +106,7 @@ build-local-darwin-all: build-local-darwin ## Build kusion for macOS
 	cd ./_build/bundles/kusion-darwin && tar -zcvf ../kusion-darwin.tgz .
 	cd ./_build/bundles && go run ../../hack/md5file/main.go kusion-darwin.tgz > kusion-darwin.tgz.md5.txt
 
-build-local-darwin-arm64: ## Build kusion tool chain for macOS arm64
+build-local-darwin-arm64: show-portal-status $(BUILD_PORTAL) ## Build kusion tool chain for macOS arm64
 	# Delete old artifacts
 	-rm -f ./pkg/version/z_update_version.go
 	-rm -rf ./_build/bundles/kusion-darwin-arm64
@@ -118,7 +137,7 @@ build-local-linux-in-docker: ## Build kusionctl-linux in docker
 build-local-linux-all-in-docker: ## Build kusionctl-linux with kcl and kclopenapi in docker
 	${RUN_IN_DOCKER} make build-local-linux-all
 
-build-local-linux:  ## Build kusion tool chain for linux
+build-local-linux: show-portal-status $(BUILD_PORTAL) ## Build kusion tool chain for linux
 	# Delete old artifacts
 	-rm -f ./pkg/version/z_update_version.go
 	-rm -rf ./_build/bundles/kusion-linux
@@ -143,7 +162,7 @@ build-local-linux-all: build-local-linux  ## Build kusion for linux
 	cd ./_build/bundles/kusion-linux && tar -zcvf ../kusion-linux.tgz  .
 	cd ./_build/bundles && go run ../../hack/md5file/main.go kusion-linux.tgz > kusion-linux.tgz.md5.txt
 
-build-local-windows:  ## Build kusion tool chain for windows
+build-local-windows: show-portal-status $(BUILD_PORTAL) ## Build kusion tool chain for windows
 	# Delete old artifacts
 	-rm -f ./pkg/version/z_update_version.go
 	-rm -rf ./_build/bundles/kusion-windows
@@ -168,9 +187,11 @@ build-local-windows-all: build-local-windows  ## Build kusion for windows
 	cd ./_build/bundles/kusion-windows && zip -r ../kusion-windows.zip .
 	cd ./_build/bundles && go run ../../hack/md5file/main.go kusion-windows.zip > kusion-windows.zip.md5.txt
 
+build-portal:  ## Build kusion portal
+	cd ui && npm install && npm run build && touch build/.gitkeep
+
 build-image:  ## Build kusion image
-	make build-local-linux-all
-	docker build -t kusion/kusion .
+	docker build -t kusionstack/kusion .
 
 sh-in-docker:  ## Run a shell in the docker container of kusion
 	${RUN_IN_DOCKER} bash
@@ -190,4 +211,4 @@ gen-api-doc: ## Generate API Documentation by API Specification
 	@which swagger > /dev/null || (echo "Installing swagger@v0.30.5 ..."; go install github.com/go-swagger/go-swagger/cmd/swagger@v0.30.5 && echo "Installation complete!\n")
 	-swagger generate markdown -f ./api/openapispec/swagger.json --output=docs/api.md && echo "🎉 Done!" || (echo "💥 Fail!"; exit 1)
 
-.PHONY: test cover cover-html format lint lint-fix doc build-changelog upload clean build-all build-image build-local-linux build-local-windows build-local-linux-all build-local-windows-all e2e-test gen-api-spec gen-api-doc
+.PHONY: test cover cover-html format lint lint-fix doc build-changelog upload clean build-all build-image build-local-linux build-local-windows build-local-linux-all build-local-windows-all e2e-test gen-api-spec gen-api-doc build-portal show-portal-status

pkg/cmd/server/options.go

@@ -20,6 +20,7 @@ func NewServerOptions() *ServerOptions {
 		MaxAsyncConcurrent: constant.MaxAsyncConcurrent,
 		MaxAsyncBuffer:     constant.MaxAsyncBuffer,
 		LogFilePath:        constant.DefaultLogFilePath,
+		DevPortalEnabled:   true,
 	}
 }
 
@@ -42,6 +43,7 @@ func (o *ServerOptions) Config() (*server.Config, error) {
 	cfg.MaxAsyncConcurrent = o.MaxAsyncConcurrent
 	cfg.MaxAsyncBuffer = o.MaxAsyncBuffer
 	cfg.LogFilePath = o.LogFilePath
+	cfg.DevPortalEnabled = o.DevPortalEnabled
 	return cfg, nil
 }
 

pkg/cmd/server/server.go

@@ -57,6 +57,8 @@ func (o *ServerOptions) AddServerFlags(cmd *cobra.Command) {
 		i18n.T("Maximum number of concurrent async executions including generate, preview, apply and destroy. Default to 10."))
 	cmd.Flags().StringVarP(&o.LogFilePath, "log-file-path", "", constant.DefaultLogFilePath,
 		i18n.T("File path to write logs to. Default to /home/admin/logs/kusion.log"))
+	cmd.Flags().BoolVarP(&o.DevPortalEnabled, "dev-portal-enabled", "d", true,
+		i18n.T("Enable dev portal. Default to true."))
 	o.Database.AddFlags(cmd.Flags())
 	o.DefaultBackend.AddFlags(cmd.Flags())
 	o.DefaultSource.AddFlags(cmd.Flags())

pkg/cmd/server/types.go

@@ -17,6 +17,7 @@ type ServerOptions struct {
 	MaxAsyncConcurrent int
 	MaxAsyncBuffer     int
 	LogFilePath        string
+	DevPortalEnabled   bool
 }
 
 type Options interface {

pkg/domain/entity/resource.go

@@ -63,6 +63,8 @@ type ResourceInfo struct {
 	IAMResourceID string `yaml:"iamResourceID" json:"iamResourceID"`
 	// CloudResourceID is the id of the resource in the cloud.
 	CloudResourceID string `yaml:"cloudResourceID" json:"cloudResourceID"`
+	// ResourceURN is the urn of the resource.
+	ResourceURN string `yaml:"resourceURN" json:"resourceURN"`
 	// Status is the status of the resource.
 	Status string `yaml:"status" json:"status"`
 }
@@ -138,6 +140,7 @@ func (rg *ResourceGraph) ConstructResourceGraph(resources []*Resource) error {
 			ResourceName:    resource.ResourceName,
 			IAMResourceID:   resource.IAMResourceID,
 			CloudResourceID: resource.CloudResourceID,
+			ResourceURN:     resource.ResourceURN,
 			Status:          resource.Status,
 		}
 		rg.Resources[resource.KusionResourceID] = info

pkg/server/config.go

@@ -18,6 +18,7 @@ type Config struct {
 	MaxAsyncBuffer     int
 	LogFilePath        string
 	AutoMigrate        bool
+	DevPortalEnabled   bool
 }
 
 func NewConfig() *Config {

pkg/server/handler/module/handler.go

@@ -97,7 +97,7 @@ func (h *Handler) DeleteModule() http.HandlerFunc {
 // @Failure		429								{object}	error									"Too Many Requests"
 // @Failure		404								{object}	error									"Not Found"
 // @Failure		500								{object}	error									"Internal Server Error"
-// @Router			/api/v1/modules/{moduleName} 																																																																																																																																																																																																													[put]
+// @Router			/api/v1/modules/{moduleName} 																																																																																																																																																																																																																								[put]
 func (h *Handler) UpdateModule() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// Getting stuff from context.
@@ -139,7 +139,7 @@ func (h *Handler) UpdateModule() http.HandlerFunc {
 // @Failure		429								{object}	error									"Too Many Requests"
 // @Failure		404								{object}	error									"Not Found"
 // @Failure		500								{object}	error									"Internal Server Error"
-// @Router			/api/v1/modules/{moduleName} 																																																																																																																																																																																											[get]
+// @Router			/api/v1/modules/{moduleName} 																																																																																																																																																																																																						[get]
 func (h *Handler) GetModule() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// Getting stuff from context.

pkg/server/handler/workspace/configs.go

@@ -116,7 +116,7 @@ func (h *Handler) UpdateWorkspaceConfigs() http.HandlerFunc {
 // @Failure		429													{object}	error	"Too Many Requests"
 // @Failure		404													{object}	error	"Not Found"
 // @Failure		500													{object}	error	"Internal Server Error"
-// @Router			/api/v1/workspaces/{workspaceID}/configs/mod-deps 																																																	[post]
+// @Router			/api/v1/workspaces/{workspaceID}/configs/mod-deps 																																																				[post]
 func (h *Handler) CreateWorkspaceModDeps() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// Getting stuff from context.