コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

Grafana — 1 つの Aggregate、2 つのターゲット、オプションの管理者資格情報

この例では、Developer が作成した 1 つの Aggregate から、単一の Grafana ダッシュボード・可視化サーバーを 2 つの実現形態にコンパイルします:

  • ローカル開発向けの Docker Compose、そして
  • 公式アップストリームの grafana/grafana イメージを Kubernetes 上で直接実行する 合成 helm Recipe(外部チャートなし)。

合成 helm Recipe は Kubernetes 向けの経路です。サードパーティのチャートではなく 公式イメージタグのみに依存し、レンダリングされるリソースセットは ワークロードが宣言する内容とまったく同じです。

同じ aggregate.yaml が両方を駆動します。実現形態ごとに変わるのは、 Manifest が選択する Recipe レイヤーだけです。さらに 2 つの Aggregates が、オプションの管理者パスワード資格情報を付与した同じサーバーを示します。Compose 経路向けの aggregate-auth.yaml(環境変数として公開される inject-value 資格情報)と、 合成 helm 経路向けの aggregate-helm-synth-auth.yaml(Kubernetes Secret として具現化される 参照可能な資格情報)です。

パッケージ化された Grafana サーバーは AGPL-3.0 です。

ファイル

ファイル役割
aggregate.yamlDeveloper の意図:型 core/observability/grafana の dashboards コンポーネントが 1 つで、資格情報はありません。管理者アカウントは Recipe の決定論的な開発用パスワードを使用します。
aggregate-auth.yamlコンポーネントのオプションの admin_password スロットに管理者パスワード資格情報を付与した同じサーバー(Compose 経路)。
aggregate-helm-synth-auth.yaml合成 helm 経路向けに参照可能な資格情報を付与した同じサーバー。値は Deployment が参照する Kubernetes Secret として具現化されます。
manifest-compose.yamlGrafana 型を Compose Recipe(compose/grafana)に、資格情報を dotenv-secret にマッピングします。
manifest-helm-synth.yamlGrafana 型を合成 helm Recipe(helm/grafana)に、資格情報を k8s-secret-from-parameter にマッピングします。
release-compose.yaml / release-helm-synth.yaml2 つの実現形態に対する Operator レコード。資格情報の付与なし。
release-compose-auth.yaml / release-helm-synth-auth.yaml認証を有効にする Operator レコード。

示す内容

  • 1 つの作成インターフェース、多数のターゲット。 1 つの 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 プロバイダーがそれを外部チャートなしで Kubernetes マニフェストに変換します。レンダリングされるリソースセットは Workload が宣言する内容とまったく同じです。Compose Recipe と合成 helm Recipe の両方が grafana という名前を持つため、Manifests はそれらをプロバイダースコープ付きで compose/grafana と helm/grafana として参照します。
  • 決定論的な管理者パスワード。 Grafana の管理者アカウントは常に 存在します。このコンポーネントは、オプションの admin_password 資格情報スロットを通じてパスワードを接続します。資格情報が付与されていない場合(ベースの Aggregate)、Recipe は決定論的な開発用パスワードを設定するため、レンダリング結果は 実行間でバイト単位で同一になります。資格情報が付与されている場合は、注入された 値が管理者パスワードになります。Compose では GF_SECURITY_ADMIN_PASSWORD 環境変数として公開され、Kubernetes では 合成 helm 経路がそれを Secret として具現化し、Deployment は env の secretKeyRef を通じて参照します。そのため平文が Deployment マニフェストに現れることはありません。

ここでモデル化していないもの

Grafana は単独でデプロイされます。メトリクスやログのソース(たとえば Prometheus サーバー)をプロビジョニング済みデータソースとして Grafana に接続することはモデル化されていません。このコンポーネントは uses ソケットを宣言していません。

サンプルを生成する

このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。

例の名前を付けた新しいフォルダーに例を書き出します。

Terminal window
aggrega scaffold --example grafana-dashboards

その後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。

Terminal window
cd grafana-dashboards

ビルド

このワークスペースには .aggrega-config.yaml がないため、標準ライブラリのエンティティはハブレジストリ hub.aggrega.ai から解決され、カタログフラグは不要です。--auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き込みます。

Terminal window
# Local development (Docker Compose), development admin password
aggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), development admin password
aggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabled
aggrega build --release release-compose-auth.yaml --auto-pull
aggrega build --release release-helm-synth-auth.yaml --auto-pull

レンダリングされた成果物は dist/ 配下に出力されます。

AI アシスタントを使う

Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。

Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `grafana-dashboards` フォルダーがない場合は、`example` を `grafana-dashboards` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、例が新しい `grafana-dashboards` フォルダーに書き込まれます。次に、各 Release について `build` ツールを 1 回ずつ、`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)

Terminal window
aggrega build --release release-compose.yaml --auto-pull
docker compose -f dist/app/compose/docker-compose.yaml up -d

http://localhost:3000(Grafana の Web UI)を開き、開発用パスワードで admin として サインインします。終了するには docker compose -f dist/app/compose/docker-compose.yaml down を実行します。