Mirantis Unlocked検証プログラムの一部としてのFuelプラグインの検証。 必要ですか？

著者：エフゲニアシューマッハ、イリヤステッキン



みなさんこんにちは。 はい、お金が好きなら、それが必要です。 さらに、「プラグイン検証」とは何か、なぜビジネスに役立つのかを説明します。 ビジネスに興味がなく、プログラミングが自己表現の方法である場合、さらに読むことはできません。

Fuelアーキテクチャの一部としてのプラグイン

また、読むことにした場合は、まず、 FuelおよびFuelプラグインが何であるかを思い出しましょう（2015年8月と10月のブログ投稿を参照）。 ユーザー調査によると、Fuelは非常に人気のあるOpenStackデプロイメントツールです。 プラグインを作成する機能は、バージョン6.1以降のFuelに登場しました。 ユーザーがこのクラウド展開ツールの機能を任意に拡張できるようにする必要がありました。 以前は、これはプロジェクト自体のコードで作業しているときにのみ実行できました。 プラグインの導入により、ユーザーはプロジェクトの「コア」を変更する複雑なプロセスをバイパスして、Fuelをカスタマイズできました。



ただし、今日でも、ユーザーはFuelの開発に直接貢献する機会があります。 しかし、これは別の話であり、記事のトピックとは関係ありません。 プラグインを使用してFuel機能を拡張するのは簡単です。この場合、設計図の数百万サイクルのアップライトを行う必要がないためです（用語の定義については、 Contributor Dictionaryを参照してください）。 実際のところ、プラグイン自体は自分で管理するプロジェクトです（ たとえば、Mellanoxがそれを行う方法など ）。



辞書にない用語：



Fuelプラグインフレームワークは、プラグインを使用して機能を拡張できるように製品が設計されていることを示すアーキテクチャ用語です。



FuelプラグインSDK（ソフトウェア開発キット）は、開発者がFuelのプラグインを作成するのに役立つツール、プラクティス、ドキュメント、トレーニング資料のセットです。 現在のバージョンはここから入手できますが 、すぐにここに移動します 。commitを参照してください。 このツールセットは、プラグインの開発と実装のベストプラクティスの分析から派生したルールに基づいています。 プラグインを検証するには、これらのルールに従う必要があります。 OpenStackの機能は、コミュニティのルールに従う開発者の責任です。 コミュニティによって採用された適切な手順に従わないでイニシアチブが提案された場合（例えば、鈍器の設立）-それは受け入れられることを保証されません。 Fuelのプラグインの場合、開発者はより自由になります。 プラグインが検証されることになっている場合にのみ、「ベストプラクティス」に厳密に従う必要が生じます。 たとえば、無料ライセンス用に開発された標準（主にApache 2.0）への準拠を監視する必要があります。Fuelはオープンソースプロジェクトです。 これは、Fuelの公式プラグインも開く必要があることを意味します。 ただし、独自のニーズに対しては、無効なプラグインを開発して使用できます。



driverlogは、 OpenStackコンポーネント用のプラグインカタログであり、開発者のコ​​ミュニティによって管理されています。

プラグインの検証にまだ興味があるのはなぜですか

検証にはビジネス上の側面があります。 プラグインがMOS（Mirantis OpenStack）で動作するという確認を公式に受け取った場合、 Driverlogだけでなく公開されます （これは強く推奨されています。Fuelの 30を超えるプラグインは既にコミュニティに公式に知られていますが、私たちはそれらについては知りませんが、Mirantisのウェブサイトでも同様です。これにより、お客様はこれを認識し、お客様の製品を意思決定に使用できます。



この場合、Mirantisは一種の「コアレビューア」として機能します。 「プラグインを作成するためのルールは次のとおりです。」 何らかの理由でこれらのルールに従わないことにした場合-これはあなたの権利です。 検証手順を実行することを決定するまで。 ただし、検証に進む場合は、コードを読み取り、+ 1と-1の両方を配置できます。 つまり、コードの改善を推奨できます。 ドキュメントを確認します（検証については、特定の方法でプラグインをドキュメント化する必要があります-SDKを参照してください）。 さらに、テストスクリプトとその結果を含むCIを提供する必要があります。 お客様のシナリオに従って、独自のテストを実施します。 そして、それらの結果はあなたが提供したものと一致するはずです。



検証済みのプラグインを使用したMOSのオプションは、Mirantisのサポートとプラグイン開発者によってサポートされます（つまり、Mirantisはクライアントの呼び出しに応答しますが、問題がFuelプラグインによって提供される機能にある場合、サポートアプリケーションはプラグイン開発者に送信されます）。

制限事項

