April 2016
Intermediate to advanced
364 pages
7h 54m
Japanese
Content preview from 初めてのAnsible
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
205
10.8 モジュールのドキュメントの作成
チェックモードで実行された場合に、モジュールがホストの状態を変更しないようにするのは、
モジュールの作者の責任です。
10.8
モジュールのドキュメントの作成
モジュールにはドキュメントを作成し、
Ansible
プロジェクトの標準に従って、モジュールの
HTML
のドキュメントが正しく生成され、
ansible-doc
プログラムでそのドキュメントが表示さ
れるようにするべきです。
Ansible
では、モジュールのドキュメントのために、
YAML
ベースの特
別な構文が使われます。
モジュールの先頭付近で、ドキュメンテーションを含む
DOCUMENTATION
という文字列変素と、使
用方法の例を含む
EXAMPLES
という文字列変数を定義してください。
例
10-8
は、本章の
can_reach
モジュールのドキュメンテーションのセクションです。
例
10-8
モジュールのドキュメンテーションの例
DOCUMENTATION = '''
---
module: can_reach
short_description: Checks server reachability
description:
- Checks if a remote server can be reached
version_added: "1.8"
options:
host:
description:
- A DNS hostname or IP address
required: true
port:
description: ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.