|
| 1 | +# Important Notes |
| 2 | + |
| 3 | +When generating or modifying code for this project, strictly follow these guidelines. Make sure that: |
| 4 | +- Code follows Python best practices and is well-documented |
| 5 | +- Error handling is robust and user-friendly |
| 6 | +- The tool remains easy to use for Kubernetes administrators |
| 7 | + |
| 8 | +## Important Notes |
| 9 | + |
| 10 | +1. **코드 포맷팅** |
| 11 | + - Black을 사용한 일관된 코드 스타일 적용 |
| 12 | + - isort를 사용한 import 문 정렬 |
| 13 | + - CI 파이프라인에서 코드 스타일 검사 자동화 |
| 14 | + |
| 15 | +2. **CI 파이프라인** |
| 16 | + - GitHub Actions를 통한 자동 테스트 및 코드 품질 검사 |
| 17 | + - Black, isort, pytest 검사를 통과해야 빌드 성공 |
| 18 | + |
| 19 | +3. **테스트 자동화** |
| 20 | + - pytest를 사용한 단위 테스트 작성 |
| 21 | + - CI 파이프라인에서 테스트 자동 실행 |
| 22 | + - 테스트, black, isort가 모두 통과해야 빌드 성공 |
| 23 | + |
| 24 | +4. **문서화** |
| 25 | + - README.md 파일에 프로젝트 개요 및 사용법 작성 |
| 26 | + - 현재 파일 `.prompt.md` 파일에 기능 요구사항 및 구현 사항 갱신 |
| 27 | + - 코드 주석 및 docstring을 통한 함수 및 클래스 설명 추가 |
| 28 | + - 변경 사항이 생길 때마다 `.prompt.md` 파일의 History 섹션에 기록 |
| 29 | + |
| 30 | +5. **개발 환경** |
| 31 | + - Poetry를 사용한 의존성 관리 |
| 32 | + - 가상 환경에서 개발 및 테스트 수행 |
| 33 | + - 다양한 Kubernetes 환경에서 테스트 수행 |
| 34 | + |
| 35 | +6. **커밋 컨벤션** |
| 36 | + - Conventional Commits 스타일을 따름 (ex: feat: add new feature, fix: bug fix, docs: update documentation) |
| 37 | + - 커밋은 영어로 짧고 간결하게 작성할 것 |
| 38 | + |
| 39 | +7. **코드 품질** |
| 40 | + - 가독성, 유지보수성, 확장성을 고려한 코드 작성 |
| 41 | + - 공식 문서와 Best Practice를 따름 |
| 42 | + - black, isort, pytest를 항상 통과할 것 |
| 43 | + |
| 44 | +8. **개발 규칙** |
| 45 | + - 현재 프로젝트 구조의 일관성을 유지하고 Best Practice를 따름 |
| 46 | + - 기존 코드의 개선 사항은 (Amazon Q Recommend라는 표시 및 향후 개선 사항에 기록) |
| 47 | + - README.md 파일에 항상 최신 상태를 자세하게 반영 |
| 48 | + |
| 49 | +## Problem |
| 50 | + |
| 51 | +- 현재 프로젝트에서 테스트 자동화 및 CI/CD 파이프라인 개선이 필요함 |
| 52 | +- 코드 구조화 및 모듈화가 필요함 |
| 53 | +- 사용자 인터페이스 개선이 필요함 |
| 54 | +- 다양한 Kubernetes 환경에서의 호환성 테스트가 필요함 |
| 55 | + |
| 56 | +## Requirements |
| 57 | + |
| 58 | +### 1. **테스트 자동화 개선** |
| 59 | +- 단위 테스트 추가 |
| 60 | +- GitHub Actions를 통한 CI/CD 파이프라인 구축 |
| 61 | +- 코드 포맷팅 검사 자동화 |
| 62 | + |
| 63 | +### 2. **코드 구조화 및 모듈화** |
| 64 | +- 기능별 모듈 분리 |
| 65 | +- 클래스 기반 구조로 리팩토링 |
| 66 | +- 설정 파일 분리 |
| 67 | + |
| 68 | +### 3. **사용자 인터페이스 개선** |
| 69 | +- 메뉴 구조 개선 |
| 70 | +- 컬러 출력 지원 |
| 71 | +- 진행 상태 표시 개선 |
| 72 | + |
| 73 | +### 4. **호환성 개선** |
| 74 | +- 다양한 Kubernetes 버전 지원 |
| 75 | +- 다양한 환경(EKS, GKE, AKS 등)에서의 테스트 |
| 76 | +- 오프라인 환경에서의 사용성 개선 |
| 77 | + |
| 78 | +## 향후 개선 사항 |
| 79 | + |
| 80 | +1. **성능 최적화** |
| 81 | + - 대규모 클러스터에서의 성능 개선 |
| 82 | + - 데이터 캐싱 메커니즘 구현 |
| 83 | + - 비동기 데이터 로딩 적용 |
| 84 | + |
| 85 | +2. **알림 시스템** |
| 86 | + - 이메일, Slack 등을 통한 알림 기능 추가 |
| 87 | + - 사용자 정의 알림 규칙 설정 기능 |
| 88 | + |
| 89 | +3. **대시보드 기능 추가** |
| 90 | + - 웹 기반 대시보드 인터페이스 구현 |
| 91 | + - 실시간 데이터 시각화 |
| 92 | + - 사용자 정의 대시보드 레이아웃 |
| 93 | + |
| 94 | +4. **다국어 지원** |
| 95 | + - 영어, 한국어 등 다양한 언어 지원 |
| 96 | + - 지역화(localization) 프레임워크 적용 |
| 97 | + |
| 98 | +5. **클러스터 관리 기능 확장** |
| 99 | + - 리소스 생성 및 수정 기능 추가 |
| 100 | + - 배치 작업 관리 기능 |
| 101 | + - 네트워크 정책 시각화 및 관리 |
| 102 | + |
| 103 | +6. **보안 강화** |
| 104 | + - kubeconfig 암호화 저장 기능 |
| 105 | + - 접근 로그 및 감사 기능 추가 |
| 106 | + - RBAC 기반 접근 제어 |
| 107 | + |
| 108 | +## History |
| 109 | + |
| 110 | +- 2025-06-05: Dependabot 설정 추가 (package-ecosystem: pip) |
| 111 | +- 2025-06-05: .prompt.md 파일 추가 |
| 112 | +- 2025-06-01: README.md 파일 업데이트 |
| 113 | +- 2025-05-30: kubernetes_monitoring.py 스크립트 개선 |
| 114 | +- 2025-05-25: 노드 그룹 라벨 커스터마이징 기능 추가 |
| 115 | +- 2025-05-20: Poetry를 사용한 의존성 관리 추가 |
| 116 | +- 2025-05-15: 초기 프로젝트 구조 설정 |
0 commit comments