コンテンツにスキップ

Shoestringの概要⚓︎

Shoestring
Symbolネットワーク上の ノード をデプロイおよび管理するために使用するコマンドラインツール。

Shoestringを使用すると、ノードオペレーターは以下のことができます。

  • 新しいノードをデプロイする。
  • 既存のノードを移行する。
  • ノードソフトウェアを最新の状態に保つ。
  • ノードの証明書と投票キーを管理する。

Shoestring自体はノードを実行しません。 代わりに、必要なSymbolノードコンポーネントを含むDocker環境を準備します。

警告

ShoestringおよびSymbolノードを操作するには、使用しているオペレーティングシステムのターミナルやコマンドラインツールに精通している必要があります。 これらのガイドでは、コマンドラインの基本的な操作ができることを前提としています。

Shoestringを使う理由⚓︎

以前のSymbolのデプロイは symbol-bootstrap に依存していました。 bootstrapは Node.js に依存しており、設定の生成とオーケストレーションのための複雑なロジックが含まれていました。

Shoestringは、以下の方法でノードのデプロイを簡素化します。

  • Node.jsの代わりにPythonを使用する
  • 設定の生成と実行時の処理を分離する
  • 実行時のオーケストレーションをDockerに委任する

この設計により、依存関係が減少し、長期間にわたってノードの運用を簡素化させ、維持しやすくなります。

Shoestringの仕組み⚓︎

Shoestringは、目的のロールを持つSymbolノードを実行するために必要な設定ファイルを準備します。

一般的なワークフローは次のとおりです。

  1. ネットワーク設定ファイルを生成する。
  2. 必要に応じてノード設定をカスタマイズする。
  3. Shoestringのセットアップコマンドを実行する。
  4. ノードを実行するDockerコンテナを起動する。

実行中のノードは、CatapultサーバーREST Gatewayなど、Dockerコンテナ内の複数のコンポーネントで構成されます。

ノードソフトウェアのアップグレード、証明書の更新、ノードのヘルスチェックなど、実行中のノードの保守に役立つコマンドも提供します。

Dockerの要件⚓︎

Symbolサーバーのバイナリから直接ノードを実行することは技術的には可能ですが、このアプローチでは手動での設定とプロセス管理が必要になります。 このため、ほとんどのオペレーターにはDockerベースのデプロイが推奨されます。

このセクションのすべてのガイドでは、Dockerがシステムにインストールされ、利用可能であることを前提としています。