https://github.com/nhn/k8s.oss-helm-packages
https://github.com/nhn/k8s.oss-helm-packages
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nhn/k8s.oss-helm-packages
- Owner: nhn
- Created: 2020-09-28T01:15:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-06T06:50:38.000Z (almost 4 years ago)
- Last Synced: 2025-06-19T12:43:56.451Z (4 months ago)
- Language: JavaScript
- Size: 2.08 MB
- Stars: 2
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TOAST k8s.oss-helm-packages
> 오픈소스를 이용한 토스트 쿠버네티스 활용 가이드
[](https://github.com/nhn)
## 🚩 Table of Contents
- [OSS HELM PACKAGES](#-oss-helm-packages)
- [StorageClass](#-storageclass)
- [Argocd](#-argocd)
- [Gitlab](#-gitlab)
- [Grafana](#%EF%B8%8F-grafana)
- [Loki](#-loki)
- [Prometheus](#%EF%B8%8F-prometheus)
- [Demo Features](#-demo-features)
- [Used By](#-used-by)
- [License](#-license)
#### 토스트 쿠버네티스에서는 다음과 같은 오픈소스 스택을 활용하여 MSA 기반의 어플리케이션, CI/CD DevOps 그리고 클러스터 모니터링 환경을 쉽게 구축 할 수 있습니다.
## 📦 OSS HELM Packages
### Toast K8S OpenSource Stack
| Name | Description |
| --- | --- |
| StorageClass | Toast Cinder Block Storage for PVC |
| Argocd | Automatic Continuous Deployment Tool for Gitops |
| Gitlab | Private Git Repository |
| Grafana | Dashboard tool for processing and monitoring |
| Loki | Processing log data pulling mechanism tool |
| Prometheus | http endpoint request pulling metrics mechanism tool |
## 🤖 StorageClass
Storage Class는 Toast에서 제공하는 Block Storage(PV)와 Kubernetes에서 마운트할 볼륨(PVC)을 쉽게 자동 매핑해주는 리소스입니다.
해당 Storage Class는 다음과 같이 분류 됩니다.
* **sc-delete** : sc-delete는 사용자가 pvc를 삭제할 시 자동으로 해당 Block Storage를 삭제합니다.
* **sc-retain** : sc-retain은 사용자가 pvc를 삭제해도 해당 Block Storage를 유지합니다.
Toast Kubernetes의 PersistentVolume 사용을 위한 Storage Class를 생성합니다.
``` sh
$ kubectl apply -f storageClass
```
## 🎨 Argocd
Kubernetes Devops를 구축하기 위해 Gitlab(Continuous Integration)와 Argocd(continuous Deployment)를 사용합니다.
Argocd는 컨테이너 네이티브 오픈소스 엔진으로 선언적 방식의 새로운 어플리케이션을 클러스터에 쉽게 구축 및 배포하는 Tool입니다.
Argocd의 특징은 다음과 같습니다.
* **Declaration** : Manifest, config, version, 환경변수등을 코드화 시켜 선언적 방식으로 애플리케이션 관리
* **Audit & Automation** : 클러스터의 어플리케이션 배포 및 라이프사이클의 audit & automation 구현
* **Gitops** : Gitops 방식의 git에 저장된 소스코드 정보를 가지고 클러스터에 어플리케이션 배포 구현
``` sh
$ kubectl create namespace argocd
$ helm install argocd ./argocd -n argocd
$ kubectl get svc argocd-server -n argocd -o=jsonpath='{$.status.loadBalancer.ingress[0].ip}';echo
```
## 💪 Gitlab
Gitlab은 깃 원격 저장소 기능, 이슈 트래커, 그리고 CI/CD 기능 등을 제공하는 버전 관리 소프트웨어입니다.
Gitlab의 특징은 다음과 같습니다.
* **Gitlab Runner** : Gitlab Runner를 통하여 Kubernetes에서 컨테이너 CI 구현
* **Api Integration** : 다양한 오픈소스와 API 연동
* **Private Repository** : Private Repository 구축
``` sh
$ kubectl create namespace gitlab
$ helm install gitlab ./gitlab -n gitlab
$ helm install argocd ./argocd -n argocd
$ kubectl get svc -n gitlab -o=jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}'; echo
$ kubectl set env deployment/gitlab-deployment -n gitlab GITLAB_OMNIBUS_CONFIG="external_url 'http://$(kubectl get svc -n gitlab -o=jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}')/'"
$ kubectl get svc -n gitlab -o=jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}'; echo
```
## ⭐️ Grafana
Grafana는 open source visualization and anlytics software로 dashboard를 통해 프로세싱 된 로그, 메트릭스 정보등의 지표들을 보여줍니다.
``` sh
$ kubectl create namespace monitoring
$ helm install grafana ./grafana -n monitoring
$ kubectl get svc --namespace monitoring grafana -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
```
## 🔥 Loki
Grafana Loki는 pulling 방식의 모니터링 오픈소스인 Prometheus에 영감을 받아 개발된 로그 시스템입니다.
Loki의 특징은 다음과 같습니다.
* **Chunk Indexing** : full text 인덱싱 방식이 아닌 metadata 정보 (labels)와 로그를 압축 저장 후 chunk파일을 생성하여 인덱싱 구현
* **Label Tracking** : label를 통해 application 컨테이너의 정보, 시간, 날짜, 로그타입을 선별하여 손쉬운 로그 조회 기능
* **Container Deployment** : Kubernetes Dynamic 환경 최적화
Loki log agent인 Promtail과 Loki 설치를 진행합니다.
``` sh
$ helm install promtail ./promtail -n monitoring
$ helm install loki ./loki -n monitoring
* Grafana 접속
$ kubectl get svc --namespace monitoring grafana -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
```
#### Loki를 통해 축적되는 로그는 Grafana를 통해 볼수 있습니다.
## ☄️ Prometheus
Prometheus 는 Kubernetes에서 가장 많이 사용하는 오픈 소스 기반 모니터링 시스템으로(pull-based over http monitoring), http endpoint를 통해 원하는 타켓의 Kubernetes 클러스터 및 Docker 컨테이너들를 손쉽게 모니터링 가능합니다.
Prometheus의 특징은 다음과 같습니다.
* **Api Communication** : Prometheus는 http endpoints를 통해 원하는 서버의 metrics 정보 수집
* **Time Seriese Sampling** : 한대의 Prometheus 서버는 수개의 million time series (시간 구간)에 준하는 초당 1 million의 샘플 처리
* **Query Language** : Metircs 검색에 유연한 쿼리 언어인 PromQL을 지원
Loki log agent인 Promtail과 Loki 설치를 진행합니다.
``` sh
$ helm install prometheus ./prometheus -n monitoring
```
#### Prometheus를 통해 축적되는 로그는 Grafana를 통해 볼수 있습니다.
## 🎨 Demo Features
* [**Java Demo Src**](https://github.com/nhn/k8s.demo-java-src) : Kubernets CI/CD 배포를 위한 예제 Java 애플리케이션
* [**Java Demo Helm Chart**](https://github.com/nhn/k8s.demo-helm-chart) : Kubernets CI/CD 배포를 위한 예제 Helm Chart
## 🐾 Reference
* [Kubernetes](https://kubernetes.io/)
* [Helm](https://helm.sh/)
* [Prometheus](https://prometheus.io/)
* [Argocd](https://argoproj.github.io/)
* [Gitlab CI/CD](https://docs.gitlab.com/ee/ci/)
* [Grafana](https://grafana.com/)
* [Loki](https://grafana.com/oss/loki/)
## ☀️ Kubernetes Support
| K8S 1.17 ~ | Helm 3.0 ~
## 💬 Contributing
* [Cloud Engineering Dpt](https://toast.com)
## 🚀 Used By
* [TOAST Cloud! - Toast Kubernetes, Toast Container Registry](https://toast.com)
* [Kubernetes Open Source Guide](https://toast.com)
## 📜 License
This software is licensed under the [Docker Certified](https://hub.docker.com) © [NHN](https://github.com/nhn).