Cisco Crosswork Workflow Manager 1.0 アダプタ開発者ガイド

偏向のない言語

この製品のドキュメントセットは、偏向のない言語を使用するように配慮されています。このドキュメントセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブ ランゲージの取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ
このマニュアル内で検索
ご利用いただける言語
Download Options

Book Title

Cisco Crosswork Workflow Manager 1.0 アダプタ開発者ガイド

Chapter Title

アダプタ SDK の使用

検索結果

Updated:
2023年6月1日木曜日

章のタイトル： アダプタ SDK の使用

アダプタ SDK の使用

ここでは、次の内容について説明します。

前提条件

ワークフローアダプタ SDK の使用を開始するには、Golang 環境、プロトコルバッファ、専用の go プラグインをインストールし、CWM ソフトウェアパッケージに含まれている アダプタ SDK をダウンロードする必要があります。

go のインストール

アダプタを開発してテストするには、Golang 環境をインストールする必要があります。お使いの OS 専用のインストール手順（https://grpc.io/docs/protoc-installation/）に従います。

プロトコルバッファのインストール

アダプタインターフェイスを定義して、入力パラメータと出力パラメータを生成するには、Protobufs コンパイラが必要です。お使いの OS 専用のインストール手順（https://grpc.io/docs/protoc-installation/）に従います。少なくともバージョン 3.15（proto3）が必要であることに注意してください。

go プラグインのインストール

手順

ステップ 1

go 用の追加のプロトコル コンパイラ プラグインをインストールします。 

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2

ステップ 2

JSON スキーマ用のプロトコル コンパイラ プラグインをインストールします。 

go install github.com/chrusty/protoc-gen-jsonschema/cmd/protoc-gen-jsonschema@latest

ステップ 3

システム PATH を更新して、protoc コンパイラがプラグインを検出できるようにします。 

export PATH="$PATH:$(go env GOPATH)/bin

CWM アダプタ SDK の入手

シスコのソフトウェア ダウンロード ページに移動して、アダプタ SDK が含まれている CWM ソフトウェアパッケージをダウンロードします。

環境変数パスを設定して、cwm-sdk-binaries の場所を含めます。

export PATH=/path/to/cwm-sdk-binaries:$PATH

（注）  

/path/to/ を必ず実際のパスに置き換えてください。

コマンドの概要

アダプタ SDK アプリケーションには、アダプタを管理するための次の一連のコマンドが用意されています。

  • cwm-sdk create-adapter：パッケージおよび対応する .proto ファイルを含む go モジュールを作成する場合に使用します。

  • cwm-sdk Extend-adapter：既存のアダプタに新しい機能を追加する場合に使用します（go パッケージおよび .proto ファイル）。

  • make generate-model：アクティビティ、入力および出力（go コード）を生成します。

  • make generate-code：アクティビティ、入力および出力（go コード）を更新します。

  • cwm-sdk upgrade-adapter：CWM と一致するようにアダプタをアップグレードします。

  • cwm-sdk create-installable：CWM によってインストール可能なアーカイブを作成します。

新規アダプタの作成

アダプタを作成するには、ターミナルを開き、cwmsdk リポジトリディレクトリから次のコマンドを実行します。

cwm-sdk create-adapter [options] -product <product-name>

オプション（Options）

create-adapter コマンドに追加できるオプションは次のとおりです。

  • -exclude-resource：テンプレートからの .resource.proto ファイルの作成をスキップします。

  • -go-module string：go.mod ファイルに割り当てられたモジュールの名前を指定します（デフォルト："www.cisco.com/cwm/adapters/<vendor> /<adapter-name>"）。

  • -feature string：アクティビティに割り当てられた go パッケージの名前を指定します（デフォルト："<adapter-name> "）。

  • -location string：アダプタの場所を指します（デフォルト：現在のディレクトリ）。

  • -os-architecture string：アダプタが開発されるアーキテクチャを定義します。有効なオプションは、「linux」、「mac-intel」、「mac-arm」、および「windows」です（デフォルト：「linux」）。

  • -vendor string：アダプタを作成する会社の一意の名前を指定します（デフォルトは「cisco」）。

  • -product string：アダプタを作成する対象の製品名に対応する go モジュールの名前を指定します（必須）。

