sbkube 0.1.1

k3s용 헬름+yaml+git 배포 자동화 CLI 도구

🧩 kube-app-manaer

kube-app-manaer는 yaml, Helm, git 리소스를 로커로에서 정의하고 k3s 등 Kubernetes 환경에 일관되게 배포할 수 있는 CLI 도구입니다.

개발자, DevOps 엔지니어, SaaS 환경 구축을 위한 u53c8가화된 Helm 배포 관리자

---

🔮 Anticipated Usage

kube-app-manaer는 ScriptonBasestar가 운영하는 웹호스팅 / 서버호스팅 기반 DevOps 인프라에서 실무적으로 활용되며, 다음과 같은 용도로 발전될 예정입니다:

• 내부 SaaS 플랫폼의 Helm 기반 배포 자동화
• 사용자 정의 YAML 템플릿과 Git 소스 통합 배포
• 오픈소스 DevOps 도구 및 라이브러리의 테스트 베드
• 향후 여러 배포 도구(sbkube, sbproxy, sbrelease 등)의 공통 기반

sbkube는 ScriptonBasestar의 전체 인프라 자동화 계획의 핵심 도구로, 점차 라이브러리 및 CLI 도구 형태로 오픈소스 커뮤니티에 공개될 예정입니다.

---

✨ 주요 기능

• 로커 YAML 설정 기반 앱 정의 및 분류
• Helm chart / OCI chart / Git chart / 파일 복사 기반 배포
• prepare → build → template → deploy 구조
• exec, yaml, helm 기반 설치 명령 지원
• --dry-run, --base-dir, --apps 기반 명령 범위 지원
• upgrade, delete 명령 분리

---

📦 설치

🔧 추천 방법 (로컬 개발자용)

uv pip install sbkube

또는 소스 설치:

git clone https://github.com/ScriptonBasestar/kube-app-manaer.git
cd kube-app-manaer
uv pip install -e .

🚀 향후 계획

• PyPI 공개 패키지 (pip install sbkube)
• Homebrew 탭 배포 (brew install scriptonbasestar/sbkube)

git clone https://github.com/ScriptonBasestar/kube-app-manaer.git
cd kube-app-manaer
uv pip install -e .

Python 3.12+ 환경 권장
uv 기반 패키지 관리 지원

---

⚙️ GitHub Actions 배포 자동화

sbkube는 PyPI로 자동 배포되도록 GitHub Actions CI 워크플로를 제공합니다.

.github/workflows/publish.yml 예시:

ame: Publish to PyPI

on:
  push:
    tags:
      - "v*"

permissions:
  id-token: write
  contents: read

jobs:
  publish:
    name: Build and publish to PyPI
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install uv
        uses: yezz123/setup-uv@v4

      - name: Build wheel
        run: uv build

      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
        with:
          password: ${{ secrets.PYPI_API_TOKEN }}

🔐 설정 방법

1. PyPI API 토큰 생성
2. GitHub 저장소 → Settings → Secrets → Actions → PYPI_API_TOKEN 추가
3. 태그 푸시 시 자동 배포:

git tag v0.1.0
git push origin v0.1.0

---

📂 디렉토리 구조

kube-app-manaer/
├── sbkube/                # CLI 구현
│   ├── cli.py             # main entry
│   ├── commands/          # prepare/build/deploy 등 명령어 정의
│   └── utils/             # 공통 유틸리티
├── samples/k3scode/       # 테스트 config/sources 예제
│   ├── config-memory.yaml
│   ├── sources.yaml
│   └── values/
├── build/                 # build 결과물 저장
├── charts/                # helm pull 다운로드 디렉토리
├── repos/                 # git clone 저장 디렉토리
├── tests/                 # pytest 테스트 코드
└── README.md

---

🚀 CLI 사용법

준비 (Helm repo 추가, Git clone, OCI pull 등)

sbkube prepare --apps config-memory --base-dir ./samples/k3scode

빌드 (chart 복사, override, remove 등)

sbkube build --apps config-memory --base-dir ./samples/k3scode

Helm 템플리트 출력

sbkube template --apps config-memory --base-dir ./samples/k3scode --output-dir ./rendered

실제 배포

sbkube deploy --apps config-memory --base-dir ./samples/k3scode

리리스 삭제

sbkube delete --apps config-memory --base-dir ./samples/k3scode

업그레이드

sbkube upgrade --apps config-memory --base-dir ./samples/k3scode

---

🥪 테스트

pytest tests/

또는 예제 config 보기:

python -m sbkube.cli deploy --apps config-memory --base-dir ./samples/k3scode

---

📄 설정 파일 예제

config-memory.yaml

namespace: default
apps:
  - name: redis
    type: install-helm
    specs:
      repo: bitnami
      chart: redis
      values:
        - redis-values.yaml
  - name: memcached
    type: install-helm
    specs:
      repo: bitnami
      chart: memcached

sources.yaml

helm_repos:
  bitnami: https://charts.bitnami.com/bitnami

---

🧙 개발 중 기능

• hook 실행: before, after
• Helm chart test
• Git repo를 통한 chart 경로 자동 지정 및 지원
• ArgoCD-like UI

---

📄 라이센스

MIT License © ScriptonBasestar

---

🤝 기억하기

PR, 이슈, 피드래프 허용합니다!