### Test Environment Setup

Source: https://github.com/labring/sealos/blob/main/frontend/desktop/README.md

Instructions for setting up the test environment by configuring the NODE_ENV variable and starting the development server before running tests.

```bash
# Set environment variable for testing
# Linux/macOS:
export NODE_ENV=test
# Windows PowerShell:
$env:NODE_ENV="test"

# Start the development server
pnpm dev

# Run tests in watch mode
pnpm test:w
```

--------------------------------

### Example Global YAML Configuration

Source: https://github.com/labring/sealos/blob/main/proposal/design/en/global-yaml-usage-convention.md

Demonstrates a typical structure for global configuration, including settings for installation, billing, certificates, HTTP, storage, and feature configurations.

```yaml
global:
  install:
    dryRun: false
  billing:
    currency: cny
  cert:
    mode: self-signed
    certFile: ""
    keyFile: ""
  http:
    domain: 127.0.0.1.nip.io
    httpsPort: 443
    httpPort: 80
    disableHttps: false
  storage:
    openebs:
      storage: /data/openebs
      vgName: ""
      volumeGroups: []
      nfs:
        storageClass:
          name: nfs-csi
          annotations:
            storageclass.kubernetes.io/is-default-class: "false"
          parameters:
            server: ""
            share: "/"
            subDir: ""
            mountPermissions: "0777"
          reclaimPolicy: Delete
          volumeBindingMode: Immediate
          mountOptions:
            - nfsvers=4.1
            - hard
  featureConfigs:
    database:
      type: cockroachdb
      kubeblocksVersion: "0.8.2"
      version: v23.1.11
      mongodbURI: ""
      nmAgentMongodbURI: ""
```

--------------------------------

### Install Dependencies

Source: https://github.com/labring/sealos/blob/main/frontend/providers/costcenter/README.md

Installs project dependencies using npm. Run this before starting the development server.

```bash
npm install
```

--------------------------------

### Start Production Server

Source: https://github.com/labring/sealos/blob/main/frontend/providers/costcenter/README.md

Starts the production server after the project has been built. Use this for live deployments.

```bash
npm start
```

--------------------------------

### Start Development Server

Source: https://github.com/labring/sealos/blob/main/frontend/desktop/README.md

Run this command to start the development server for the Next.js project. Open http://localhost:3000 in your browser to view the application.

```bash
pnpm run dev
```

--------------------------------

### Download and Install sealos and image-cri-shim

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/USAGE.md

Download the sealos package, extract it, and install the sealos binary and the image-cri-shim binary to the system path. Verify the installation of image-cri-shim.

```bash
# Download sealos (recommend v5.1.0-rc3 or higher version)
wget https://github.com/labring/sealos/releases/download/v5.1.0-rc3/sealos_5.1.0-rc3_linux_amd64.tar.gz

# Extract
tar -xzf sealos_5.1.0-rc3_linux_amd64.tar.gz

# Install sealos to system path
sudo cp sealos /usr/local/bin/
sudo chmod +x /usr/local/bin/sealos

# Extract image-cri-shim from sealos package
sudo cp image-cri-shim /usr/local/bin/
sudo chmod +x /usr/local/bin/image-cri-shim

# Verify installation
image-cri-shim --version
```

--------------------------------

### Install Sealos Desktop SDK

Source: https://github.com/labring/sealos/blob/main/frontend/packages/client-sdk/README.md

Install the SDK using npm, pnpm, or yarn.

```bash
# Using npm
npm install @zjy365/sealos-desktop-sdk

# Using pnpm
pnpm add @zjy365/sealos-desktop-sdk

# Using yarn
yarn add @zjy365/sealos-desktop-sdk
```

--------------------------------

### Install Sealos via Script

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.0.md

Install Sealos by downloading and executing an installation script. Specify the desired version and image repository.

```shell
curl -sfL  https://raw.githubusercontent.com/labring/sealos/v4.2.0/scripts/install.sh \
    | sh -s v4.2.0 labring/sealos
```

--------------------------------

### Global Configuration Example

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/CONFIGMAP_GUIDE.md

Example of setting global configuration parameters like reload interval, debug mode, and gRPC timeout.

```yaml
reloadInterval: 15s   # 配置重载间隔
debug: false          # Debug 模式
timeout: 15m          # gRPC 超时时间
force: false          # 强制模式
```

--------------------------------

### Full Configuration Example for Account Service Deployment

Source: https://github.com/labring/sealos/blob/main/service/account/deploy/README.md

A comprehensive example demonstrating various configuration options for deploying the account-service, including namespace, image, resources, probes, and autoscaling.