出力

コマンドが実行されたら、新しいアダプタディレクトリ内で生成された出力を確認します。

  • <adapter-name>/go/go.mod

  • <adapter-name>/proto/<vendor\>.<module\>.<package\>.adapter.proto

  • <adapter-name>/proto/<vendor\>.<module\>.<package\>.resource.proto（-exclude-resource オプションが使われなかった場合）

  • <adapter-name>/Makefile

アダプタの機能を拡張する

アダプタの機能（go パッケージ）を追加するには、ターミナルを開き、cwmsdk リポジトリディレクトリから次のコマンドを実行します。

cwm-sdk extend-adapter [options] -feature <feature_name>

オプション（Options）

  • -exclude-resource：テンプレートからの .resource.proto ファイルの作成をスキップします。

  • -location string：新しいパッケージによって拡張されるアダプタの場所を指します（デフォルト：現在のディレクトリ）。

出力

コマンドが実行されたら、新しいアダプタディレクトリ内で生成された出力を確認します。

  • <adapter-name>/proto/<vendor>.<module>.<package>.adapter.proto

  • <adapter-name>/proto/<vendor>.<module>.<package>.resource.proto（-exclude-resource オプションが使用されていない場合）

入力と出力の生成

アダプタの入力ファイルと出力ファイルを生成するには、アダプタのルートディレクトリに移動して、次のコマンドを実行します。

make generate-model

出力

コマンドが実行されたら、アダプタディレクトリ内に生成された出力を確認します。

  • go/<feature\>/<vendor>.<product>.<feature>.adapter.pb.go

  • go/common/<vendor>.<product>.common.adapter.pb.go

.pb.go ファイルには、アダプタの入力パラメータと出力パラメータを定義する go 構造体が含まれています。手動で変更しないでください。

アクティビティの生成

以前に定義したアクティビティを生成するには、アダプタのルートディレクトリに移動して、make generate-code を実行します。

出力

コマンドが実行されたら、アダプタディレクトリ内に生成された出力を確認します。

  • go/<package>/activities.go

activity.go ファイルには、.adapter.proto で定義された gRPC のスタブが含まれています。生成されたら、メッセージを定義してアクティビティに機能を追加できます。

アダプタのアップグレード

go モジュールをアップグレードして、go および必要なインポートに一致するバージョンを含めるには、ターミナルを開き、cwmsdk リポジトリディレクトリから次を実行します。

"Linux" cwm-sdk upgrade-adapter [options]

オプション（Options）

  • -cwm-version string ：アップグレード先の CWM のバージョンを指定します（デフォルトは最新バージョンです）。

  • -location string：アップグレードするアダプタの場所を指します（デフォルト：現在のディレクトリ）。

出力

  • go/go.mod

go.mod ファイルモジュールが変更され、アダプタが正しくインストールされるようになります。

インストール可能アダプタのリリース

さまざまなオペレーティングシステム用のアダプタをインストールするためのアーカイブを作成するには、ターミナルを開き、cwmsdk リポジトリ ディレクトリから次のコマンドを実行します。

"Linux" cwm-sdk create-installable [options]

これにより、proto ファイルに基づいてコードが生成されます。

オプション（Options）

  • -location string：アダプタのインストール可能ファイルの場所を指します（デフォルトは「.」）。

出力

  • out/<vendor>-<product>-v<X.Y.Z>.tar.gz

生成されたアーカイブには、アダプタ go モジュールと proto ファイルが含まれています。go モジュールは、外部依存関係を持たないように、go vendor コマンドを使用して変更されます。

このドキュメントは役に立ちましたか?

Feedbackフィードバック

シスコに問い合わせ