AWS構成図を腐らせないで管理し続ける方法 with draw.io
概要
AWSの構成図とか、インフラの構成図とか、UMLの図とか、 例えば esa とか Pukiwiki とかConfluence とか Github とかに書いた時ってだいたい情報腐りませんか??
- メンテナンスするオリジナルファイルが見つけられない
- パスを併記するとかそうゆう運用もめんどくさい
- オリジナルファイルの管理が面倒くさい(ファイルサーバーを開いてとか、専用ツールを用いてとか)
- 変更管理が出来ない
- 書いたツールからExportして記事をUpdateしないと行けない。
めんどくさいですよね。
- メンテナンスするファイルに直ぐにアクセスできて
- 変更管理も出来て
- exportして貼り直しとかしなくても、Githubにデータ入れたら記事側も反映されて
みたいな事ができるので今日は紹介します。
ツール
draw.io
です。 AWS シンプルアイコン - AWS アーキテクチャーセンター | AWS でも紹介されているお絵かきサービスです。
シンプルなサービスなので使うと直ぐに便利なのがわかるんですけど、今日はGithub連携の話し。
図を以下のサービスから直接開けるわけですね。
もちろん Save
で保存先も同様。
Export
で PNGファイルなどの画像形式の保存先も以下が指定できる。
保存先が指定できて
コミットメッセージも書けて
終わると、Github側にほら。
ほんでですよ、これで編集とリポジトリがシームレスに繋がるわけじゃないですか? 次は、コミットしたPNGファイルをそのまま記事として張りたいわけですよね。
画像を開いて、右クリックで画像URLをコピーして記事に張れば、記事は常にgithubに追従します!
注意:Download
を押して別ウインドウで画像を開くと raw.githubusercontent.com
(GithubのCDN)のドメインにリダイレクトされてしまう為、そのURLを貼ると常に古い画像を見てしまう事になるので要注意。
Github上のネーミングルールで記事IDをつけておく事にしているので、
記事の画像を更新したくなったら、 draw.io
から Githubを開いて、編集して、保存して、画像もExportして作成すればそれで終わりという利便性です!
(1度Githubから開いていたらSaveするとすぐにCommitMessage画面になるので便利!)
自動で画像も一緒に保存できるといいんだけど、その機能はなさそうですが
図のデータへのアクセシビリティがあがればみんな気軽に気づいたベースで編集できるのと
図のデータを張り直したりとかの手間もないので編集->コミットだけの流れで図の品質が維持されるのが便利。という話でした。