feat: add .gitignore and apps/template for new apps
This commit is contained in:
55
apps/template/README.md
Normal file
55
apps/template/README.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# 新增應用範本
|
||||
|
||||
## 使用步驟
|
||||
|
||||
1. **複製範本**
|
||||
```bash
|
||||
cp -r apps/template apps/your-app
|
||||
```
|
||||
|
||||
2. **替換佔位符**
|
||||
- `{{APP_NAME}}` → 應用名稱(如 `myapp`)
|
||||
- `{{IMAGE}}` → Docker 映像(如 `nginx`)
|
||||
- `{{TAG}}` → 版本標籤(如 `1.25`)
|
||||
- `{{PORT}}` → 容器端口(如 `80`)
|
||||
- `{{HOST}}` → 網域名稱(如 `app.example.com`)
|
||||
- `{{SIZE}}` → 儲存大小(如 `10Gi`)
|
||||
- `{{DATA_MOUNT_PATH}}` → 資料掛載路徑
|
||||
|
||||
3. **權限設定**
|
||||
```bash
|
||||
chmod +x apps/your-app/*.sh
|
||||
```
|
||||
|
||||
4. **部署**
|
||||
```bash
|
||||
cd apps/your-app
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
## 目錄結構
|
||||
|
||||
```
|
||||
apps/your-app/
|
||||
├── manifests/ # K8s YAML 檔案
|
||||
│ ├── app-deployment.yaml
|
||||
│ ├── app-pvc.yaml
|
||||
│ ├── app-ingress.yaml
|
||||
│ └── app-service.yaml
|
||||
├── deploy.sh # 部署腳本
|
||||
├── stop.sh # 停止腳本
|
||||
├── status.sh # 狀態檢查
|
||||
├── backup.sh # 備份腳本
|
||||
└── backup/ # 備份檔案目錄
|
||||
```
|
||||
|
||||
## 常見調整
|
||||
|
||||
### 有資料庫的應用
|
||||
在 `manifests/` 新增 `db-deployment.yaml`、`db-service.yaml`
|
||||
|
||||
### 需要密碼/金鑰
|
||||
在 `manifests/` 新增 `secret.yaml`(參考 `apps/codimd/manifests/01-codimd-secrets.yaml`)
|
||||
|
||||
### 需要特殊設定
|
||||
在 `manifests/` 新增 `configmap.yaml`
|
||||
Reference in New Issue
Block a user