| 講演抄録/キーワード |
| 講演名 |
2024-01-26 14:40
構成管理ツールを元にしたドキュメント出力方法の提案 ○杉本智紀・森永一路・猪股誠至・小西史朗・片山弘巳・沼田晋作(MF) ICM2023-41 LOIS2023-45 |
| 抄録 |
(和) |
システム運用におけるドキュメントは非常に重要である。近年システム更新はIaCやCICDツールなどの登場により大きく自動化が進み更新頻度は増加している。しかし、それに対応するシステム運用ドキュメントについてはエンジニアによる手動作成が主流であり、IaCやCICDツールのような劇的に稼働削減する状況には至っていない。このため、システムの実態に追随出来ない古いドキュメントを用いたシステム運用や、ドキュメントや運用説明を優先させ開発完了からリリースまでのスピードが遅延してしまうような事態が発生する。また、ドキュメントはエンジニアが個々に作成を行うため、記載の抜け漏れだけでなく、表記揺れや散文による記述による不正確な情報伝達が行われることがある。本研究では、システムの定義が一意に記載された構成管理ツールのコードから、必要な運用ドキュメントを作成する手法を提案する。また、出力されたドキュメントを実際の運用員によって定性評価を行う。 |
| (英) |
Documentation is very important in system operation. In recent years, system updates have been greatly automated with the advent of IaC and CICD tools, and the frequency of updates has increased. However, the corresponding system operation documents are still mainly created manually by engineers, and have not yet reached the situation where they can dramatically reduce the number of operations as with IaC and CICD tools. This leads to system operation using outdated documents that do not follow the actual system situation, and to a delay in the speed from development completion to release due to prioritising documents and operational explanations. In addition, because the documents are created individually by the engineers, not only omissions but also inaccurate information may be communicated due to shaky notation and prose descriptions. This study proposes a method for creating the necessary operational documentation from the code of a configuration management tool in which the system definition is uniquely described. The output documents are also qualitatively evaluated by actual operators. |
| キーワード |
(和) |
運用 / 構成管理 / ドキュメント / 自動生成 / terraform / ansible / マニュアル / Jinja |
| (英) |
System operation / Configuration Management / Document / Automatic generation / terraform / ansible / manual / Jinja |
| 文献情報 |
信学技報, vol. 123, no. 363, ICM2023-41, pp. 75-79, 2024年1月. |
| 資料番号 |
ICM2023-41 |
| 発行日 |
2024-01-18 (ICM, LOIS) |
| ISSN |
Online edition: ISSN 2432-6380 |
著作権に ついて |
技術研究報告に掲載された論文の著作権は電子情報通信学会に帰属します.(許諾番号:10GA0019/12GB0052/13GB0056/17GB0034/18GB0034) |
| PDFダウンロード |
ICM2023-41 LOIS2023-45 |