stanctl コマンドの使用

Instana のインストールと設定には、 stanctl コマンドラインインターフェース(CLI)を使用します。

注: 利用可能なすべてのコマンドを表示するには、[ stanctl --help ] を使用してください。
重要:

セルフホスト型 Standard Edition1.10.3 and earlier versions

  • オンライン(エアギャップなし)の環境では、`[コマンド名]` などのライフサイクル関連の stanctl コマンド stanctl up のほとんどが実行に失敗します。
  • エアギャップ環境においても、これらの stanctl コマンドは引き続き動作します。

必要な操作:ライフサイクル操作を実行する前に、 1.10.4 以降のバージョンに stanctl アップグレードしてください。

例: 1.10.3 またはそれ以前のバージョンを実行しているオンライン展開環境では、 stanctl バックアップの前にサービス停止 stanctl down コマンドなどのワークフローを実行すると、その後の stanctl up コマンドが失敗するため、そのワークフローは完了しません。 これらの手順を開始する前に、 1.10.4 またはそれ以降のバージョンに stanctl アップグレードしてください。

よく使われるコマンド

以下の stanctl コマンドが頻繁に使用されます。

  • stanctl エージェント
  • stanctl バックエンド
  • ステクトル・アップ

コマンドについて詳しくは、 --help フラグを使用してください。

stanctl [command] --help
 

カスタム設定値のフラグ

stanctl コマンドは、一部の構成ではデフォルト値を使用します。

デフォルト値の代わりにカスタム値を使用するには、フラグを使用して構成値を stanctl コマンドに渡すことができます。 使用可能な構成オプションのリストを表示するには、 stanctl [command] --help を使用します。

例えば、 stanctl は、Analytics のデフォルトの /mnt/instana/stanctl/analytics マウント・ポイントを使用します。 カスタム・マウント・ポイントを使用する場合は、 --volume-analytics フラグを使用できます。 以下の例を参照してください。

stanctl up --volume-analytics <custom-path>
 

アップグレードのための更新戦略の設定

アップグレード時にバックエンドコンポーネントの Standard Edition デプロイメント更新戦略を設定するには、コマンド stanct のフラグ --core-update-strategy を使用します。

更新の戦略

この stanctl コマンドは、以下の更新戦略をサポートしています:

  • RollingUpdate (本番環境のデフォルト設定)

    • アップグレード中のダウンタイムを完全に排除します。
    • 新旧のポッドを同時に実行するには、追加のCPUおよびメモリが必要です。
    • リソースに余裕のある本番環境での利用を推奨します。
  • 再作成(デモのデフォルト設定)

    • アップグレード中に数分間の短いダウンタイムが発生します。
    • 追加の容量は必要ありません。
    • リソースに制約のあるシステム、シングルノード環境、または K3s などの軽量な Kubernetes ディストリビューションを使用する Standard Edition のインストール環境におすすめです。
注: デモ環境では、デフォルトで「Recreate」戦略が使用されます。 本番環境では、デフォルトで RollingUpdate 戦略が使用されます。 --core-update-strategy これらのデフォルト設定は、フラグを使用することで上書きできます。

この対処法の適用時期に関する詳細については、 「『CPU不足』または『メモリ不足』のエラーでアップグレードに失敗する」 を参照してください。

使用例

リソースに制約のある環境では、「Recreate」戦略を使用してください:

stanctl up --core-update-strategy=Recreate
 

RollingUpdate 戦略を明示的に指定します:

stanctl up --core-update-strategy=RollingUpdate
 

環境変数

カスタム構成値を環境変数として保管するには、値をエクスポートするか、環境ファイル (.env) に保管します。

構成フラグの環境変数名は、 STANCTL_で始まる必要があります。 フラグの環境変数名を表示するには、 --help を使用します。

例えば、 stanctl up --helpを実行すると、 --volume-analytics フラグの環境変数名が STANCTL_VOLUME_ANALYTICSであることが分かります。

フラグの環境変数を定義すると、 stanctl コマンドは自動的にその環境変数値を構成に使用します。

前のセクションで使用した --volume-analytics の例について考えてみます。 フラグに環境変数を定義した場合は、 --volume-analytics フラグを指定せずに stanctl up コマンドを実行できます。 このコマンドは環境変数値を使用します。

ただし、環境変数を定義し、コマンドでフラグも指定した場合、 stanctl は、環境変数からではなく、フラグからの値を使用します。

環境変数をエクスポートする

環境変数は、 export コマンドを使用して設定できます。 ただし、この設定は永続的ではありません。

以下の例を参照してください。

  • export STANCTL_VOLUME_ANALYTICS=/data/analytics
  • export STANCTL_CORE_BASE_DOMAIN=instana.example.com
  • export STANCTL_INSTALL_TYPE=production

環境ファイルを使用する

.env ファイルに環境変数を追加します。

STANCTL_VOLUME_ANALYTICS=/data/analytics
STANCTL_CORE_BASE_DOMAIN=instana.example.com
STANCTL_INSTALL_TYPE=production
 

stanctl コマンドは、 .env ファイルのディレクトリーから実行できます。

stanctl up
 

あるいは、 --env-file フラグを使用して、環境ファイルへのパスを指定します。

stanctl up --env-file <path-to-the-.env-file>
 

Instana バックエンドと画像のバージョン

Standard Edition をインストールまたはアップグレードする前に、インストール可能な Instana のバックエンドバージョンとイメージの一覧を確認できます。

  • Instana のバックエンドバージョンの一覧を表示するには、次のコマンドを実行してください。 このコマンドは、現在使用中のバージョンおよびそれ以前のバックエンドのバージョンをリストから除外します。

    stanctl versions identify
     

    以下の例を参照してください。

    $ stanctl versions identify
    ⠏ Identifying supported Instana versions  [0s] ✓
    Identified the following Instana versions:
    - 3.283.450-0
    - 3.281.446-0
    - 3.279.395-0
     
  • Instana のバックエンドバージョンで利用可能な画像を表示するには、次のコマンドを実行してください:

    • Instana のバックエンドバージョンを選択し、そのバージョンで利用可能なイメージを確認するには、次のコマンドを実行してください:

      stanctl versions list-images
       

      以下の例を参照してください。

      $ stanctl versions list-images
      ? Select Instana version:
      
      [Use arrows to move, type to filter]
       > 3.283.450-0
         3.281.446-0
         3.279.395-0
         Cancel
      
      stanctl versions list-images
      ? Select Instana version:
      
      3.283.450-0
      artifact-public.instana.io/backend/acceptor:3.283.450-0
      artifact-public.instana.io/backend/accountant:3.283.450-0
      artifact-public.instana.io/backend/action-orchestration:3.283.450-0
      artifact-public.instana.io/backend/action-reader:3.283.450-0
      .
      .
      .
       
    • 指定した Instana バックエンドのバージョンで利用可能な画像を確認するには、次のコマンドを実行してください。 バックエンドのバージョンを選択するプロンプトが表示されません。

      stanctl versions list-images --instana-version <backend-version>
       

      以下の例を参照してください。

      $ stanctl versions list-images --instana-version 3.283.450-0
      
      artifact-public.instana.io/backend/acceptor:3.283.450-0
      artifact-public.instana.io/backend/accountant:3.283.450-0
      artifact-public.instana.io/backend/action-orchestration:3.283.450-0
      artifact-public.instana.io/backend/action-reader:3.283.450-0
      .
      .
      .