検証は、プラグインがすべてのクライアントおよびすべてのMOSインストールに適していることを保証することを意味するものではありません。 プラグイン開発者は、特定のユーザーケース（ユースケース）を定義し、プラグインの制限についても説明します。 Mirantisは、特定のユーザーケース（ユースケース）のフレームワークでプラグインの正当性もチェックします。 プラグインが1つまたは別のクライアントに適合しないというリスクが常にあります。



プラグインは書かれ、文書化され、正常に検証され、当社の専門家またはクライアントはプラグインの使用に興味を持っていますが、その過程で、クライアントには非常に具体的な展開要件があります。 そして、プラグインは適合しません。 したがって、検証は、プラグインがすべてのクライアントに適していることを保証しません。 プラグインを追加または書き換える必要がある場合があります。



そのような場合、実装チームはプラグインサポートチームに連絡し、プラグインの機能を拡張するために必要なコード変更を行うよう要求します。



MOSディストリビューションにはプラグインが含まれていないことに注意してください。 後者にはプラグインは含まれません。 プラグインは個別にダウンロードする必要があります。 これはrpm形式でパッケージ化されたパペットマニフェストのセットであり、パッケージを特定の順序で配置できます。 この部分は開いている必要があります。 同時に、プラグインによって配置されるパッケージは独自のものである可能性があり、販売の対象となります。 たとえば、Juniper Contrail。 このプラグインを使用するには、購入時のノード数と構成を示すJuniper Contrailパッケージを使用する権利をJuniperから購入する必要があります。 クライアントが購入したパッケージを特定のアドレスに配置した後のみ、MOS（プラグインを使用）はそれらにアクセスできます。

検証プロセスの手順

検証は、いくつかの段階で構成される複雑なプロセスです。



1.プラグインの設計を説明する仕様（「仕様」）を提供します。



2.コードレビュー。 もちろん、実際には、検証済みのプラグインに「評価」を与えるのではなく、コメントを付けます。 開発者には、コメントを無視する権利があります。 ただし、変更が行われるまで検証プロセスが完了しない場合があります。



3.ドキュメントのレビュー。 開発者は、次のドキュメントパッケージを提供する必要があります。

-ユーザーガイドは、プラグインの使用方法と理由、プラグインの使用制限、ユーザーにとって役立つ「ライフハック」、ユーザーが遭遇する可能性のある「落とし穴」に関する情報を含む最も重要なドキュメントです。

-テスト計画。

-テストレポート。 最後の2つのドキュメントでは、ユーザーケースのカバレッジの完全性をテストで確認できます。



上記のすべてのドキュメントについて、テンプレートが開発されています。 これらは、Fuel Plugin SDKの一部です。

テストに関しては、一般/必須および特定の2つのタイプを区別します。 パートナーは、独自のテストケースをテスト計画に追加することを期待しています。 さらに、パートナーはCIを構築し、自動化されたテストを開発して、プラグインのアセンブリとテストを簡素化する必要があります。

次に、テストレポートを使用して、テスト結果をあなたに起こったことと比較することができます。

この比較を行うために、「名前のないユーザー」のパスを完全に繰り返します。プラグインをパッケージの形式で送信し、ラボ（またはパートナーのラボ）で開発者が提示したユーザーガイドのすべての手順を順番に実行するようお願いします。 その後、テスト計画を取り、選択的にテストを実施します。 したがって、テストレポートの結果がどの程度真実であるかがわかります。 通常、この手順を使用すると、多数のバグをキャッチできます。 これまでのところ、コメントがないというケースはありません。 これらは定期的な修正である場合もありますが、公開前に修正する必要がある重大なエラーもあります。 一部のパートナーは私たちを厳しすぎると考えています。 しかし、Mirantisの強みは提案されたソリューションの信頼性にあると確信しています。



4.パートナーに、プラグインのデモをリアルタイムで実施するよう依頼します。 これにより、a）関心のあるすべてのMirantis部門がプラグインに精通し、b）提案されたソリューションの操作性を明確に示すことができます。



検証プロセスの最後に、プラグインをアフィリエイトカタログに公開します。 開発者は、独自にdriverlogで公開することもできます。

おわりに

外部から見ると、プロセスは複雑に思えますが、コミュニティの仕組みに精通している人にとっては、新しいものはありません。 パートナーチームは、すべてのプラグイン開発者の成功を支援します。 SDKを開発するだけでなく、いつでも質問に答えることができます。 連絡するには、freenode.netでIRCチャットを使用します（一般的なFuelチャンネルは＃fuel、Fuel developerチャンネルは＃fuel-dev、主要なFuelコンポーネントの開発者向けチャンネルは次のとおりです：＃fuel-library、＃fuel-python、＃fuel-ui 、＃fuel-qa、＃fuel-infra。すべてのFuelリポジトリのGerrit通知はこちらから入手できます：＃fuel-tracker）、 unlocked -tech @ mirantis.comのメールアドレスを使用することもできます。 詳細はこちら 。