KIWI 사용자 가이드
KIWI 가이드에 오신 것을 환영합니다! 이 가이드에서는 KIWI 플랫폼의 모든 기능을 쉽게 이해하고 활용할 수 있도록 안내합니다.
KIWI란?
KIWI는 K8s Integrated Workflow Intelligence의 약자로, 서버 관리부터 컨테이너 배포, 보안 분석까지 한 곳에서 처리할 수 있는 통합 DevSecOps 플랫폼입니다.
이런 분들에게 KIWI가 필요합니다
- 여러 서버와 Kubernetes 클러스터를 통합 관리하고 싶은 운영팀
- CI/CD 파이프라인과 보안 스캔을 별도 도구 없이 사용하고 싶은 개발팀
- 빌드, 배포, 보안 취약점을 한눈에 파악하고 싶은 DevOps 엔지니어
- 인프라 관리 경험이 적어도 직관적으로 서버를 운영하고 싶은 담당자
KIWI로 할 수 있는 일
- 서버 등록: SSH 연결 정보로 서버를 등록하고 원격 관리합니다.
- 런타임 연결: Kubernetes, Docker, Podman 환경을 연결합니다.
- 서비스 빌드: GitLab 저장소에서 컨테이너 이미지를 자동 빌드합니다.
- 서비스 배포: K8s 또는 Docker 환경으로 원클릭 배포합니다.
- 보안 스캔: SAST, SCA, DAST로 취약점을 자동 탐지합니다.
- 백업/복구: etcd, Docker 데이터를 안전하게 백업합니다.
빠른 시작
처음 사용하시나요?
KIWI를 처음 접하신다면 아래 순서대로 진행해 보세요. 각 단계는 약 5~10분이면 완료할 수 있습니다.
1단계: 서버 등록하기
먼저 서비스를 배포할 서버를 KIWI에 등록합니다.
- 장비 관리 페이지로 이동합니다.
- 추가하기 → 장비 추가를 클릭합니다.
- 서버의 IP 주소와 SSH 포트를 입력합니다.
- 연결을 테스트하고 저장합니다.
- 서버 IP 주소와 SSH 포트 (기본 22번)
- SSH 접속 계정 정보 (사용자명/비밀번호 또는 키)
2단계: 런타임 환경 연결하기
등록한 서버에 Kubernetes 클러스터나 Docker를 연결합니다.
- 런타임 환경 페이지로 이동합니다.
- 런타임 추가 버튼을 클릭합니다.
- 런타임 유형(Kubernetes/Docker/Podman)을 선택합니다.
- 연결 정보를 입력하고 저장합니다.
kubeconfig 파일이 필요합니다. 마스터 노드에서 ~/.kube/config 파일을 확인하세요.
3단계: 서비스 등록하고 배포하기
GitLab 저장소를 연동하여 서비스를 등록하고 빌드/배포합니다.
- 서비스 관리 페이지로 이동합니다.
- 서비스 추가 버튼을 클릭합니다.
- GitLab 저장소 URL과 토큰을 입력합니다.
- 빌드 설정을 구성하고 배포를 실행합니다.
GitLab → Settings → Access Tokens에서 Personal Access Token을 생성하세요. api, read_repository 권한이 필요합니다.
페이지별 가이드
각 페이지의 모든 기능을 상세히 안내합니다. 원하는 페이지를 클릭하여 자세한 사용법을 확인하세요.
메인 기능
- 대시보드: 전체 서비스 현황을 모니터링합니다. 상태 확인, DORA 메트릭, 빠른 작업 기능을 제공합니다.
- 장비 관리: 서버 및 인프라 장비를 관리합니다. SSH 연결, 다중 홉, VPN 연동을 지원합니다.
- 런타임 환경: K8s/Docker/Podman을 관리합니다. 클러스터 연결과 리소스 모니터링 기능을 제공합니다.
- 서비스 관리: Git 기반 서비스를 빌드/배포합니다. 빌드, 배포, 보안 스캔, 롤백 기능을 제공합니다.
운영 관리
- 백업 관리: 인프라 데이터를 백업/복구합니다. etcd 백업, Docker 백업, 복원 기능을 제공합니다.
- 데이터베이스: 외부 DB 연결을 관리합니다. 연결 정보, 동기화, 복원 기능을 제공합니다.
- 감사 로그: 시스템 활동 기록을 조회합니다. 필터링, 검색, 내보내기 기능을 제공합니다.
관리자 기능
- 사용자 관리: 기관 내 사용자를 관리합니다. 초대, 역할 지정, 비활성화 기능을 제공합니다.
- 권한 관리: 사용자별 권한을 설정합니다. 권한 부여/회수, 위험도 표시 기능을 제공합니다.
- 프로필: 개인 정보를 관리합니다. 정보 수정, 비밀번호 변경 기능을 제공합니다.
시나리오 가이드
특정 작업을 처음부터 끝까지 따라할 수 있는 단계별 가이드입니다.
시스템 설정
서비스 빌드/배포
- 서비스 등록 - GitLab 저장소 연동부터 빌드 설정까지
- 빌드/배포 - Kaniko 빌드와 K8s/Docker 배포
- Auto CI 설정 - 푸시 시 자동 빌드 트리거 설정
보안 분석
운영 관리
KIWI 핵심 기능
서비스 빌드/배포
KIWI는 GitLab 저장소에서 소스 코드를 가져와 컨테이너 이미지를 빌드하고 배포하는 전체 파이프라인을 제공합니다.
- Git 연동: GitLab Personal Access Token으로 저장소 연결. 브랜치나 태그별로 빌드할 수 있습니다.
- Kaniko 빌드: Dockerfile을 기반으로 안전하게 이미지를 빌드합니다. Dockerfile이 없으면 Build Wizard가 자동 생성을 도와줍니다.
- K8s/Docker 배포: 빌드된 이미지를 Kubernetes Pod이나 Docker 컨테이너로 배포합니다.
- 롤백: 문제 발생 시 이전 버전으로 빠르게 되돌릴 수 있습니다.
보안 분석 (DevSecOps)
개발 파이프라인 전반에 걸쳐 보안 검사를 수행하여 취약점을 조기에 발견합니다.
- SAST: 소스 코드 정적 분석으로 SQL 인젝션, XSS 등을 탐지합니다. 빌드 전에 CodeQL, Semgrep을 사용합니다.
- SCA: 오픈소스 라이브러리의 알려진 취약점(CVE)을 검사합니다. 빌드 후에 Trivy를 사용합니다.
- SBOM: 소프트웨어 구성 요소 목록을 생성합니다. 빌드 후에 Trivy를 사용합니다.
- DAST: 실행 중인 앱에 공격 시뮬레이션을 수행합니다. 배포 후에 ZAP을 사용합니다.
인프라 관리
다양한 컨테이너 런타임을 통합 관리합니다.
- Kubernetes: 클러스터 연결, 노드 상태, 네임스페이스, 리소스 모니터링. 메트릭 서버 설치도 지원합니다.
- Docker/Podman: 컨테이너 목록, 로그 확인, 이미지 관리. Podman은 루트리스 모드로 보안이 강화됩니다.
백업/복구
중요한 인프라 데이터를 백업하고 필요시 복구합니다.
- etcd 백업: Kubernetes 클러스터 상태를 스냅샷으로 백업. 클러스터 장애 복구에 필수입니다.
- Docker 백업: 컨테이너, 볼륨, 이미지를 백업합니다.
- 외부 스토리지: AWS S3, MinIO 등에 백업 파일을 안전하게 보관합니다.
권한 체계
KIWI는 역할 기반 접근 제어(RBAC)로 사용자 권한을 관리합니다.
역할 구분
각 사용자는 기관(Organization) 내에서 하나의 역할을 가집니다.
- Manager: 기관 관리자입니다. 사용자 초대, 권한 관리, 대부분의 기능에 접근할 수 있습니다.
- Member: 일반 사용자입니다. 부여받은 권한 범위 내에서만 기능을 사용할 수 있습니다.
권한 카테고리
권한은 대상 리소스에 따라 분류됩니다.
- infra: Kubernetes, Docker, Podman 런타임 관련
- device: 서버, VM 등 인프라 장비 관련
- service: 서비스 빌드, 배포, 보안 스캔 관련
- backup: 백업 생성, 복구, 삭제 관련
- database: 데이터베이스 연결, 동기화 관련
- audit: 감사 로그 조회, 내보내기 관련
권한 위험도
각 권한은 시스템에 미치는 영향에 따라 위험도가 표시됩니다.
- Critical: 시스템에 큰 영향을 미칩니다. 삭제, 복구, 터미널 접근 등이 해당됩니다.
- High: 데이터에 영향을 미칩니다. 설정 변경, 배포 등이 해당됩니다.
- Medium: 일반 관리 작업입니다. 생성, 수정 등이 해당됩니다.
- Low: 조회 위주의 작업입니다. 목록 보기, 상태 확인 등이 해당됩니다.
도움이 필요하신가요?
- FAQ - 자주 묻는 질문과 답변
- 페이지 가이드 - 좌측 사이드바에서 각 페이지별 상세 안내 확인
- 시나리오 가이드 - 특정 작업을 처음부터 끝까지 따라하기
문의사항은 기관 관리자에게 연락해 주세요.