テンプレートは、ワークロードの実行に必要なコンテナ、ネットワークなどのリソースを定義するサービスです。
NHN Container Service(NCS)を使用するには、先にテンプレートを作成する必要があります。Container > NHN Container Service(NCS)ページでテンプレートタブをクリックし、テンプレートの作成をクリックします。テンプレートの作成に必要な項目は次のとおりです。
| 項目 | 説明 |
|---|---|
| テンプレート名 | テンプレートの名前。32文字以内の英字小文字と数字、一部記号(-)のみ入力できます。 |
| 説明 | テンプレートの説明。255文字以内で入力できます。 |
| コンテナ名 | コンテナの名前。253文字以内の英字小文字と数字、一部記号(-)のみ入力できます。 |
| コンテナレジストリ | コンテナイメージのレジストリ
|
| レジストリタイプ | レジストリのタイプ。パブリックまたはプライベートを選択できます。 |
| イメージURL | コンテナイメージの情報。255文字以内の英字小文字と数字、一部記号(-, \_, ., ,, /, @, :)のみ入力できます。 |
| レジストリID | プライベートレジストリ認証に使用されるID |
| レジストリパスワード | プライベートレジストリ認証に使用されるパスワード |
| メモリ | コンテナに割り当てるメモリ |
| ポート | コンテナで使用するポート |
| CPU | コンテナに割り当てるCPU数。0.25～16の間の数を0.25個単位で入力できます。 |
| GPU使用有無 | コンテナのGPU使用有無を決定します。 |
| GPUタイプ | コンテナに割り当てるGPUタイプを決定します。 |
| コマンド | コンテナが起動する時に実行されるコマンド。イメージに指定されたENTRYPOINTより優先されます。 |
| 引数 | コンテナの起動時に渡される引数。イメージに指定されたCMDより優先されます。 |
| 作業ディレクトリ | コンテナの作業ディレクトリ。イメージに指定されたWORKDIRより優先されます。 |
| 環境変数 | コンテナに設定する環境変数 |
| ライフサイクルフック | コンテナの作成、終了時に実行するコマンドを設定できます。 作成直後に入力したコマンドが失敗すると、コンテナが再起動されます。 コマンド実行前にコンテナが終了した場合、コマンドが実行されない場合があります。
終了直前(preStop)例) bash,-c,curl $URL/preStop |
| ファイル | Object Storageにアップロードしたファイルをコンテナディレクトリにマウントして使用できます。
|
| 秘密データ | Secure Key Managerに保存した機密データファイルをコンテナディレクトリにマウントして使用することができます。
|
| NASストレージ | コンテナに接続するNASストレージを入力します。
|
| 状態点検 | コンテナの状態を点検するコマンドを構成できます。
|
| サブネット | VPCに定義されたサブネットのうち、インスタンスに接続するサブネット |
| DNS | ワークロードで使用するDNSサーバーを設定します。 設定しない場合は8.8.8.8を使用します。 Private DNS連動が必要な場合はPrivate DNS Server IPを入力します。 |
必要な情報を入力し、テンプレートの作成をクリックするとテンプレートが作成されます。
[注意] NCS環境点検作業または一時的なエラーによりコンテナ(task)が再起動される場合、作成されたログとコンテナ内のデータは初期化されます。再起動されても維持が必要なデータはNASストレージを使用してください。
[参考]
/var/${ワークロード名}パスにコンテナ間の一時的な共有ストレージが提供されます。[参考] テンプレートに同じプロトコルのポートは1つのみ追加できます。 TCPとHTTP, HTTPS, TERMINATED_HTTPSは同じポートを使用できません。 HTTP, TERMINATED_HTTPSプロトコルを使用するとロードバランサーでClient IPを識別できるX-Forwarded-For Headerが追加されます。
[参考] コンテナごとに臨時ストレージは20GBが提供されます。提供された使用量を超える場合、コンテナが再起動され、一時ストレージは初期化されます。
[参考] ファイルと秘密データはテンプレート作成時の情報を使用します。元ファイルや秘密データが修正されても、すでに作成されたテンプレートの情報は影響を受けません。 ファイルは同一組織内のプロジェクトObject Storageにのみアクセスできます。 秘密データは同じプロジェクトのSecure Key Managerを活用します。秘密データを使用するには、まずSecure Key Managerサービスを有効にする必要があります。
作成したテンプレートは Container > NHN Container Service(NCS) ページのテンプレートタブで確認できます。テンプレートリストにはコンテナリソースの合計が表示されます。
特定テンプレートをクリックして基本情報タブで詳細情報を確認できます。
| 項目 | 説明 |
|---|---|
| 名前 | テンプレートの名前とID |
| 説明 | テンプレートの説明 |
| コンテナ | テンプレートに定義されたコンテナ数 |
| CPU | テンプレートに定義されたコンテナのCPU数を加えた数 |
| 作成日 | テンプレートが作成された日付 |
| VPC | テンプレートに設定されたVPC |
| サブネット | テンプレートに設定されたサブネット |
特定テンプレートをクリックした後、コンテナタブに移動してテンプレートに追加したコンテナリストを確認できます。コンテナリストから特定コンテナを選択して詳細情報を確認できます。
| 項目 | 説明 |
|---|---|
| コンテナ名 | コンテナの名前 |
| イメージURL | コンテナイメージの情報 |
| メモリ | コンテナに割り当てられたメモリ |
| CPU | コンテナに割り当てられたCPU数 |
| GPU | コンテナに割り当てられたGPU情報 |
| ポート | コンテナで使用するポート |
| コマンド | コンテナ起動時に実行されるコマンド |
| 引数 | コンテナの起動時に渡される引数 |
| 作業ディレクトリ | コンテナの作業ディレクトリ |
| 環境変数 | コンテナに設定された環境変数 |
| ストレージ | コンテナに接続されたストレージ |
| ライフサイクルフック | コンテナに設定されたライフサイクルフック |
| ファイル | コンテナに接続されたオブジェクトファイルとマウントパス |
| 秘密データ | コンテナに接続された機密データとマウントパス |
| 状態点検 | コンテナに設定された状態点検 |
削除するテンプレートを選択し、テンプレートの削除をクリックすると削除されます。
[参考] 該当テンプレートを使用するワークロードが存在する場合はテンプレートを削除できません。
定義したテンプレートを利用してコンテナを実行するサービスです。
Container > NHN Container Service(NCS) ページでワークロードタブをクリックし、ワークロードの作成をクリックします。ワークロードの作成に必要な項目は次のとおりです。
| 項目 | 説明 |
|---|---|
| テンプレート | テンプレートの名前
|
| 名前 | ワークロードの名前。32文字以内の英字小文字と数字、一部記号(-)のみ入力できます。 |
| 説明 | ワークロードの説明。255文字以内で入力できます。 |
| 作業リクエスト数 | 実行するテンプレート数。1～100の間の値を入力できます。 |
| 配布コントローラー | ワークロード作業の配布コントローラーを選択できます。
|
| 予約実行 | 時間ベースのスケジュールを設定してワークロード実行を予約できます。
ワークロード実行周期が10分以下の場合、ロードバランサーを有効にできません。 |
| ロードバランサー | テンプレートのコンテナ情報にポートが指定されている場合にのみ使用ボタンが有効になります。
|
| 内部ロードバランサー | NCS内でのみ通信可能なロードバランサーを使用できます。テンプレートのコンテナ情報にポートが指定されている場合のみ、使用ボタンが有効になります。
|
| Private DNS | VPC内でアクセス可能なドメインを使用できます。
|
| セキュリティグループ | ワークロードのセキュリティグループを指定できます。 ワークロードセキュリティグループを選択した場合、コンテナポートのセキュリティルールを作成する必要があります。 ワークロードセキュリティグループを選択しない場合、NCSで作成したセキュリティグループが適用され、コンテナポートのセキュリティルールが自動的に作成されます。 |
必要な情報を入力し、ワークロードの作成をクリックするとワークロードが作成されます。
[参考] レガシーネットワーク環境ではロードバランサーを使用できません。 予約設定時、作業リクエスト数は1個に固定されます。 ワークロード実行周期が10分以下の場合、ロードバランサーを有効にできません。 同時実行ポリシー(Replace)によって既存作業が新しい作業に置き換えられる場合、既存作業のヒストリーは残りません。
[参考] 予約実行のCron式(* * * * *)の各フィールドの意味は次のとおりです。
フィールド名 値の許容範囲 許容される特殊文字 分 0-59 */,-時間 0-23 */,-日 1-31 */,?月 1-12
JAN-DEC*/,-曜日 0-6
SUN-SAT*/,?[参考] 内部ロードバランサーIPでローカル通信を行うことはできません。 [注意] ワークロードで使用中のPrivate DNS ZoneまたはPrivate DNSレコードセットを削除すると、VPC内でドメイン連動ができなくなります。
作成したワークロードはContainer > NHN Container Service(NCS)ページのワークロードタブで確認できます。
特定ワークロードをクリックして基本情報タブで詳細情報を確認できます。
| 項目 | 説明 |
|---|---|
| 名前 | ワークロードの名前とID |
| 説明 | ワークロードの説明 |
| テンプレート | 使用されたテンプレートの名前 |
| 配布コントローラー | ワークロードの配布コントローラー |
| 作業リクエスト数 | 実行するテンプレートの数 |
| 作業実行数 | 実行されたテンプレートの数 |
| 作成日 | ワークロードが作成された日付 |
| VPC | ワークロードに設定されたVPC |
| サブネット | ワークロードに設定されたサブネット |
| セキュリティグループ | ワークロードに設定されたセキュリティグループの名前 |
| Private DNS | ワークロードに設定されたPrivate DNS情報 |
| ロードバランサー | ロードバランサー情報 |
| 内部ロードバランサー | 内部ロードバランサー情報 |
[参考] ワークロードの状態は、含まれているすべてのコンテナとロードバランサーの状態を考慮して決定されます。個別コンテナの状態は実行コンテナタブで確認できます。
特定ワークロードをクリックした後、実行コンテナタブでコンテナをクリックしてコンテナ詳細情報を確認できます。
| 項目 | 説明 |
|---|---|
| コンテナ名 | コンテナの名前 |
| イメージURL | コンテナイメージの情報 |
| IP | コンテナに割り当てられたIPアドレス |
| 状態 | コンテナの状態 |
| 再起動回数 | コンテナが再起動した回数 |
| メモリ | コンテナに割り当てられたメモリ |
| CPU | コンテナに割り当てられたCPUの数 |
| GPU | コンテナに割り当てられたGPUの情報 |
| ポート | コンテナで使用するポート |
| コマンド | コンテナ起動時に実行されるコマンド |
| 引数 | コンテナの起動時に渡される引数 |
| 作業ディレクトリ | コンテナの作業ディレクトリ |
| 環境変数 | コンテナに設定された環境変数 |
| ストレージ | コンテナに接続されたストレージ |
| ライフサイクルフック | コンテナに設定されたライフサイクルフック |
| ファイル | コンテナに接続されたオブジェクトファイルとマウントパス |
| 秘密データ | コンテナに接続された機密データとマウントパス |
| 状態点検 | コンテナに設定された状態点検 |
| 開始日 | コンテナが起動した日付 |
特定ワークロードをクリックした後、モニタリングタブでコンテナのリソース使用率を確認できます。コンテナ指標は15秒単位で収集され、最大1年間保管されます。 モニタリングを提供する項目は次のとおりです。
| 項目 | 単位 | 説明 |
|---|---|---|
| CPU使用率 | % | コンテナに割り当てられたCPU基準で使用率が提供されます。 |
| メモリ使用率 | % | コンテナに割り当てられたMemory基準で使用率が提供されます。 |
| ネットワークデータ送信 | bps | ワークロードの作業基準でネットワークデータ送信情報が提供されます。 |
| ネットワークデータ受信 | bps | ワークロードの作業基準でネットワークデータ受信情報が提供されます。 |
| ディスク使用率 | % | コンテナに追加されたNASストレージの使用率が提供されます。 |
| 臨時ストレージ使用率 | % | ワークロードの作業基準で臨時ストレージ使用率が提供されます。 |
| GPU使用率 | % | コンテナに割り当てられた GPUの使用率が提供されます。 |
| GPUメモリ使用率 | % | コンテナに割り当てられた GPUメモリの使用率が提供されます。 |
| GPU電力使用量 | mW | コンテナに割り当てられた GPU 電力使用量が提供されます。 |
| GPU温度 | ℃ | コンテナに割り当てられたGPU温度が提供されます。 |
特定ワークロードをクリックし、イベントタブでコンテナにて発生したイベント情報を確認できます。イベント状態選択をクリックしてイベントの状態ごとにイベントを確認できます。
| 項目 | 説明 |
|---|---|
| 状態 | イベントの状態 |
| タイプ | イベントのタイプ |
| 説明 | イベントの説明 |
| イベント最初の発生日時 | イベントの最初の発生日時 |
| イベント最終発生日時 | イベントの最終発生日時 |
| 発生数 | イベントが発生した回数 |
[参考] イベントは最大1時間のみ維持され、1時間前の情報は確認できません。 コンテナの現在と最後の状態についての詳細理由もイベントで確認できます。
特定ワークロードをクリックした後、ログタブでコンテナのログを確認できます。 照会したい時間に多くのログが発生した場合、一部のログだけが照会される場合があります。すべてのログが照会されない場合は、時間範囲を減らして再試行してください。
[参考] ログは2か月間保管されます。
ワークロード実行ヒストリーを確認するワークロードを選択し、ワークロード実行ヒストリータブでワークロードテンプレートの変更進行状況および履歴を確認できます。
| 項目 | 説明 |
|---|---|
| テンプレート名 | ワークロードが使用するテンプレート名 |
| 実行時間 | 該当テンプレートを使用するワークロードの配布開始時間 |
| 終了時間 | 該当テンプレートを使用するワークロードの終了時間 |
| 状態 | 配布状態 succeeded：配布完了 pending：配布中 terminated：終了したワークロード |
照会されたヒストリー情報をクリックしてワークロード実行ヒストリー詳細情報を確認できます。
[参考] 実行中のワークロードのヒストリーには終了時間が表示されず、状態がsucceededで維持されます。 [注意] ワークロード削除後はワークロード実行ヒストリーを確認できません。
予約実行ヒストリーを確認するワークロードを選択して予約実行ヒストリータブで実行された作業リストを確認できます。
| 項目 | 説明 |
|---|---|
| 作業ID | 実行された予約タスクID |
| 実行時間 | 予約タスク実行時間 |
| 終了時間 | 予約タスク終了時間 |
| 状態 | 予約タスク状態 waiting:予約実行準備中 running:予約タスク実行中 completed:予約タスク正常終了 error:予約タスク異常終了 |
変更するワークロードを選択した後、基本情報タブで変更をクリックして実行中のワークロードを変更できます。
| 項目 | 説明 |
|---|---|
| 説明 | ワークロードの説明 |
| テンプレート | 実行中のワークロードのテンプレート変更 テンプレートを変更すると、ローリングアップデート方式でワークロードが無中断配布されます。 作業が1つずつ順番に置き換えられ配布中に既存作業と新しい作業が同時に実行された状態になる場合があります。 ワークロード実行ヒストリータブで変更結果を確認できます。 |
| 作業リクエスト数 | 実行中のワークロードの作業数の変更 作業リクエスト数増加：既存の作業は維持しながら新しい作業が作成されます。 作業リクエスト数の減少：減少した作業数だけ作業が終了します。 |
| 予約実行 | 予約実行情報を変更 予約実行ヒストリー保管数は、変更時間から設定され、変更前に実行された作業がすべて削除されるまで、ヒストリー数と設定値が一致しない場合があります。 |
| ロードバランサー | ワークロードのロードバランサー, Floating IP, ヘルスチェック, SSL証明書を使用するかどうかを変更 |
[注意] ロードバランサーを使用してワークロードサービスを利用中にテンプレートを変更する場合、瞬断が発生する可能性があります。 [参考] ワークロードがPending状態の場合、ロードバランサーを変更できません。 ワークロード変更に失敗した場合(例：イメージエラー)変更試行が終了し、作業交換が発生しません。
ワークロード停止を実行すると、ワークロードのすべての作業が終了します。
ワークロードの再起動を実行すると、ロードバランサーIPは変更されます。
[参考] 配布コントローラーによっては、ワークロードの停止/再起動を実行すると、コンテナIPが変更される場合があります。
[注意] ワークロードを停止するとログ、イベント、臨時ストレージはは初期化されます。 ワークロードを停止しても作業繰り返し周期になると予約実行ヒストリーは削除されます。
削除するワークロードを選択し、ワークロードの削除をクリックすると削除されます。
NCSロールを設定してサービスおよびリソースにアクセスできるロールを制御できます。 例えば「NCS管理者」はテンプレートとワークロードの作成、照会および管理できるロールを持ち、「NCSユーザー」はテンプレートとワークロードの照会ロールのみ持つように設定できます。
NCSの実行ロールはNHN Cloud Console画面で設定します。 1. プロジェクト管理画面でメンバー管理メニューを選択します。 2. ロールを変更するメンバーをクリックします。 3. ロール追加を選択して、サービスごとにロールを追加します。 * 左側の領域で基本インフラサービスを選択した後、右側の領域でロールを選択します。 4. 選択されたロールを確認して追加または削除できます。 5. 追加をクリックしてプロジェクトメンバーに変更されたロールを適用します。 6. ロールが追加されたらメンバーを選択して詳細ロール内容を確認できます。
ロールグループの使用ガイドはコンソールガイドをご覧ください。
NCSを利用するには、次のリソースに対するロールが必要です。 * NCS - NCSのリソースを照会、作成および管理することを許可します。 * Infrastructure - NCSユーザーはVPC、Subnetリソースを照会することを許可します。これはNCSでテンプレートとワークロードを照会する時に必要です。 * Load Balancer - NCSユーザーはInfrastructure Load Balancerリソースを作成、管理を許可します。これはNCSでワークロードのLoad Balancerを使用する時に必要です。 * Security Group - NCSユーザーはInfrastructure Security Groupリソースを作成、管理を許可します。これはNCSでテンプレートにSecurity Groupを使用する時に必要です。
本番環境では必要なロールのみ追加することを推奨します。NCSサービスを利用するための最小限のロールは次のとおりです。
| 機能 | Infrastructure NCS ADMIN | Infrastructure MEMBER | Infrastructure Security Group ADMIN | Infrastructure Load Balancer ADMIN |
|---|---|---|---|---|
| テンプレートの照会 | O | |||
| テンプレートの作成 | O | O | ||
| テンプレートの削除 | O | O | ||
| ワークロードの照会 | O | |||
| ワークロードの作成および変更 | O | O | O | |
| ワークロードの削除 | O | O | O |
| ソースレジストリタイプ | Access ID | Access Secret |
|---|---|---|
| Azure Container Registry | アクセスキーユーザー名 | アクセスキー暗号 |
| Google Cloud Container Registry | _json_key | サービスアカウントの秘密鍵(JSONタイプ) |
| Docker Hub | Username | Password |
| Harbor | Username | Password |
| Quay | json_file | { "account_name": "$ユーザーアカウント", "docker_cli_password": "$Quayで作成した暗号化されたPassword" } |
| 分類 | タイプ | 名前 | RAM | GPU数 | MIG Profile名 |
|---|---|---|---|---|---|
| Graphics Optimized | ncs1 | ncs1.g1m5 | 5GB | 1 | MIG 1g.5gb |
| Graphics Optimized | ncs1 | ncs1.g2m10 | 10GB | 2 | MIG 2g.10gb |
NCSサービスを使用しながら経験する可能性があるさまざまな問題を解決する方法を説明します。
| エラーメッセージ | 説明 |
|---|---|
| {{.Resource}}リソースが不足しているためワークロードを作成できません。 | NCS環境のリソースが不足しているためワークロードを作成できません。 しばらくしてから再試行するか、サポートにお問い合わせください。 |
| 作成可能な{{.Resource}}を超えました。限度を上げるにはサポートにお問い合わせください。 | プロジェクトのNCS Quotaが超過しました。 詳細については、 NHN Container Service(NCS)リソース提供ポリシーを参考してください。 |
ワークロードが削除または再起動されるとログは削除され、照会できません。 重要なログをバックアップしたり、特定のログを検索して照会するためにLog & Crash Search(L&C)サービスと連動できます。
下記の内容はロギングエージェント(FluentBit, Logstash)をサイドカーコンテナで作成してL&C連動する方法について説明します。
FluentBitの詳細はFluent Bit: Official Manualを参照してください。 Logstashの詳細はLogstash Referenceを参照してください。 Log & Crash Search使い方はLog & Crash Searchコンソール使用ガイドを参照してください。
[参考] コンテナ間の一時的な共有ストレージにログをファイルとして作成する方法について説明しました。 コンテナのログをファイルで作成する場合、ワークロードのログタブではログ照会ができません。
[SERVICE]
Flush 1
Daemon Off
Log_Level warn
Parsers_File parsers.conf
Plugins_File plugins.conf
HTTP_Server Off
[INPUT]
Name tail
Path /var/{ワークロード名}/{ログファイル名}
[OUTPUT]
Name http
Match *
Host api-logncrash.cloud.toast.com
Port 443
URI /v2/log
Format json
Log_response_payload false
Tls On
Tls.verify Off
[FILTER]
Name modify
Match *
Rename log body
Add host ${HOSTNAME}
Add projectName {L&C AppKey}
Add projectVersion {ユーザー指定プロジェクトバージョン}
Add logVersion {ログフォーマットバージョン}
Add logType {ログタイプ}
Add logSource {ログソース}
Add logLevel {ログレベル}
| 項目 | alpine(ログ作成) | fluentbit(ログ送信) |
|---|---|---|
| コンテナ名 | alpine | fluentbit |
| イメージURL | alpine:latest | fluent/fluent-bit:2.2.1 |
| コマンド | ログをファイルに残すために下記のように入力します。
|
|
| コンフィグマップ | Object Storageにアップロードしたfluentbit設定ファイルをインポートできる情報を追加します。 >コンテナのマウントパスは下記のように入力します。
|
input {
file {
path => "/var/{ワークロード名}/{ログファイル名}
start_position => "beginning"
ignore_older => 0
}
}
filter {
mutate {
remove_field => [ "@version", "@timestamp", "path", "tags" ]
rename => {
"message" => "body"
"host" => "host"
}
add_field => {
"projectName" => "{L&C AppKey}"
"projectVersion" => "{ユーザー指定プロジェクトバージョン}"
"logVersion" => "{ログフォーマットバージョン}"
"logType" => "{ログタイプ}"
"logSource" => "{ログソース}"
"logLevel" => "{ログレベル}"
}
}
}
output {
http {
url => "https://api-logncrash.cloud.toast.com/v2/log"
http_method => "post"
format => "json"
ssl_verification_mode => "none"
}
}