```shell
# 8. 完整配置示例
sealos run labring/account-service:latest \
  --env RELEASE_NAMESPACE=production-account \
  --env HELM_OPTS="--set replicaCount=3 \
    --set image=ghcr.io/labring/sealos-account-service:v1.0.0 \
    --set resources.limits.cpu=1000m \
    --set resources.limits.memory=512Mi \
    --set resources.requests.cpu=100m \
    --set resources.requests.memory=50Mi \
    --set livenessProbe.initialDelaySeconds=10 \
    --set readinessProbe.initialDelaySeconds=10"
```

--------------------------------

### Install dependencies

Source: https://github.com/labring/sealos/blob/main/frontend/README.md

Install all required project dependencies using pnpm.

```sh
pnpm install
```

--------------------------------

### Development Tools Installation

Source: https://github.com/labring/sealos/blob/main/frontend/packages/client-sdk/README.md

Install necessary development tools like yalc and nodemon for local development.

```bash
# 1. Install development tools
npm i -g yalc nodemon
```

--------------------------------

### Install and Run Controller (One Step)

Source: https://github.com/labring/sealos/blob/main/controllers/license/README.md

A shortcut to install the CRDs and run the controller in a single command.

```sh
make install run
```

--------------------------------

### Cache Configuration Example

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/CONFIGMAP_GUIDE.md

Example of configuring cache settings, including image cache size, TTLs, and statistics logging.

```yaml
cache:
  imageCacheSize: 1024        # 镜像缓存大小
  imageCacheTTL: 30m          # 镜像缓存过期时间
  domainCacheTTL: 10m         # 域名缓存过期时间
  statsLogInterval: 1m        # 统计日志输出间隔
  disableStats: false         # 禁用统计
```

--------------------------------

### Install Golang on Linux

Source: https://github.com/labring/sealos/blob/main/lifecycle/DEVELOPGUIDE.md

Installs Go version 1.20.x on a Linux system and updates the PATH environment variable.

```shell
wget https://go.dev/dl/go1.20.linux-amd64.tar.gz
tar -C /usr/local -zxvf go1.20.linux-amd64.tar.gz
cat >> /etc/profile <<EOF
# set go path
export PATH=$PATH:/usr/local/go/bin
EOF
source /etc/profile  && go version
```

--------------------------------

### Set Go Path and Verify Version

Source: https://github.com/labring/sealos/blob/main/lifecycle/DEVELOPGUIDE.md

Configures the Go binary path and checks the installed Go version. Ensure Go is installed and accessible in your system's PATH.

```shell
export PATH=$PATH:/usr/local/go/bin
source /etc/profile && go version
```

--------------------------------

### Sealos Configuration Example

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/CONFIGMAP_GUIDE.md

Example of configuring the sealos.hub address and authentication credentials within the ConfigMap.

```yaml
sealos:
  address: http://sealos.hub:5000  # sealos.hub 地址
  auth:
    username: admin                # 认证用户名
    password: passw0rd             # 认证密码
```

--------------------------------

### Install Ginkgo Tool

Source: https://github.com/labring/sealos/blob/main/lifecycle/test/e2e/Readme.md

Installs the Ginkgo testing tool, required for running Go tests. Ensure Go is installed and configured in your PATH.

```console
go install github.com/onsi/ginkgo/ginkgo@v1.16.2
```

--------------------------------

### Download and Install Sealos for arm64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.4.md

Use this command to download the Sealos binary for arm64 architecture, make it executable, and move it to your PATH. Ensure you have wget installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.4/sealos_4.1.4_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.4_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos for arm64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.0-rc2.md

Use this command to download the Sealos binary for arm64 architecture, make it executable, and move it to your PATH. Ensure you have wget installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.0-rc2/sealos_4.1.0-rc2_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.0-rc2_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Install Build Tools and Golang in Multipass VM

Source: https://github.com/labring/sealos/blob/main/lifecycle/DEVELOPGUIDE.md

Installs essential build tools (make, build-essential) and Go version 1.20.x (arm64) within a multipass VM.

```shell
apt-get install build-essential
apt install make
wget https://go.dev/dl/go1.20.linux-arm64.tar.gz
tar -C /usr/local -zxvf go1.20.linux-arm64.tar.gz
cat >> /etc/profile <<EOF

```

--------------------------------

### Download and Install Sealos Client (arm64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.7.md

