ansible-doc로 문서 읽기

ansible-doc 명령은 셸에서 바로 전체 모듈 문서를 보여 주므로, 정보를 찾기 위해 터미널을 떠날 필요가 없습니다.

모듈 이름을 전달하여 해당 문서를 읽습니다. 모든 옵션과 그 유형, 필수 여부를 확인할 수 있습니다. 모듈을 배우는 가장 빠른 방법입니다.

출력에는 각 option의 설명, 기본값, 선택지가 나열됩니다. 이를 통해 모듈이 정확히 어떤 키를 허용하는지 알 수 있습니다.

-s를 추가하면 모듈 인수를 바로 복사하여 사용할 수 있는 코드 조각으로 출력합니다. 새 작업을 시작하기에 아주 좋습니다.

-l과 함께 실행하면 설치된 모든 모듈이 한 줄 요약과 함께 나열됩니다. grep으로 결과를 파이프 처리하여 필요한 항목을 찾을 수 있습니다.

이름이 확실하지 않으신가요? 모듈을 나열한 다음 주제별로 필터링합니다. service를 검색하면 관련 modules가 빠르게 나타납니다.

ansible-doc는 로컬에 설치된 모듈을 읽으므로 문서가 사용 중인 정확한 version과 항상 일치합니다. 오래된 온라인 페이지를 볼 위험이 없습니다.

문서에는 changed나 stdout처럼 모듈이 무엇을 returns하는지도 설명되어 있습니다. 나중에 사용하려고 결과를 등록할 때 유용합니다.

-t를 사용하면 모듈뿐 아니라 다른 플러그인 유형의 문서도 읽을 수 있습니다. 예를 들어 lookup이나 filter 플러그인도 같은 방법으로 조회할 수 있습니다.

문서 헤더에는 모듈의 collection과 간단한 용도가 표시되므로, 작업을 작성하기 전에 정규화된 전체 이름을 알 수 있습니다.

인수를 추측하기 전에 먼저 ansible-doc를 확인하십시오. 10초 동안 조회하면 실행 실패와 이해하기 어려운 오류 메시지를 피할 수 있습니다.

전체 설명서가 아니라 모듈 인수의 빠른 복사 및 붙여넣기용 코드 조각이 필요합니다.

ansible-doc는 사용 중인 버전에 맞는 문서를 터미널로 가져옵니다. 모듈을 조회하고, 코드 조각에는 -s를 사용하며, 나열 및 검색에는 -l을 사용하십시오. 📚