From f4d24d06cb024005078b468cecfb7944ac4327c5 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Wed, 18 Jun 2025 10:05:29 +0000 Subject: [PATCH] AUTO: Sync Helm Charts docs to ScalarDB docs site repo --- ...configure-custom-values-scalar-manager.mdx | 170 ++++++++++-------- .../getting-started-scalar-manager.mdx | 148 +++++++-------- 2 files changed, 172 insertions(+), 146 deletions(-) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/configure-custom-values-scalar-manager.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/configure-custom-values-scalar-manager.mdx index 94eb109d..ea7864ea 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/configure-custom-values-scalar-manager.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/configure-custom-values-scalar-manager.mdx @@ -4,38 +4,38 @@ tags: displayed_sidebar: docsJapanese --- -# Scalar Manager のカスタム値ファイルを構成する +# Scalar Manager のカスタム値ファイルを設定する import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Manager チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細を知りたい場合は、Scalar Manager チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-manager/README.md) を参照してください。 +このドキュメントでは、Scalar Manager Helm Chart のカスタム値ファイルを設定する方法について説明します。使用可能なパラメータの詳細については、Scalar Manager チャートリポジトリの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-manager/README.md) を参照してください。 -## 必要な構成 +## 必要な設定 -### サービス構成 +このセクションでは、Scalar Manager の値ファイルに含める必要があるサービス、イメージ、および Scalar Manager の設定について説明します。 -Kubernetes のサービスリソースタイプを指定するには、`service.type` を設定する必要があります。プロバイダーが提供するロードバランサーを使用する場合は、`service.type` を `LoadBalancer` に設定する必要があります。 +### サービス設定 + +Kubernetes の Service リソースのタイプを定義するには、`web.service.type` を設定する必要があります。クラウドサービスプロバイダーがサービスを公開するために提供するロードバランサーを使用するには、`web.service.type` を `LoadBalancer` に設定します。 ```yaml -service: - type: LoadBalancer +web: + service: + type: LoadBalancer + # other web configurations ``` -#### Scalar Manager の公開に関するセキュリティ上の懸念 - -`service.type` を `LoadBalancer` に設定すると、Scalar Manager がクラスター外に公開されるため、セキュリティ上の懸念が生じる可能性があります。 +#### Scalar Manager を公開する際のセキュリティ上の考慮事項 -現在、Scalar Manager には認証やアクセス制御のメカニズムがありません。 -このため、適切なセキュリティ対策なしに Scalar Manager を直接パブリックネットワークに公開すると、不正なアクションにつながる可能性があります。 -これは、Scalar Manager が Scalar 製品の一時停止ジョブのスケジューリングなどの機能を提供しているためです。 +`web.service.type` を `LoadBalancer` に設定すると、デフォルトでは Scalar Manager が `HTTP` 経由で外部に公開されます。信頼できないネットワーク上に公開する場合は、暗号化されていないトラフィックによるセキュリティリスクが発生します。外部アクセスが不要な場合は、プライベートネットワークを使用するか、Kubernetes クラスターへのネットワークアクセスを適切に設定することをお勧めします。 -外部アクセスが必要な場合は、プライベートネットワークを使用するか、Kubernetes クラスターへのネットワークアクセスを適切に設定することをお勧めします。 +Scalar Manager は、認証および認可メカニズムをサポートしています。これらのメカニズムを設定することで、Scalar 製品を一時停止するジョブのスケジュール設定などの機能に対して認可されたアクションを確実に実行できます。詳細については、[Scalar Manager の認証設定](#scalar-manager-の認証設定) を参照してください。 -### 画像構成 +### コンテナイメージ設定 -Scalar Manager のイメージをプルできるように、`api.image.repository` と `web.image.repository` を設定する必要があります。 +`api.image.repository` と `web.image.repository` を設定する必要があります。これらの設定は Scalar Manager コンテナイメージを指定し、コンテナリポジトリからそれらをプルできるようにします。 ```yaml api: @@ -47,87 +47,107 @@ web: ``` ## オプション設定 -このセクションでは、Scalar Manager用のカスタム値ファイルを設定する際のオプション設定について説明します。 -### Scalar Manager 設定 (環境に応じてオプション) -`api.applicationProperties` カスタム値を上書きして、Scalar Managerのデフォルト設定を変更できます。 +このセクションでは、Scalar Manager の値ファイルをカスタマイズするためのオプションの設定について説明します。 + +### Scalar Manager 設定 (環境に応じてオプション) + +`api.applicationProperties` の設定を上書きして、デフォルトの Scalar Manager 設定を変更できます。 ```yaml api: applicationProperties: | - grafana.kubernetesServiceLabelName="app.kubernetes.io/name" - grafana.kubernetesServiceLabelValue="grafana" - grafana.kubernetesServicePortName="http-web" + prometheus.kubernetes-service-label-name="app" + prometheus.kubernetes-service-label-value="kube-prometheus-stack-prometheus" + prometheus.kubernetes-service-port-name="http-web" + # other application properties ``` -Scalar Managerには、例えばScalar製品のデプロイメントやクラスター内のPrometheusおよびLokiサービスを検出するためのデフォルト設定があります。 -ほとんどのユースケースでは、特にkube-prometheus-stackのデプロイガイドやloki-stackのデプロイガイドに従っている場合、デフォルト設定を変更する必要はありません。 - -#### api.applicationProperties で設定できるプロパティ - -Scalar Manager の設定は、Java アプリケーションプロパティの形式で、key=valueのペアです。 -これらのアプリケーションプロパティは、Scalar Manager Helm Chart の api.applicationProperties カスタム値を使用して設定できます。 - -|名前|説明|デフォルト値| -|---|---|---| -|`grafana.kubernetesServiceLabelName`|Kubernetes で Grafana サービスを検出するために使用されるラベル名|`app.kubernetes.io/name`| -|`grafana.kubernetesServiceLabelValue`|`grafana.kubernetesServiceLabelName` に対応するラベル値|`grafana`| -|`grafana.kubernetesServicePortName`|Kubernetes で Grafana サービスポートを検出するために使用されるポート名|`http-web`| -|`prometheus.kubernetesServiceLabelName`|Kubernetes で Prometheus サービスを検出するために使用されるラベル名|`app`| -|`prometheus.kubernetesServiceLabelValue`|`prometheus.kubernetesServiceLabelName` に対応するラベル値|`kube-prometheus-stack-prometheus`| -|`prometheus.kubernetesServicePortName`|Kubernetes で Prometheus サービスポートを検出するために使用されるポート名|`http-web`| -|`loki.kubernetesServiceLabelName`|Kubernetes で Prometheus サービスを検出するために使用されるラベル名|`app`| -|`loki.kubernetesServiceLabelValue`|`loki.kubernetesServiceLabelName` に対応するラベル値|`loki`| -|`loki.kubernetesServicePortName`|Kubernetes で Loki サービスポートを検出するために使用されるポート名|`http-metrics`| -|`helm.scalarRepositoryName`|Scalar Helm リポジトリを表すために使用される名前|`scalar-labs`| -|`helm.scalarRepositoryUrl`|Scalar Helm リポジトリの URL|`https://scalar-labs.github.io/helm-charts`| -|`helm.scalarAdminForKubernetesChartName`|Scalar Helm リポジトリにおける Kubernetes 用 Scalar Admin の Helm Chart 名|`scalar-admin-for-kubernetes`| -|`helm.scalarAdminForKubernetesChartVersion`|Kubernetes 用 Scalar Admin Helm Chart のバージョン|`1.0.0`| -|`configMapNamespace`|Scalar Manager が使用する ConfigMap がデプロイされる名前空間|`default`| -|`configMapName`|Scalar Manager が使用する ConfigMap の名前|`scalar-manager-metadata`| -|`paused-state-retention.storage`|一時停止状態を保持するために使用されるストレージタイプ|`configmap`| -|`paused-state-retention.max-number`|Scalar Manager が保持する一時停止状態の最大数|`100`| +Scalar Manager には、クラスター内の Scalar 製品のデプロイメントと Prometheus サービスを検出するためのデフォルト設定が含まれています。ほとんどのシナリオでは、特にガイドに従って `kube-prometheus-stack` と `loki-stack` をデプロイする場合は、これらのデフォルト設定で十分であり、変更する必要はありません。 + +#### `api.applicationProperties` で設定可能なプロパティ + +Scalar Manager の設定は、Java アプリケーションプロパティの形式で、key=valueのペアです。これらのアプリケーションプロパティは、Scalar Manager Helm Chart の api.applicationProperties カスタム値を使用して設定できます。 + +| 名前 | 説明 | デフォルト値 | +|:--------------------------------------------------------------------|:------------------------------------------------------------------|:---------------------------------------------------------------------------| +| `prometheus.kubernetes-service-label-name` | Kubernetes で Prometheus サービスを検出するために使用されるラベル名 | `app` | +| `prometheus.kubernetes-service-label-value` | `prometheus.kubernetes-service-label-name` に対応するラベル値 | `kube-prometheus-stack-prometheus` | +| `prometheus.kubernetes-service-port-name` | Kubernetes で Prometheus サービスポートを検出するために使用されるポート名 | `http-web` | +| `springdoc.swagger-ui.enabled` | Swagger UI を有効にするかどうか | `false` | +| `springdoc.swagger-ui.path` | Swagger UI のパス | `/swagger-ui.html` | +| `app.cors.allowed-origins` | CORS の許可されたオリジン | `*` | +| `app.cors.allowed-methods` | CORS で許可されるメソッド | `*` | +| `app.cors.allowed-headers` | CORS で許可されるヘッダー | `*` | +| `authentication.providers.static-jwt.secret` | JWT トークンの署名に使用される秘密鍵。最小 32 文字 | `example-jwt-secret-with-minimum-32-characters` | +| `authentication.providers.static-jwt.issuer-uri` | JWT トークンの発行者 URI | `https://scalar-manager.example.com` | +| `authentication.providers.static-jwt.access-token-expiration-time` | アクセストークンの有効期限 | `1h` | +| `authentication.providers.static-jwt.refresh-token-expiration-time` | リフレッシュトークンの有効期限 | `3d` | +| `app.initial-admin-user.enabled` | 初期管理者ユーザーを有効にするかどうか | `true` | +| `app.initial-admin-user.email` | 初期管理者ユーザーのメールアドレス | `admin@example.com` | +| `app.initial-admin-user.name` | 初期管理者ユーザーの名前 | `Administrator` | +| `app.initial-admin-user.password` | 初期管理者ユーザーのパスワード | `Password@123!` | +| `spring.jpa.hibernate.ddl-auto` | Hibernate の DDL モード | `update` | +| `spring.jpa.show-sql` | SQL クエリを表示するかどうか | `false` | +| `spring.jpa.properties.hibernate.format_sql` | SQL クエリをフォーマットするかどうか | `false` | +| `spring.datasource.url` | データベースの URL | `jdbc:postgresql://scalar-manager-postgres-postgresql:5432/scalar-manager` | +| `spring.datasource.username` | データベースのユーザー名 | `scalar-manager` | +| `spring.datasource.password` | データベースのパスワード | `scalar-manager` | +| `spring.datasource.driver-class-name` | データベースのドライバークラス名 | `org.postgresql.Driver` | -#### サービスディスカバリー - -Scalar Manager はラベルセレクターを使用して、Kubernetes 内の Grafana、Prometheus、Loki サービスを検出し、ポート名を使用してそれらに接続します。`*.kubernetesServiceLabelName`、`*.kubernetesServiceLabelValue`、`*.kubernetesServicePortName` の設定を変更することで、ラベルセレクターとポート名を修正できます。 - -一般的に、これらの設定を変更する必要はありません。ただし、Grafana、Prometheus、または Loki サービスの Helm Chart をインストールする際にラベルやポート名をカスタマイズした場合は、これらの設定をカスタマイズに合わせて調整する必要があります。 +:::note -##### Kubernetes 用 Scalar Admin の使用 +`api.applicationProperties` では、JPA、Hibernate、Spring Data に関して設定できる項目が他にもあります。これらの設定に精通している場合は、データベース接続と Scalar Manager の動作をカスタマイズするように設定できます。 -Scalar Manager は、[Kubernetes 用 Scalar Admin](https://github.com/scalar-labs/scalar-admin-for-kubernetes) Helm Chart をインストールして、Scalar製品の一時停止ジョブのスケジューリングや実行を行います。以下の設定を使用して、Scalar Helm リポジトリをセットアップし、Helm Chart を配置します: +::: -- `helm.scalarRepositoryName` -- `helm.scalarRepositoryUrl` -- `helm.scalarAdminForKubernetesChartName` -- `helm.scalarAdminForKubernetesChartVersion` +#### Scalar Manager の認証設定 -:::note +デフォルトでは、Scalar Manager にアクセスするには、ユーザー名とパスワードを使用して認証する必要があります。 -特別な理由がない限り、これらの設定を変更することはお勧めしません。 +認証を設定するための前提条件は次のとおりです。 -::: +- 独自の PostgreSQL データベース、またはクラウドサービスプロバイダーがホストする PostgreSQL データベースが必要です。たとえば、[PostgreSQL 用の Bitnami パッケージ](https://artifacthub.io/packages/helm/bitnami/postgresql) を使用して、Kubernetes クラスターに PostgreSQL データベースをデプロイできます。 +- `authentication.providers.static-jwt.secret` 設定を設定する必要があります。この設定は JWT トークンの署名に使用され、シークレットの文字数は最小 32 文字です。 -##### Scalar Manager が使用する ConfigMap +以下は、上記の前提条件を適用するために `api.applicationProperties` で設定する必要がある追加の設定の例です。環境に合わせて設定を必ず変更してください。 -Scalar Manager は、デフォルトのアプリケーションプロパティなどのメタデータを保存するために ConfigMap を使用します。ConfigMap は以下の設定で指定された名前空間にデプロイされます: +```properties +# JWT configuration +# Secret key used for signing JWT tokens, minimum 32 characters +authentication.providers.static-jwt.secret=${AUTHENTICATION_PROVIDERS_STATIC_JWT_SECRET:example-jwt-secret-with-minimum-32-characters} +authentication.providers.static-jwt.issuer-uri=${AUTHENTICATION_PROVIDERS_STATIC_JWT_ISSUER_URI:https://scalar-manager.example.com} +authentication.providers.static-jwt.access-token-expiration-time=${AUTHENTICATION_PROVIDERS_STATIC_JWT_ACCESS_TOKEN_EXPIRATION_TIME:1h} +authentication.providers.static-jwt.refresh-token-expiration-time=${AUTHENTICATION_PROVIDERS_STATIC_JWT_REFRESH_TOKEN_EXPIRATION_TIME:3d} -- `configMapNamespace` -- `configMapName` +# Initial admin configuration +app.initial-admin-user.enabled=${APP_INITIAL_ADMIN_USER_ENABLED:true} +app.initial-admin-user.email=${APP_INITIAL_ADMIN_USER_EMAIL:admin@example.com} +app.initial-admin-user.name=${APP_INITIAL_ADMIN_USER_NAME:Administrator} +app.initial-admin-user.password=${APP_INITIAL_ADMIN_USER_PASSWORD:Password@123!} -:::note +# JPA configuration +spring.jpa.hibernate.ddl-auto=${SPRING_JPA_HIBERNATE_DDL_AUTO:update} +spring.jpa.show-sql=${SPRING_JPA_SHOW_SQL:false} +spring.jpa.properties.hibernate.format_sql=${SPRING_JPA_PROPERTIES_HIBERNATE_FORMAT_SQL:false} -競合する ConfigMap を使用している場合など、特別な理由がない限り、これらの設定を変更することはお勧めしません。 +# Database configuration +spring.datasource.url=jdbc:postgresql://${DATABASE_HOST:scalar-manager-postgres-postgresql}:${DATABASE_PORT:5432}/${DATABASE_NAME:scalar-manager} +spring.datasource.username=${DATABASE_USERNAME:scalar-manager} +spring.datasource.password=${DATABASE_PASSWORD:scalar-manager} +spring.datasource.driver-class-name=org.postgresql.Driver +``` -::: +#### サービスディスカバリー -##### 一時停止状態の保持 +Scalar Manager はラベルを使用して Kubernetes 内の Prometheus サービスを検出し、ポート名を使用してサービスに接続します。`prometheus.kubernetes-service-label-name`、`prometheus.kubernetes-service-label-value`、および `prometheus.kubernetes-service-port-name` を設定することで、ラベルとポート名を変更できます。 -Scalar Manager は、Scalar 製品の一時停止状態をストレージに保持します。現在、Scalar Manager はストレージとして ConfigMap のみを使用できるため、`paused-state-retention.storage` 設定は `configmap` に設定する必要があります。`paused-state-retention.max-number` 設定を設定することで、Scalar Manager が保持する一時停止状態の最大数を調整できます。 +一般的に、これらの設定を変更する必要はありません。ただし、Prometheus サービスの Helm Chart をインストールする際にラベルまたはポート名をカスタマイズした場合は、カスタマイズに合わせてこれらの設定を調整する必要があります。 -:::warning +#### `web.env` で設定可能な環境変数 -ストレージに ConfigMap を使用する場合、ConfigMap のサイズ制限があるため、`paused-state-retention.max-number` に大きな値を設定することはお勧めしません。ConfigMap に保存されるデータは 1MiB を超えることができないため、Scalar Manager が保持できる一時停止状態の最大数は約3,000です。 +| Name | Description |Default Value | +|:---------------------|:---------------------------------------------|:---------------------------------------------------------------------| +| `GRAFANA_SERVER_URL` | Kubernetes クラスター内の Grafana サービスの URL | `http://scalar-monitoring-grafana.monitoring.svc.cluster.local:3000` | -::: +現在、`GRAFANA_SERVER_URL` 変数を `web.env` で設定して、Scalar Manager Web UI から Grafana UI へのプロキシをカスタマイズできます。デフォルトでは、変数は `monitoring` 名前空間にインストールされた Grafana サービス `scalar-monitoring-grafana` に設定されています。Grafana を別の名前空間にインストールした場合、または Grafana サービスの名前を変更した場合は、それに応じて `GRAFANA_SERVER_URL` 変数を更新する必要があります。 diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/getting-started-scalar-manager.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/getting-started-scalar-manager.mdx index beba9546..8c1991ae 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/getting-started-scalar-manager.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.13/helm-charts/getting-started-scalar-manager.mdx @@ -8,10 +8,13 @@ displayed_sidebar: docsJapanese import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -[Scalar Manager](../scalar-manager/overview.mdx) は、Kubernetes クラスター環境内の ScalarDB および ScalarDL の集中管理および監視ソリューションであり、次のことが可能になります。 + -- ScalarDB または ScalarDL の可用性を確認します。 +[Scalar Manager](../scalar-manager/overview.mdx) は、Kubernetes クラスター環境内の ScalarDB および ScalarDL を集中管理および監視するソリューションです。これにより、次のことが可能になります。 + +- ScalarDB または ScalarDL が利用可能な状態かを監視します。 - ScalarDB または ScalarDL が使用するデータベースでトランザクションの一貫性のある期間を作成する一時停止ジョブをスケジュールまたは実行します。 - Grafana ダッシュボードを介して ScalarDB または ScalarDL の時系列メトリックとログを確認します。 @@ -30,44 +33,50 @@ Scalar Manager をデプロイする前に、次の操作を行う必要があ 以下は、Kubernetes クラスターにデプロイされたコンポーネントのアーキテクチャ図です。 ``` -+--------------------------------------------------------------------------------------------------+ -| +----------------------+ | -| | scalar-manager | | -| | | | -| | +------------------+ | --------------------------(Manage)--------------------------+ | -| | | Scalar Manager | | | | -| | +------------------+ | | | -| +--+-------------------+ | | -| | | | -| +------------------------------------+ | | -| | loki-stack | V | -| | | +-----------------+ | -| | +--------------+ +--------------+ | <----------------(Log)--------------- | Scalar Products | | -| | | Loki | | Promtail | | | | | -| | +--------------+ +--------------+ | | +-----------+ | | -| +------------------------------------+ | | ScalarDB | | | -| | | +-----------+ | | -| +------------------------------------------------------+ | | | -| | kube-prometheus-stack | | +-----------+ | | -| | | | | ScalarDL | | | -| | +--------------+ +--------------+ +--------------+ | -----(Monitor)----> | +-----------+ | | -| | | Prometheus | | Alertmanager | | Grafana | | +-----------------+ | -| | +-------+------+ +------+-------+ +------+-------+ | | -| | | | | | | -| | +----------------+-----------------+ | | -| | | | | -| +--------------------------+---------------------------+ | -| | | | -| | | Kubernetes | -+----+-----------------------+---------------------------------------------------------------------+ - | | ++----------------------------------------------------------------------------------------------------------------------+ +| +----------------------------+ | +| | scalar-manager | | +| | | | +| | +------------------+ | ---------------------------------(Manage)--------------------------+ | +| +---+--->| Scalar Manager | | | | +| | | +---+--------------+ | | | +| | | | | | | +| | +--------+-------------------+ | | +| | | | | +| | +----+------------------------------------------+ | | +| | | | | | +| | +--------+------------------------------------------+---------+ | | +| | | | kube-prometheus-stack | | V | +| | | V V | +-----------------+ | +| | | +--------------+ +--------------+ +--------------+ | -----(Monitor)----> | Scalar Products | | +| | | | Prometheus | <---+ | Alertmanager | | Grafana | | | | | +| | | +------+-------+ | +--------------+ +------+-------+ | | +-----------+ | | +| | | | | | | | ScalarDB | | | +| | | +----------------------------+ | | +-----------+ | | +| | | | | | | | +| | +---------------------------------------------------+---------+ | +-----------+ | | +| | | | | ScalarDL | | | +| | +------------------------------------------+ +---------- | +-----------+ | | +| | | | +-----------------+ | +| | +--------+---------------------------+ | | +| | | | loki-stack | | | +| | | V | | | +| | | +--------------+ +--------------+ | <----------------(Log)-----------+ | +| | | | Loki | | Promtail | | | +| | | +--------------+ +--------------+ | | +| | +------------------------------------+ | +| | | +| | Kubernetes | ++----+-----------------------------------------------------------------------------------------------------------------+ + | Expose the environment to localhost (127.0.0.1) or use a load balancer to access it - | | + | (Access the dashboard through HTTP) - | | -+----+----+ +----+----+ -| Browser | <-(Embed)-- + Browser | -+---------+ +---------+ + | ++----+----+ +| Browser | ++---------+ + ``` ## ステップ1. minikube を起動します @@ -78,9 +87,11 @@ Scalar Manager をデプロイする前に、次の操作を行う必要があ minikube start ``` -## ステップ2. Grafana を埋め込めるように `kube-prometheus-stack` をアップグレードする +## ステップ 2. `kube-prometheus-stack` をアップグレードして、認証プロキシを使用した Grafana 認証を有効にします + +Scalar Manager にログインした後でユーザーが Grafana にアクセスできるようにするには、認証プロキシを使用した Grafana 認証を有効にする必要があります。 -`kube-prometheus-stack` のカスタム値ファイル (たとえば `scalar-prometheus-custom-values.yaml`) に、次の構成を追加するか、すでに存在する場合は修正します。 +`kube-prometheus-stack` のカスタム値ファイル (たとえば、`scalar-prometheus-custom-values.yaml`) で、次の設定を追加または修正します。 ```yaml kubeStateMetrics: @@ -95,13 +106,16 @@ kubelet: grafana: grafana.ini: users: - default_theme: light - security: - allow_embedding: true - auth.anonymous: + allow_sign_up: false + auto_assign_org: true + auto_assign_org_role: Editor + auth.proxy: enabled: true - org_name: "Main Org." - org_role: Editor + header_name: X-WEBAUTH-USER + header_property: username + auto_sign_up: true + server: + root_url: "%(protocol)s://%(domain)s:%(http_port)s/grafana" ``` 次に、次のコマンドを実行して Helm インストールをアップグレードします。 @@ -112,7 +126,7 @@ helm upgrade scalar-monitoring prometheus-community/kube-prometheus-stack -n mon ## ステップ3. 環境変数を設定する -次のコマンドを実行し、山括弧内の内容を説明に従って置き換えて、Scalar Manager の環境変数を設定します。 +Scalar Manager の次の環境変数を設定し、山括弧内の内容を説明に従って置き換えます。 ```console SCALAR_MANAGER_RELEASE_NAME= @@ -121,16 +135,16 @@ SCALAR_MANAGER_CUSTOM_VALUES_FILE= SCALAR_MANAGER_CHART_VERSION= ``` -## ステップ4. Scalar Manager のカスタム値ファイルを準備する +## ステップ4. カスタム値ファイルを準備する -次の手順に従って、Scalar Manager のカスタム値ファイルを準備します。 +Scalar Manager のカスタム値ファイルを準備します。 1. `scalar-manager-custom-values.yaml` という名前の空のファイルを作成します。 -1. [Scalar Manager のカスタム値ファイルを構成する](configure-custom-values-scalar-manager.mdx)の手順に従います。 +2. [Scalar Manager のカスタム値ファイルを設定する](configure-custom-values-scalar-manager.mdx)の手順に従います。 -## ステップ5. `scalar-manager` をインストールしてデプロイする +## ステップ5. デプロイする -次のコマンドを実行して、`scalar-manager` Helm Chart をインストールしてデプロイします。 +次のコマンドを実行して、`scalar-manager` Helm Chart をデプロイします。 ```console helm install ${SCALAR_MANAGER_RELEASE_NAME} scalar-labs/scalar-manager -n ${SCALAR_MANAGER_NAMESPACE} -f ${SCALAR_MANAGER_CUSTOM_VALUES_FILE} --version ${SCALAR_MANAGER_CHART_VERSION} @@ -138,36 +152,30 @@ helm install ${SCALAR_MANAGER_RELEASE_NAME} scalar-labs/scalar-manager -n ${SCAL ## ステップ6. Scalar Manager にアクセスする -Scalar Manager にアクセスする方法は、Kubernetes クラスターに使用しているツールによって異なります。 +Scalar Manager にアクセスする方法は、Kubernetes クラスターによって異なります。 - Scalar Manager のサービスリソースをローカルホスト (127.0.0.1) として公開するには、別のターミナルを開き、`minikube tunnel` コマンドを実行します。 + Scalar Manager をローカルホスト (127.0.0.1) で公開するには、別のターミナルを開いて `minikube tunnel` コマンドを実行します。 ```console minikube tunnel ``` - Then, access Scalar Manager by going to http://localhost:8000. + 次に、http://localhost:8000 で Scalar Manager にアクセスします。 - minikube 以外の Kubernetes クラスターを使用している場合は、各 Kubernetes クラスターの方式に従って `LoadBalancer` サービスにアクセスする必要があります。たとえば、クラウドサービスプロバイダーが提供するロードバランサーを使用するか、`kubectl port-forward` コマンドを使用する必要があります。 - -:::note - -Scalar Manager は Grafana の外部 IP アドレスを検出し、その IP アドレスに基づいて Grafana を埋め込もうとします。そのため、Grafana サービスタイプを `LoadBalancer` として設定し、外部 IP アドレスにブラウザーからアクセスできる必要があります。 - -::: + minikube 以外の Kubernetes クラスターを使用している場合は、クラスターの説明に従って `LoadBalancer` サービスにアクセスします。たとえば、クラウドサービスプロバイダーのロードバランサーを使用するか、`kubectl port-forward` コマンドを使用します。 ## 追加の詳細 -このセクションでは、構成とリソース検出に関する追加の詳細について説明します。 +このセクションでは、設定とリソース検出に関する追加の詳細について説明します。 -### Scalar Manager のデプロイメントをアップグレードする +### Scalar Manager をアップグレードする -Scalar Manager のデプロイメントをアップグレードするには、次のコマンドを実行します。 +Scalar Manager をアップグレードするには、次のコマンドを実行します。 ```console helm upgrade ${SCALAR_MANAGER_RELEASE_NAME} scalar-labs/scalar-manager -n ${SCALAR_MANAGER_NAMESPACE} -f ${SCALAR_MANAGER_CUSTOM_VALUES_FILE} --version ${SCALAR_MANAGER_CHART_VERSION} @@ -181,9 +189,9 @@ Scalar Manager をアンインストールするには、次のコマンドを helm uninstall ${SCALAR_MANAGER_RELEASE_NAME} -n ${SCALAR_MANAGER_NAMESPACE} ``` -### オプションの Scalar Manager 構成 +### オプションの Scalar Manager 設定 -Scalar Manager に設定できるオプションの構成については、[オプション設定](./configure-custom-values-scalar-manager.mdx#オプション設定)を参照してください。 +Scalar Manager に設定できるオプションの設定については、[オプション設定](./configure-custom-values-scalar-manager.mdx#オプション設定)を参照してください。 ### リソースの検出 @@ -191,8 +199,6 @@ Scalar Manager は、特定のラベルセレクターを使用して、クラ - 依存関係 - Prometheus サービス - - Loki サービス - - Grafana サービス - ターゲット - ScalarDB Cluster のデプロイメント - ScalarDL Ledger のデプロイメント @@ -202,9 +208,9 @@ Scalar Manager は、特定のラベルセレクターを使用して、クラ #### 依存関係 -Scalar Manager は、[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) および [loki-stack](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack) Helm Chart に設定されているデフォルトのラベルと値を検索します。Scalar Manager が依存関係を検出するために使用するデフォルトのラベルと値の詳細については、[`api.applicationProperties` で設定できるプロパティ](./configure-custom-values-scalar-manager.mdx#apiapplicationProperties-で設定できるプロパティ)を参照してください。 +Scalar Manager は、[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) Helm Chart に設定されているデフォルトのラベルと値を検索します。Scalar Manager が依存関係を検出するために使用するデフォルトのラベルと値の詳細については、[`api.applicationProperties` で設定できるプロパティ](./configure-custom-values-scalar-manager.mdx#apiapplicationProperties-で設定できるプロパティ)を参照してください。 -また、`kube-prometheus-stack` または `loki-stack` のインストール時に値をカスタマイズした場合は、Scalar Manager のカスタム値 `api.applicationProperties` のラベルセレクターを更新する必要があります。 +また、`kube-prometheus-stack` のインストール時に値をカスタマイズした場合は、Scalar Manager のカスタム値 `api.applicationProperties` のラベルセレクターを更新する必要があります。 #### ターゲット