Use this command to download the Sealos client binary for arm64 architecture, extract it, make it executable, and move it to your PATH. Ensure you have wget installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.7/sealos_4.1.7_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.7_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos Client (amd64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.7.md

Use this command to download the Sealos client binary for amd64 architecture, extract it, make it executable, and move it to your PATH. Ensure you have wget installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.7/sealos_4.1.7_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.1.7_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Local Configuration File Example

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/USAGE.md

This is a complete example of the local configuration file (`config.yaml`) for the image CRI shim. It specifies registry details, authentication, and service-level configurations.

```yaml
# Shim service configuration
shim: /var/run/image-cri-shim.sock          # Shim socket path
cri: /run/containerd/containerd.sock        # CRI runtime socket

# Primary registry configuration
address: https://registry.company.com       # Primary registry address
auth: registry-user:registry-password       # Primary registry authentication

# Additional registry list
registries:
- address: https://backup-registry.company.com
  auth: backup-user:backup-pass
- address: https://public.registry.com
  auth: ""  # Public registry requires no authentication

# Service configuration
force: false                                # Force startup mode
debug: false                                # Debug mode
timeout: 15m                                # Operation timeout
reloadInterval: 30s                         # Configuration reload interval
cache:
  imageCacheSize: 1024                      # Max cached rewrite entries (set 0 to disable)
  imageCacheTTL: 30m                        # TTL for rewritten image entries
  domainCacheTTL: 10m                       # TTL for domain→registry matches
  statsLogInterval: 60s                     # Periodic cache stats log (set 0 to stop)
  disableStats: false                       # true disables stats logging entirely

```

--------------------------------

### Download and Install Sealos for amd64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.0-rc2.md

Use this command to download the Sealos binary for amd64 architecture, make it executable, and move it to your PATH. Ensure you have wget installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.0-rc2/sealos_4.1.0-rc2_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.1.0-rc2_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos for amd64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.4.md

Use this command to download the Sealos binary for amd64 architecture, make it executable, and move it to your PATH. Ensure you have wget installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.4/sealos_4.1.4_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.1.4_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos Client (arm64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.3.md

Use this command to download the Sealos client binary for arm64 architecture, make it executable, and move it to your PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.3/sealos_4.1.3_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.3_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos Client (amd64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.3.md

Use this command to download the Sealos client binary for amd64 architecture, make it executable, and move it to your PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.3/sealos_4.1.3_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.1.3_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos for arm64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.1.md

Use this command to download the Sealos binary for arm64 architecture, make it executable, and move it to your PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.1/sealos_4.1.1_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.1_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos for arm64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.0-rc1.md

Use this command to download the Sealos binary for arm64 architecture, make it executable, and move it to your PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.0-rc1/sealos_4.1.0-rc1_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.0-rc1_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos for arm64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.0.md

Use this command to download the Sealos binary for arm64 architecture, make it executable, and move it to your PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.0/sealos_4.1.0_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.0_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Example: Enable GitHub and Google Login

Source: https://github.com/labring/sealos/blob/main/frontend/desktop/deploy/HELM_VALUES_GUIDE_CN.md

Enable and configure GitHub and Google OAuth for user authentication in Sealos Desktop.

```bash
sealos run desktop-frontend:latest \
  -e HELM_OPTIONS="--set desktopConfig.githubEnabled=true --set desktopConfig.githubClientId=your-github-id --set desktopConfig.githubClientSecret=your-github-secret --set desktopConfig.googleEnabled=true --set desktopConfig.googleClientId=your-google-id --set desktopConfig.googleClientSecret=your-google-secret"
```

--------------------------------

### High Availability Configuration Example

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/USAGE.md

YAML configuration for a high-availability setup with multiple regional registries and public sources.

```yaml
# High availability production environment configuration
shim: /var/run/image-cri-shim.sock
cri: /run/containerd/containerd.sock
address: https://ha-registry.company.com
auth: ha-user:ha-pass
force: true
debug: false
timeout: 30m
reloadInterval: 30s
registries:
# Primary and backup registry configuration
- address: https://registry-region1.company.com
  auth: region1-user:region1-pass
- address: https://registry-region2.company.com
  auth: region2-user:region2-pass
- address: https://registry-region3.company.com
  auth: region3-user:region3-pass
# Public image sources
- address: https://mirror.gcr.io
  auth: ""
- address: https://registry.k8s.io
  auth: ""
```

--------------------------------

### Download and Install Sealos for arm64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.5.md

Use this command to download the Sealos client binary for arm64 architecture, make it executable, and move it to your system's PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.5/sealos_4.1.5_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.5_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos for amd64

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.5.md

Use this command to download the Sealos client binary for amd64 architecture, make it executable, and move it to your system's PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.5/sealos_4.1.5_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.1.5_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Example: Full Production Environment Configuration

Source: https://github.com/labring/sealos/blob/main/frontend/desktop/deploy/HELM_VALUES_GUIDE_CN.md

Apply a comprehensive set of configurations for a production environment, including domain, region, authentication, SMS, email, and tracking.

```bash
sealos run desktop-frontend:latest \
  -e HELM_OPTIONS="
    --set desktopConfig.cloudDomain=production.example.com
    --set desktopConfig.regionUID=prod-region-001
    --set desktopConfig.version=cn
    --set desktopConfig.githubEnabled=true
    --set desktopConfig.githubClientId=prod-github-id
    --set desktopConfig.githubClientSecret=prod-github-secret
    --set desktopConfig.smsEnabled=true
    --set desktopConfig.smsAliEnabled=true
    --set desktopConfig.smsAliAccessKeyID=prod-sms-key-id
    --set desktopConfig.smsAliAccessKeySecret=prod-sms-key-secret
    --set desktopConfig.emailEnabled=true
    --set desktopConfig.emailHost=smtp.production.example.com
    --set desktopConfig.emailPort=587
    --set desktopConfig.emailUser=noreply@production.example.com
    --set desktopConfig.emailPassword=prod-email-password
    --set desktopConfig.trackingEnabled=true
    --set desktopConfig.trackingWebsiteId=prod-website-id
  "
```

--------------------------------

### Example: Configure SMS and Email

Source: https://github.com/labring/sealos/blob/main/frontend/desktop/deploy/HELM_VALUES_GUIDE_CN.md

Enable and configure SMS (Aliyun) and email services for notifications. Ensure all necessary credentials and endpoints are provided.

```bash
sealos run desktop-frontend:latest \
  -e HELM_OPTIONS="--set desktopConfig.smsEnabled=true --set desktopConfig.smsAliEnabled=true --set desktopConfig.smsAliEndpoint=https://dysmsapi.aliyuncs.com --set desktopConfig.smsAliAccessKeyID=your-key-id --set desktopConfig.smsAliAccessKeySecret=your-key-secret --set desktopConfig.emailEnabled=true --set desktopConfig.emailHost=smtp.example.com --set desktopConfig.emailPort=587 --set desktopConfig.emailUser=noreply@example.com --set desktopConfig.emailPassword=your-password"
```

--------------------------------

### Sealfile for Cluster with Pre-Install Action

Source: https://github.com/labring/sealos/blob/main/proposal/design/zh/App actions 设计.md

A Sealfile that includes a custom action to modify DNS settings before installation. This image is then built and run to apply the action during cluster setup.

```docker
FROM kubernetes:v1.25.0
COPY change-dns-actions.yaml actions/
```

--------------------------------

### Install Sealos Binary

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.1-rc3.md

Installs the Sealos binary for version v4.2.1-rc3 using a script. Ensure you have curl installed.

```shell
curl -sfL  https://raw.githubusercontent.com/labring/sealos/v4.2.1-rc3/scripts/install.sh \
    | sh -s v4.2.1-rc3 labring/sealos
```

--------------------------------

### Install Sealos Binary

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.0-alpha3.md

Installs the Sealos binary for version v4.2.0-alpha3 using a script. Ensure you have curl installed.

```shell
    curl -sfL  https://raw.githubusercontent.com/labring/sealos/v4.2.0-alpha3/scripts/install.sh \
    | sh -s v4.2.0-alpha3 labring/sealos
```

--------------------------------

### Run Account Controller with Default Configuration

Source: https://github.com/labring/sealos/blob/main/controllers/account/deploy/README.md

Use this command to quickly start the Account Controller with its default settings. No additional configuration is required.

```bash
sealos run account-controller:latest
```

--------------------------------

### Install Sealos Binary

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.1-rc4.md

Installs the Sealos binary for version v4.2.1-rc4 using a script. Ensure you have curl installed.

```shell
    curl -sfL  https://raw.githubusercontent.com/labring/sealos/v4.2.1-rc4/scripts/install.sh \
    | sh -s v4.2.1-rc4 labring/sealos
```

--------------------------------

### Install Sealos Binary

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.1-rc1.md

Installs the Sealos binary for version v4.2.1-rc1 using a script. Ensure you have curl installed.

```shell
curl -sfL  https://raw.githubusercontent.com/labring/sealos/v4.2.1-rc1/scripts/install.sh \
    | sh -s v4.2.1-rc1 labring/sealos
```

--------------------------------

### Install Sealos using Yum

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.0.md

Install Sealos after configuring the Yum repository by running the `yum install sealos` command.

```shell
yum install sealos
```

--------------------------------

### Run Sealos Resources Controller with Full Configuration

Source: https://github.com/labring/sealos/blob/main/controllers/resources/deploy/README.md

A comprehensive example demonstrating the deployment of the resources controller with all major configuration options set, including MongoDB URIs, namespace, backup status, and Helm options for replica count.

```shell
# 5. 完整配置示例
sealos run ghcr.io/labring/sealos-cloud-resources-controller:latest \
  --env MONGO_URI="mongodb://admin:password123@10.0.0.1:27017/resources?authSource=admin" \
  --env TRAFFIC_MONGO_URI="mongodb://admin:password123@10.0.0.1:27017/traffic?authSource=admin" \
  --env RELEASE_NAMESPACE="production" \
  --env RESOURCES_BACKUP_ENABLED="false" \
  --env HELM_OPTS="--set replicaCount=2"
```

--------------------------------

### Setup Client-Side Defaults for App Config

Source: https://github.com/labring/sealos/blob/main/frontend/packages/shared/src/hooks/README.md

Initialize default query options and set up the client application configuration defaults using a `QueryClient`. This is typically done in your application's entry file.

```typescript
// src/pages/_app.tsx
import { setupClientAppConfigDefaults } from '@sealos/shared';

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      cacheTime: 0 // Global default
    }
  }
});

setupClientAppConfigDefaults(queryClient, ['client-app-config']);
```

--------------------------------

### Install Sealos using APT

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.0.md

Install Sealos on Debian-based systems after configuring the APT repository by running `apt-get update` and `apt-get install sealos`.

```bash
apt-get update
apt-get install sealos
```

--------------------------------

### Download and Install Sealos Client (arm64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.5-rc2.md

Use this command to download the Sealos client binary for arm64 architecture, make it executable, and move it to your system's PATH. This is the first step before creating a cluster.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.5-rc2/sealos_4.1.5-rc2_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.5-rc2_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Install @sealos/gtm

Source: https://github.com/labring/sealos/blob/main/frontend/packages/gtm/README.md

Install the @sealos/gtm package using pnpm.

```bash
pnpm add @sealos/gtm
```

--------------------------------

### Download and Install Sealos Client (amd64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.5-rc2.md

Use this command to download the Sealos client binary for amd64 architecture, make it executable, and move it to your system's PATH. This is the first step before creating a cluster.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.5-rc2/sealos_4.1.5-rc2_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.1.5-rc2_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Image-cri-shim Startup Sync Workflow

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/CONFIGMAP_GUIDE.md

Illustrates the sequence of operations during image-cri-shim startup, including reading local config, syncing from ConfigMap, and proceeding with normal startup.

```text
image-cri-shim 启动
    ↓
读取本地配置文件
    ↓
调用 SyncConfigFromConfigMap()
    ↓
连接 Kubernetes API
    ↓
读取 kube-system/image-cri-shim ConfigMap
    ↓
合并配置到本地文件
    ↓
继续正常启动流程
```

--------------------------------

### Build and Run Kubernetes with Pre-Install Action

Source: https://github.com/labring/sealos/blob/main/proposal/design/zh/App actions 设计.md

Commands to build a Kubernetes cluster image that includes a pre-install action and then run the cluster. The action will be executed automatically during the installation process.

```bash
sealos build -t my-kuberentes:v1.25.0 .
sealos run my-kuberentes:v1.25.0
```

--------------------------------

### Build and Push Docker Image

Source: https://github.com/labring/sealos/blob/main/controllers/app/README.md

Build the Docker image for the application and push it to a container registry. Replace `<some-registry>/app:tag` with your registry details.

```sh
make docker-build docker-push IMG=<some-registry>/app:tag
```

--------------------------------

### Scenario 1: Admin Unified Registry Configuration

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/CONFIGMAP_GUIDE.md

Demonstrates how a cluster administrator can uniformly manage registry configurations across all nodes by creating a ConfigMap and verifying the sync.

```bash
# 1. 创建 ConfigMap
kubectl apply -f - <<EOF
apiVersion: v1
kind: ConfigMap
metadata:
  name: image-cri-shim
  namespace: kube-system
data:
  registries.yaml: |
    version: v1
    sealos:
      address: http://sealos.hub:5000
      auth:
        username: admin
        password: passw0rd
    registries:
      - address: docker.io
        auth:
          username: dockeruser
          password: dockerpass
EOF

# 2. 等待最多 15 秒，配置自动同步到所有节点
# 3. 验证配置生效
kubectl logs -n kube-system daemonset/image-cri-shim | grep "synced image-cri-shim config"
```

--------------------------------

### Install CRDs for Testing

Source: https://github.com/labring/sealos/blob/main/controllers/app/README.md

Install the Custom Resource Definitions (CRDs) into the cluster before running the controller for testing purposes.

```sh
make install
```

--------------------------------

### Basic Registry Configuration Example

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/USAGE.md

A simple YAML configuration for a single container registry.

```yaml
# Single registry basic configuration
shim: /var/run/image-cri-shim.sock
cri: /run/containerd/containerd.sock
address: https://registry.company.com
auth: admin:password123
force: false
debug: false
timeout: 15m
reloadInterval: 30s
registries: []
```

--------------------------------

### Install Drivers with Sealos

Source: https://github.com/labring/sealos/blob/main/proposal/design/zh/self-hosting.md

Install specific drivers, such as OpenEBS, by providing the driver name and version, along with a configuration file.

```bash
sealos run openebs:[version] -c config.yaml
```

--------------------------------

### Install systemDB with Sealos

Source: https://github.com/labring/sealos/blob/main/proposal/design/zh/systemDB.md

This command installs systemDB along with openebs using the Sealos CLI. Ensure openebs is a prerequisite for systemDB.

```bash
sealos run openebs:v1.9.0 systemDB:v1.0
```

--------------------------------

### Install Sealos and Create a Kubernetes Cluster

Source: https://github.com/labring/sealos/blob/main/lifecycle/README.md

Installs Sealos and then creates a Kubernetes cluster with specified master and node IPs. Requires SSH password.

```bash
curl -sfL https://raw.githubusercontent.com/labring/sealos/v4.3.0/scripts/install.sh \
    | sh -s v4.3.0 labring/sealos
# Create a cluster
sealos run labring/kubernetes:v1.25.0-4.2.0 labring/helm:v3.8.2 labring/calico:v3.24.1 \
     --masters 192.168.64.2,192.168.64.22,192.168.64.20 \
     --nodes 192.168.64.21,192.168.64.19 -p [your-ssh-passwd]
```

--------------------------------

### Download and Install Sealos Client (arm64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.4-rc2.md

Use this command to download the Sealos client binary for arm64 architecture, extract it, make it executable, and move it to your system's PATH. Ensure you have wget, tar, and chmod available.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.4-rc2/sealos_4.1.4-rc2_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.1.4-rc2_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Install Tailwind CSS and PostCSS Dependencies

Source: https://github.com/labring/sealos/blob/main/frontend/packages/shadcn-ui/README.md

Install Tailwind CSS, PostCSS, react-hook-form, and Sonner for use with Shadcn/ui. These are essential for styling and form handling.

```sh
# Tailwind CSS and PostCSS
pnpm install tailwindcss @tailwindcss/postcss postcss

# RHF (for `Form` component), Sonner (for `Sonner` component)
pnpm install react-hook-form sonner
```

--------------------------------

### Download and Install Sealos Client (amd64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.1.4-rc2.md

Use this command to download the Sealos client binary for amd64 architecture, extract it, make it executable, and move it to your system's PATH. Ensure you have wget, tar, and chmod available.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.1.4-rc2/sealos_4.1.4-rc2_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.1.4-rc2_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Image CRD Example

Source: https://github.com/labring/sealos/blob/main/proposal/design/en/imagehub.md

An example of the Image CRD, which stores details about a cluster image. This CRD is automatically applied by Sealos when an image is pushed to the registry.

```yaml
apiVersion: imagehub.sealos.io/v1
kind: Image
metadata:
  labels:
    organization.imagehub.sealos.io: labring
    repository.imagehub.sealos.io: cert-manager
    tag.imagehub.sealos.io: v1.8.0
  name: labring.cert.manager.v1.8.0
spec:
  detail:
    ID: Unknown
    arch: Unknown
    description: Cloud native certificate management. X.509 certificate management
      for Kubernetes and OpenShift
    docs: |
      # cert-manager

      cert-manager adds certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates.

      It supports issuing certificates from a variety of sources, including Let's Encrypt (ACME), HashiCorp Vault, and Venafi TPP / TLS Protect Cloud, as well as local in-cluster issuance.

      cert-manager also ensures certificates remain valid and up to date, attempting to renew certificates at an appropriate time before expiry to reduce the risk of outages and remove toil.

      ![cert-manager high level overview diagram](https://cert-manager.io/images/high-level-overview.svg)

      ## Documentation

      Documentation for cert-manager can be found at [cert-manager.io](https://cert-manager.io/docs/).

      For the common use-case of automatically issuing TLS certificates for
      Ingress resources, see the [cert-manager nginx-ingress quick start guide](https://cert-manager.io/docs/tutorials/acme/nginx-ingress/).

      For a more compressive guide to issuing your first certificate, see our [getting started guide](https://cert-manager.io/docs/getting-started/).
    icon: https://cert-manager.io/images/cert-manager-logo-icon.svg
    keywords:
      - Storage
  name: labring/cert-manager:v1.8.0
```

--------------------------------

### Implement HTTP Webhook Server with Gin

Source: https://github.com/labring/sealos/blob/main/controllers/user/controllers/helper/kubeconfig/webhook.md

Sets up an HTTP server using the Gin framework to handle webhook requests for authentication. It configures routes, middleware, and runs the server on a specified port. Ensure Gin and necessary middlewares are imported.

```go
func HttpServer(port uint16) error {
	r := gin.New()
	gin.SetMode(gin.ReleaseMode)
	r.Use(middlewares.GinLogger(), middlewares.GinRecovery(true))

	r.POST("/auth", Auth)
	gin.SetMode(gin.DebugMode)
	//prefix := "/Users/cuisongliu/Workspaces/go/src/github.com/cuisongliu/rbac-blacklist/pki"
	return r.Run(fmt.Sprintf("%s:%d", "0.0.0.0", port))
}
```

```go
func Auth(ctx *gin.Context) {
	fmt.Println("auth in ...")
	var review v1.SubjectAccessReview
	err := ctx.BindJSON(&review)
	//{"kind":"SubjectAccessReview","apiVersion":"authorization.k8s.io/v1beta1","metadata":{"creationTimestamp":null},"spec":{"resourceAttributes":{"namespace":"ns-cuisongliu","verb":"list","version":"v1","resource":"pods"},"user":"system:serviceaccount:default:cuisongliu","group":["system:serviceaccounts","system:serviceaccounts:default","system:authenticated"],"uid":"01575033-6a76-4426-88d0-3da94c6c3e03"},"status":{"allowed":false}}
	//d, err := ctx.GetRawData()
	fmt.Println("inff", "msg", string(review.Spec.User))
	if err != nil {
		fmt.Println(err, "has error")
	}

	//allow := true
	//if review.Spec.ResourceAttributes.Resource == "configmaps" && review.Spec.ResourceAttributes.Name == "my-config" {
	//	allow = false
	//}
	r := &v1.SubjectAccessReview{
		TypeMeta: v12.TypeMeta{
			Kind:       "SubjectAccessReview",
			APIVersion: "authorization.k8s.io/v1beta1",
		},
		Status: v1.SubjectAccessReviewStatus{Allowed:  review.Status.Allowed, Denied: false},
	}
	ctx.JSONP(200, r)
}
```

--------------------------------

### Datapack CR Example with OK Status

Source: https://github.com/labring/sealos/blob/main/proposal/design/en/datapack.md

An example of a Datapack CR with 'detail' type and 'OK' status, showing the packed data in the status.datas field.

```yaml
apiVersion: imagehub.sealos.io/v1
kind: DataPack
metadata:
  name: datapackuid
spec:
  expireTime: 120m
  names:
    - labring/cert-manager:v1.8.0
  type: detail
status:
  codes: 1
  datas:
    labring/cert-manager:v1.8.0:
      ID: Unknown
      arch: Unknown
      description: Cloud native certificate management. X.509 certificate management
        for Kubernetes and OpenShift
      docs: |
      icon: https://cert-manager.io/images/cert-manager-logo-icon.svg
      keywords:
        - Storage
      name: labring/cert-manager:v1.8.0
      tags:
        - creatTime: "2022-12-27T07:37:34Z"
          metaName: labring.cert.manager.v1.7.0
          name: v1.7.0
        - creatTime: "2022-12-27T07:33:08Z"
          metaName: labring.cert.manager.v1.8.0
          name: v1.8.0
```

--------------------------------

### Install Sealos Desktop with Sealos

Source: https://github.com/labring/sealos/blob/main/proposal/design/zh/self-hosting.md

Deploy Sealos Desktop, which includes essential components like databases, UI, and monitoring systems, using the `sealos run` command with a configuration file.

```bash
sealos run sealos-desktop:latest -c config.yaml
```

--------------------------------

### Registries Configuration Example

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/image-cri-shim/CONFIGMAP_GUIDE.md

Example of configuring a list of additional registries with their addresses and authentication details. Note that this list completely replaces the local configuration.

```yaml
registries:
  - address: docker.io
    auth:
      username: user1
      password: pass1

  - address: registry.example.com
    auth:
      username: user2
      password: pass2
```

--------------------------------

### Start Echoserver Docker Containers

Source: https://github.com/labring/sealos/blob/main/lifecycle/staging/src/github.com/labring/lvscare/README.md

These commands start three echoserver instances as real servers, each listening on a different port (8081, 8082, 8083).

```bash
docker run -p 8081:80 --name echoserver1 -d cilium/echoserver
```

```bash
docker run -p 8082:80 --name echoserver2 -d cilium/echoserver
```

```bash
docker run -p 8083:80 --name echoserver3 -d cilium/echoserver
```

--------------------------------

### Download and Install Sealos Client (amd64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.0-alpha1.md

Use this command to download the Sealos client binary for amd64 architecture, make it executable, and move it to your PATH. Ensure you have wget, tar, and chmod available.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.2.0-alpha1/sealos_4.2.0-alpha1_linux_amd64.tar.gz  &&     tar -zxvf sealos_4.2.0-alpha1_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos Client (arm64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.2.0-alpha1.md

Use this command to download the Sealos client binary for arm64 architecture, make it executable, and move it to your PATH. Ensure you have wget, tar, and chmod available.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.2.0-alpha1/sealos_4.2.0-alpha1_linux_arm64.tar.gz  &&     tar -zxvf sealos_4.2.0-alpha1_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### Download and Install Sealos Client (amd64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.0.0.md

Use this command to download the Sealos client binary for amd64 architecture, extract it, make it executable, and move it to your PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.0.0/sealos_4.0.0_linux_amd64.tar.gz  && \
    tar -zxvf sealos_4.0.0_linux_amd64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```

--------------------------------

### SystemDB Secret Configuration Example

Source: https://github.com/labring/sealos/blob/main/proposal/design/zh/systemDB.md

This is an example of a Kubernetes Secret that might be used for SDK or application authentication with systemDB. The actual username and password should be base64 encoded.

```yaml
apiVersion: v1
kind: Secret
metadata:
  name: sdk-demo
data:
  username: ...
  password: ...
```

--------------------------------

### Build and Push Docker Image

Source: https://github.com/labring/sealos/blob/main/controllers/license/README.md

Build the Docker image for your controller and push it to a container registry. Replace `<some-registry>/license:tag` with your registry details.

```sh
make docker-build docker-push IMG=<some-registry>/license:tag
```

--------------------------------

### Repository CRD Example

Source: https://github.com/labring/sealos/blob/main/proposal/design/en/imagehub.md

An example of the Repository CRD, which aggregates common information for an image and manages authority. This CRD is automatically generated after an Image CR is created.

```yaml
apiVersion: imagehub.sealos.io/v1
kind: Repository
metadata:
  labels:
    keyword.imagehub.sealos.io/Storage: ""
    organization.imagehub.sealos.io: labring
    repository.imagehub.sealos.io: cert-manager
  name: labring.cert-manager
spec:
  name: labring/cert-manager
status:
  latestTag:
    creatTime: "2022-12-27T07:33:08Z"
    metaName: labring.cert.manager.v1.8.0
    name: v1.8.0
  tags:
    - creatTime: "2022-12-27T07:37:34Z"
      metaName: labring.cert.manager.v1.7.0
      name: v1.7.0
    - creatTime: "2022-12-27T07:33:08Z"
      metaName: labring.cert.manager.v1.8.0
      name: v1.8.0
```

--------------------------------

### Install Kubernetes with Sealos

Source: https://github.com/labring/sealos/blob/main/proposal/design/zh/self-hosting.md

Use this command to install a specific version of Kubernetes using Sealos. Ensure you provide the necessary parameters for password, memory, and network configuration.

```bash
sealos run kubernetes:v1.23.0 -p xxx -m ... -n ...
```

--------------------------------

### Download and Install Sealos Client (arm64)

Source: https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG-4.0.0.md

Use this command to download the Sealos client binary for arm64 architecture, extract it, make it executable, and move it to your PATH. Ensure you have wget and tar installed.

```shell
wget  https://github.com/labring/sealos/releases/download/v4.0.0/sealos_4.0.0_linux_arm64.tar.gz  && \
    tar -zxvf sealos_4.0.0_linux_arm64.tar.gz sealos &&  chmod +x sealos && mv sealos /usr/bin
```