Command Line Interface¶
Guance コマンドラインインターフェース（Command-Line Interface）は、Guance に接続し、Guance 上でリソース管理操作を実行するためのクロスプラットフォームのコマンドラインツールです。また、さまざまなサードパーティエコシステムのコンテンツを Guance プラットフォームにインポートして一元管理する場合にも適しています。
実際のクラウドサービスとの対話シナリオでは、SaaS プラットフォームとやり取りする方法として以下の3つがあります。
- 命令型 API とツール：操作述語を使用して特定のリソースの操作方法を説明します。例として RESTFul や命令アクションが含まれます。
- 宣言型 API とツール：必要なリソースのみを記述します。具体的な操作は、プラットフォームまたはツールが現在の状態を分析して自動的に計算し実行します。
- 対話型ツール：ユーザーとの対話を通じて、ユーザーが段階的に目標を達成できるようにします。例えば、API デバッガーではユーザーがパラメーターを調整しながらリクエストを実行し、期待する結果が得られるまで試行できます。
CLI は SaaS プロバイダーにとって重要な開発者ツールであり、GUI に代わるユーザーインタラクションの別のインターフェースとして機能します。CLI は通常、ソフトウェアの自動化問題を解決し、自動化された命令型操作を実現するために使用されます。例えば、スクリプトを記述して CLI を呼び出すことで、自動化運用のラストワンマイルを実現します。
Guance CLI は現在、以下の3つの命令型操作をサポートしています。
- リソースインポートツール：サードパーティエコシステムのコンテンツを Guance にインポートして一元管理するためのツール（例：Grafana ダッシュボードを Guance にインポート）
- データアップロードツール：一時的なデータ（単一のデータファイルや CI 成果物など）を Guance に報告するためのツール（例：テストデータのアップロード）
- インストールツール：Guance エコシステムの各コンポーネントをワンクリックでインストールするためのツール
ユースケース¶
CLI を使用して Grafana ダッシュボードを Guance にインポート¶
Grafana は、複数のデータソースからデータをインポートして可視化できる、人気のオープンソースデータ可視化ツールです。折れ線グラフ、棒グラフ、散布図、ヒートマップなど、さまざまなグラフタイプをサポートし、直感的なチャート表示により、ユーザーがデータの変化傾向や分布をより理解し、データ分析と意思決定を行うのに役立ちます。
Guance CLI は、Grafana のダッシュボードを Guance プラットフォームでサポートされる形式にエクスポートし、Guance にインポートできるようにします。また、大規模なプロジェクト統合のために Terraform ファイルをエクスポートすることもできます。
使用方法¶
制限事項¶
以下の制限事項がご利用の妨げになる場合は、リンク先（https://github.com/GuanceCloud/guance-cli/issues）からフィードバックをお寄せください。
一部のパネル形式は未サポート
現在サポートされているパネルタイプは合計10種類で、旧ダッシュボードとの互換性のために2種類の廃止されたタイプを含みます。
一部のテンプレート変数構文は未サポート
Grafana PromQL ダッシュボードの PromQL クエリは、Guance の DQL クエリ に翻訳されますが、現在は label_values の非ネスト式関数のみ翻訳をサポートしており、query_result などの他の関数は空のクエリに変換されます。
PromQL 結果は短縮表記をサポートしません
PromQL の series 名はクエリに基づいて自動生成され、短縮表記（DQL の as キーワードに類似）はサポートされません。