Grafana — 하나의 Aggregate, 두 개의 대상, 선택적 관리자 자격 증명
이 예제는 단일 Grafana 대시보드 및 시각화 서버를 Developer가 작성한 하나의 Aggregate에서 두 가지 구현으로 컴파일합니다.
- 로컬 개발용 Docker Compose, 그리고
- 공식 업스트림
grafana/grafana이미지를 Kubernetes에서 직접 실행하는 합성된 helm Recipe(외부 차트 없음).
합성된 helm Recipe는 Kubernetes 경로입니다. 서드파티 차트가 아닌 공식 이미지 태그에만 의존하며, 렌더링되는 리소스 집합은 워크로드가 선언한 것과 정확히 일치합니다.
동일한 aggregate.yaml이 두 경로를 모두 구동합니다. 구현마다 달라지는 것은
Manifest가 선택하는 Recipe 계층뿐입니다. 추가로 두 개의 Aggregates가 선택적 관리자 비밀번호 자격 증명이 연결된
동일한 서버를 보여 줍니다. Compose 경로용 aggregate-auth.yaml(환경
변수로 노출되는 inject-value 자격 증명)과 합성된 helm 경로용 aggregate-helm-synth-auth.yaml(Kubernetes Secret으로
구체화되는 참조 가능한 자격 증명)입니다.
패키징된 Grafana 서버의 라이선스는 AGPL-3.0입니다.
파일
| 파일 | 역할 |
|---|---|
aggregate.yaml | Developer 의도: core/observability/grafana 유형의 dashboards 컴포넌트 하나, 자격 증명 없음 — 관리자 계정은 Recipe의 결정적 개발용 비밀번호를 사용합니다. |
aggregate-auth.yaml | 컴포넌트의 선택적 admin_password 슬롯에 관리자 비밀번호 자격 증명이 연결된 동일한 서버(Compose 경로). |
aggregate-helm-synth-auth.yaml | 합성된 helm 경로용 참조 가능한 자격 증명이 연결된 동일한 서버 — 값은 Deployment가 참조하는 Kubernetes Secret으로 구체화됩니다. |
manifest-compose.yaml | Grafana 유형을 Compose Recipe(compose/grafana)에, 자격 증명을 dotenv-secret에 매핑합니다. |
manifest-helm-synth.yaml | Grafana 유형을 합성된 helm Recipe(helm/grafana)에, 자격 증명을 k8s-secret-from-parameter에 매핑합니다. |
release-compose.yaml / release-helm-synth.yaml | 두 구현에 대한 운영자 레코드, 연결된 자격 증명 없음. |
release-compose-auth.yaml / release-helm-synth-auth.yaml | 인증을 활성화하는 운영자 레코드. |
보여 주는 내용
- 하나의 작성 표면, 여러 대상. 하나의 Aggregate가 스택이 무엇인지에 대한 단일 진실 공급원입니다. 각 Manifest는 이를 어떻게 구현할지를 나타냅니다.
- 영구 볼륨을 기반으로 하는 서버. Grafana는 사용자,
저장된 대시보드, 환경설정 등의 상태를 디스크에 보관하므로, 컴포넌트는
infra.storage에서 크기가 정해지는 데이터 볼륨을 선언합니다. Kubernetes에서는 합성된 helm Recipe가/var/lib/grafana에 PersistentVolumeClaim이 마운트된 Deployment를 렌더링하고, Compose에서는 서비스가 같은 경로에 이름 있는 볼륨을 마운트합니다. - Workload 합성(Kubernetes). 합성된 helm Recipe는 공식
grafana/grafana이미지를 실행하는 Deployment와 ClusterIP Service로 이루어진 Workload를 선언하며, helm provider가 이를 외부 차트 없이 Kubernetes 매니페스트로 변환합니다. 렌더링되는 리소스 집합은 Workload가 선언한 것과 정확히 일치합니다. Compose Recipe와 합성된 helm Recipe가 모두grafana라는 이름을 가지므로, Manifests는 이를 provider 범위로compose/grafana와helm/grafana로 참조합니다. - 결정적 관리자 비밀번호. Grafana 관리자 계정은 항상
존재합니다. 이 컴포넌트는 선택적
admin_password자격 증명 슬롯을 통해 비밀번호를 연결합니다. 자격 증명이 연결되지 않은 경우(기본 Aggregate) Recipe가 결정적 개발용 비밀번호를 설정하므로 렌더링 결과가 실행마다 바이트 단위로 동일하며, 자격 증명이 연결된 경우 주입된 값이 관리자 비밀번호가 됩니다. Compose에서는GF_SECURITY_ADMIN_PASSWORD환경 변수로 노출되고, Kubernetes에서는 합성된 helm 경로가 이를 Deployment가 envsecretKeyRef로 참조하는 Secret으로 구체화하므로, 평문이 Deployment 매니페스트에 나타나지 않습니다.
여기서 다루지 않는 내용
Grafana는 단독으로 배포됩니다. 메트릭 또는 로그 소스(예: Prometheus 서버)를 프로비저닝된 데이터 소스로 Grafana에 연결하는 것은 모델링되어 있지 않습니다. 이 컴포넌트는 uses 소켓을 선언하지 않습니다.
예제 생성하기
아래 명령으로 이 예제를 빌드하거나, AI 어시스턴트에게 대신 빌드하게 할 수 있습니다.
예제 이름을 딴 새 폴더에 예제를 씁니다:
aggrega scaffold --example grafana-dashboards그런 다음 이어서 실행할 명령을 출력합니다. 첫 번째 명령은 새 폴더로 이동합니다:
cd grafana-dashboards빌드
이 워크스페이스에는 .aggrega-config.yaml이 없으므로 표준 라이브러리 엔터티는 허브 레지스트리 hub.aggrega.ai에서 해석되며 카탈로그 플래그가 필요하지 않습니다. --auto-pull은 새 클론에 없는 lockfile을 빌드 중에 기록합니다.
# Local development (Docker Compose), development admin passwordaggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), development admin passwordaggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabledaggrega build --release release-compose-auth.yaml --auto-pullaggrega build --release release-helm-synth-auth.yaml --auto-pull렌더링된 아티팩트는 dist/ 아래에 생성됩니다.
AI 어시스턴트 사용
Aggrega 도구로 설정한 AI 어시스턴트도 같은 작업을 할 수 있습니다. 다음 프롬프트를 붙여 넣으십시오.
Aggrega 도구만 사용하고, 폴더는 직접 만들지 마십시오. 작업 영역 폴더에 아직 `grafana-dashboards` 폴더가 없으면 `example`을 `grafana-dashboards`로 설정하고 `dir`은 지정하지 않은 채 `scaffold` 도구를 한 번 호출하십시오. 이 도구는 예제를 새 `grafana-dashboards` 폴더에 씁니다. 그런 다음 각 Release마다 `build` 도구를 `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml`, `release-helm-synth-auth.yaml` 순서로 한 번씩 호출하십시오. 매번 `workspace_root`를 `grafana-dashboards`로, `release`를 해당 파일로, `auto_pull`을 true로, `write`를 true로 설정합니다. 각 빌드가 쓴 파일을 알려 주십시오. 파일은 `grafana-dashboards/dist/` 아래에 있습니다.자격 증명 전달 참고
Compose 경로에서 자격 증명은 inject-value 시크릿입니다
(aggregate-auth.yaml). 그 값은 컴포넌트의 환경
파이프로 전달되어 GF_SECURITY_ADMIN_PASSWORD 서비스 환경 변수가 됩니다.
합성된 helm 경로는 참조 가능한 자격 증명을 사용합니다
(aggregate-helm-synth-auth.yaml). 값은 Kubernetes
Secret으로 구체화되며, Deployment는 GF_SECURITY_ADMIN_PASSWORD에 바인딩된 env secretKeyRef를 통해
이를 참조합니다. 따라서 평문 비밀번호는 Deployment 매니페스트에는 나타나지 않고
Secret에만 존재합니다.
인증이 적용된 Aggregates의 origin 값은 개발용 자리 표시자입니다.
실제 배포에서는 자격 증명 소스를 통해 실제 값을 제공하십시오.
실행하기(Compose)
aggrega build --release release-compose.yaml --auto-pulldocker compose -f dist/app/compose/docker-compose.yaml up -dGrafana 웹 UI인 http://localhost:3000을 열고 개발용 비밀번호로 admin으로
로그인합니다. 종료하려면
docker compose -f dist/app/compose/docker-compose.yaml down을 실행합니다.