Skip to content

README.md

Latest commit

 

History

History
126 lines (95 loc) · 4.13 KB

README.md

File metadata and controls

126 lines (95 loc) · 4.13 KB
Raw

sealos frontend

Development setup

  • It's recommended using this directory (/frontend) as root for your workspace.
  • We use pnpm for package management, you should have it installed before getting started. (Tutorial)
  • Desktop app is under desktop/ directory, sub apps are under providers/<package>/.

Install dependencies

The post install script will run automatically, and local packages should be built.

pnpm install

Generate Prisma clients for desktop app

cd desktop
pnpm gen:global && pnpm gen:region

Prepare environment variables

.env.template files are located at the workspace root directory for each app. Duplicate and rename them to .env, then fill the required configurations.

NEXT_PUBLIC_MOCK_USER is the kubeconfig mocked for development, you can copy it from your Sealos desktop. (Only one line allowed, you should escape the line breaks)

Run apps for development

You can either run apps in workspace root or in specific app's directory.

# Run desktop app
pnpm dev-desktop

# Run specific provider app
pnpm dev-app        # applaunchpad
pnpm dev-db         # dbprovider
pnpm dev-cost       # costcenter
pnpm dev-terminal   # terminal
pnpm dev-template   # template
pnpm dev-cronjob    # cronjob

# or run dev script in app's package directory
cd desktop
pnpm dev

how to add packages

cd frontend
# add remote
pnpm --filter=<path> -r add <package>
# such as:
# pnpm --filter=providers/costcenter -r add lodash
# pnpm --filter=desktop -r add lodash
# add local
pnpm --filter=<path> -r --offline add <package>
# such as:
# pnpm --filter=providers/costcenter -r --offline add sealos-desktop-sdk
# pnpm --filter=desktop -r --offline add sealos-desktop-sdk

how to build

# sealos/frontend
make image-build-<app> DOCKER_USERNAME=<your_account> IMAGE_TAG=<tag>
# such as:
# make image-build-providers/costcenter
# make image-build-desktop
# make image-build-desktop IMAGE_TAG=test DOCKER_USERNAME=sealos
# multi jobs build
make -j
  • you can use make all DOCKER_USERNAME=<your_account> to build all apps for your account.
  • you can user make all IMAGE_TAG=<tag> to build all apps and customize tag (default:dev)

how to publish image

# sealos/frontend
make image-push-<app> DOCKER_USERNAME=<your_account> IMAGE_TAG=<tag>
# such as:
# make image-push-providers/costcenter
# make image-push-desktop

# publish all
make push-images DOCKER_USERNAME=<your_account> IMAGE_TAG=<tag>

Add a provider frontend

Use an existing provider as the reference and keep these deployment surfaces in sync:

  1. .github/workflows/frontends.yml change detection and Helm validation
  2. frontend/Makefile image build target
  3. frontend/providers/<app>/deploy/Kubefile
  4. frontend/providers/<app>/deploy/<app>-frontend-entrypoint.sh
  5. frontend/providers/<app>/deploy/charts/<release>/Chart.yaml
  6. Chart defaults in values.yaml and, when needed, user overrides in <release>-values.yaml
  7. Chart templates for the App CR (where applicable), Deployment, Service, Ingress, probes, and helm test

Validate the defaults and any user values file before publishing an image:

helm lint frontend/providers/<app>/deploy/charts/<release>
helm template <release> frontend/providers/<app>/deploy/charts/<release> >/dev/null
# Run this pair only when <release>-values.yaml exists.
helm lint frontend/providers/<app>/deploy/charts/<release> \
  -f frontend/providers/<app>/deploy/charts/<release>/<release>-values.yaml
helm template <release> frontend/providers/<app>/deploy/charts/<release> \
  -f frontend/providers/<app>/deploy/charts/<release>/<release>-values.yaml >/dev/null

After deployment, run helm test <release> -n <namespace> --logs and smoke-test the rendered App CR URL. Deployment-only migrations must preserve existing application routing; route behavior changes belong in a separate application change.

multiple namespaces

In order to support multiple namespaces, the method of obtaining 'namespace' in the backend should be replaced with the method of obtaining it from 'kubeconfig' instead of adding 'ns-' to 'user' for generation purpose.