Ansible Navigator Creator Guide
Ansible Creator 워크플로에서 Ansible Navigator 사용.
초록
보다 포괄적 수용을 위한 오픈 소스 용어 교체
Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 용어를 교체하기 위해 최선을 다하고 있습니다. 먼저 마스터(master), 슬레이브(slave), 블랙리스트(blacklist), 화이트리스트(whitelist) 등 네 가지 용어를 교체하고 있습니다. 이러한 변경 작업은 작업 범위가 크므로 향후 여러 릴리스에 걸쳐 점차 구현할 예정입니다. 자세한 내용은 CTO Chris Wright의 메시지를 참조하십시오.
1장. Ansible 콘텐츠 탐색 정보 소개
콘텐츠 작성자는 자동화 콘텐츠 탐색기를 사용하여 Red Hat Ansible Automation Platform과 호환되는 Ansible 플레이북, 컬렉션 및 역할을 개발할 수 있습니다. 다음 환경에서 자동화 콘텐츠 탐색기를 사용할 수 있으며 모든 환경에서 원활하고 예측 가능한 결과를 얻을 수 있습니다.
- 로컬 개발 시스템
- 자동화 실행 환경
Automation Content navigator는 플레이북을 개발하고 문제 영역 문제를 해결하는 데 도움이 되는 아티팩트 파일도 생성합니다.
1.2. 자동화 콘텐츠 탐색기 모드
Automation Content navigator는 다음 두 가지 모드로 작동합니다.
- stdout 모드
- 명령줄에서 대부분의 기존 Ansible 명령 및 확장을 허용합니다.
- 텍스트 기반 사용자 인터페이스 모드
- Ansible 명령에 대한 대화형 텍스트 기반 인터페이스를 제공합니다. 이 모드를 사용하여 콘텐츠를 평가하고, 플레이북을 실행하고, 아티팩트 파일을 사용하여 실행한 후 플레이북 문제를 해결합니다.
1.2.1. stdout 모드
자동화 실행 환경 내에서 또는 로컬 개발 환경에서 ansible-playbook 과 같은 익숙한 Ansible 명령을 사용하려면 자동화 콘텐츠 navigator와 함께 -m stdout 하위 명령을 사용합니다. 빠른 작업에 익숙한 명령을 사용할 수 있습니다.
Automation Content navigator는 이 모드에서도 광범위한 도움말을 제공합니다.
--help-
ansible-navigator명령 또는ansible-navigator config --help와 같은 하위 명령에서 액세스할 수 있습니다. - 하위 명령 help
-
하위 명령(예:
ansible-navigator config --help-config)에서 액세스할 수 있습니다. 이 도움말은 관련 Ansible 명령에서 지원되는 모든 매개변수의 세부 정보를 표시합니다.
1.2.2. 텍스트 기반 사용자 인터페이스 모드
텍스트 기반 사용자 인터페이스 모드에서는 자동화 실행 환경, 컬렉션, 플레이북, 인벤토리와의 상호 작용을 강화할 수 있습니다. 이 모드는 Visual Studio Code와 같은 IDE(통합 개발 환경)와 호환됩니다.
이 모드에는 몇 가지 유용한 사용자 인터페이스 옵션이 포함되어 있습니다.
- 콜론 명령
-
:run또는:collections와 같은 콜론을 사용하여 모든 Automation 콘텐츠 navigator 명령에 액세스할 수 있습니다. - 텍스트 기반 인터페이스 탐색
-
화면에 페이지 위 또는 아래로, 스크롤, 이전 화면으로 탈출 또는 액세스
:help를 보여줍니다. - 행 번호별 출력
-
콜론(예
: :12)을 사용하여 표시된 출력의 모든 줄 번호에 액세스할 수 있습니다. - 색상 코드 출력
- 색상이 활성화된 상태에서 Automation 콘텐츠 navigator는 더 이상 사용되지 않는 모듈과 같은 항목을 빨간색으로 표시합니다.
- 페이지 번호 및 스크롤
- 각 Automation 콘텐츠 탐색 화면 하단에 표시되는 옵션을 사용하여 페이지 위로 또는 스크롤하거나 이스케이프할 수 있습니다.
Automation 콘텐츠 navigator가 실행된 후에는 모드 간에 전환할 수 없습니다.
이 문서에서는 대부분의 절차에 대해 텍스트 기반 사용자 인터페이스 모드를 사용합니다.
2장. RHEL에 자동화 콘텐츠 탐색기 설치
컨텐츠 작성자는 RHEL(Red Hat Enterprise Linux) 8 이상에 자동화 컨텐츠 탐색기를 설치할 수 있습니다.
2.1. RPM에서 RHEL에 자동화 콘텐츠 탐색기 설치
RPM에서 RHEL(Red Hat Enterprise Linux)에 자동화 컨텐츠 탐색을 설치할 수 있습니다.
사전 요구 사항
- RHEL 8 이상이 설치되어 있어야 합니다.
- Red Hat Subscription Manager에 시스템을 등록하셨습니다.
절차
Red Hat Ansible Automation Platform SKU를 연결합니다.
$ subscription-manager attach --pool=<sku-pool-id>
RHEL 8용 리포지토리를 활성화합니다.
$ sudo subscription-manager repos --enable ansible-automation-platform-2.1-for-rhel-8-x86_64-rpms
자동화 콘텐츠 navigator를 설치합니다.
$ dnf install ansible-navigator
검증
Automation 콘텐츠 navigator 설치를 확인합니다.
$ ansible-navigator --help
다음 예제에서는 설치에 성공하는 방법을 보여줍니다.
3장. Automation 콘텐츠 탐색을 사용하여 자동화 실행 환경 검토
콘텐츠 개발자는 자동화 콘텐츠 탐색을 사용하여 자동화 실행 환경을 검토하고 자동화 실행 환경에 포함된 패키지 및 컬렉션을 표시할 수 있습니다. 자동화 콘텐츠 navigator는 플레이북을 실행하여 결과를 추출 및 표시합니다.
3.1. Automation 콘텐츠 탐색에서 자동화 실행 환경 검토
Automation 콘텐츠 navigator 텍스트 기반 사용자 인터페이스를 사용하여 자동화 실행 환경을 검토할 수 있습니다.
사전 요구 사항
- 자동화 실행 환경
절차
Automation 콘텐츠 탐색 구성에 포함된 자동화 실행 환경을 검토합니다.
$ ansible-navigator images
자세한 내용은 위임할 자동화 실행 환경 수를 입력합니다.
설치된 각 자동화 실행 환경의 패키지 및 버전과 포함된 컬렉션을 모두 검토할 수 있습니다.
선택 사항: 사용하려는 자동화 실행 환경을 전달합니다. 이는 기본이 되고 Automation 컨텐츠 navigator가 사용하는 자동화 실행 환경입니다.
$ ansible-navigator images --eei registry.example.com/example-enterprise-ee:latest
검증
자동화 실행 환경 출력을 검토합니다.
5장. 자동화 콘텐츠 navigator를 사용하여 컬렉션 검색
콘텐츠 작성자는 자동화 콘텐츠 탐색을 사용하여 Ansible 컬렉션을 탐색하고 로컬 또는 자동화 실행 환경 내에서 개발된 각 컬렉션을 대화식으로 탐색할 수 있습니다.
5.1. 자동화 콘텐츠 탐색 모음 표시
Automation Content navigator는 각 컬렉션에 대해 다음 세부 정보를 사용하여 컬렉션에 대한 정보를 표시합니다.
- SHADOWED
- 검색 순서에서 컬렉션의 추가 사본이 더 높으며 플레이북에서 해당 컬렉션을 선호함을 나타냅니다.
- 유형
-
는 자동화 실행 환경에 에 마운트된 자동화 실행 환경 또는 볼륨 컬렉션에
bind_mount로 포함되어 있는지 여부를 표시합니다. - PATH
- 컬렉션 TYPE 필드를 기반으로 자동화 실행 환경 또는 로컬 파일 시스템 내의 컬렉션 위치를 반영합니다.
5.2. 자동화 콘텐츠 탐색 navigator
대화형 모드에서 자동화 콘텐츠 탐색 텍스트 기반 사용자 인터페이스를 사용하여 Ansible 컬렉션을 검색하고 각 컬렉션을 조회할 수 있습니다. Automation Content navigator는 현재 프로젝트 디렉터리 내의 컬렉션과 자동화 실행 환경에서 사용 가능한 컬렉션을 보여줍니다.
사전 요구 사항
- 로컬에 액세스 가능한 수집 또는 설치된 자동화 실행 환경.
절차
자동화 콘텐츠 탐색 시작
$ ansible-navigator
컬렉션을 찾아봅니다. 또는
ansible-navigator 컬렉션을 입력하여 컬렉션을직접 검색할 수 있습니다.$ :collections
탐색할 컬렉션의 수를 입력합니다.
:4
delve할 모듈에 해당하는 번호를 입력합니다.
ANSIBLE.UTILS.IP_ADDRESS: Test if something in an IP address 0│--- 1│additional_information: {} 2│collection_info: 3│ authors: 4│ - Ansible Community 5│ dependencies: {} 6│ description: Ansible Collection with utilities to ease the management, manipulation, 7│ and validation of data within a playbook 8│ documentation: null 9│ homepage: null 10│ issues: null 11│ license: [] 12│ license_file: LICENSE 13│ name: ansible.utils 14│ namespace: ansible 15│ path:/usr/share/ansible/collections/ansible_collections/ansible/utils/ 16│ readme: README.md <... output truncated...>선택 사항: 이 모듈의 문서 예제로 이동합니다.
:{{ examples }} 0│ 1│ 2│#### Simple examples 3│ 4│- name: Check if 10.1.1.1 is a valid IP address 5│ ansible.builtin.set_fact: 6│ data: "{{ '10.1.1.1' is ansible.utils.ip_address }}" 7│ 8│# TASK [Check if 10.1.1.1 is a valid IP address] ********************* 9│# ok: [localhost] => { 10│# "ansible_facts": { 11│# "data": true 12│# }, 13│# "changed": false 14│# } 15│선택 사항: 편집기에서 예제를 열어 플레이북에 복사합니다.
:open
검증
컬렉션 목록을 찾습니다.
추가 리소스
5.3. Automation 콘텐츠 탐색에서 문서 검토
자동화 콘텐츠 navigator 텍스트 기반 사용자 인터페이스를 사용한 컬렉션 및 플러그인에 대한 Ansible 설명서를 대화형 모드에서 검토할 수 있습니다. Automation Content navigator는 현재 프로젝트 디렉터리 내의 컬렉션과 자동화 실행 환경에서 사용 가능한 컬렉션을 보여줍니다.
사전 요구 사항
- 로컬에 액세스 가능한 수집 또는 설치된 자동화 실행 환경.
절차
자동화 콘텐츠 탐색 시작
$ ansible-navigator
관심 있는 모듈을 검토합니다. 또는
ansible-navigator doc를 입력하여 문서에 액세스할 수 있습니다.:doc ansible.utils.ip_address
ANSIBLE.UTILS.IP_ADDRESS: Test if something in an IP address 0│--- 1│additional_information: {} 2│collection_info: 3│ authors: 4│ - Ansible Community 5│ dependencies: {} 6│ description: Ansible Collection with utilities to ease the management, manipulation, 7│ and validation of data within a playbook 8│ documentation: null 9│ homepage: null 10│ issues: null 11│ license: [] 12│ license_file: LICENSE 13│ name: ansible.utils 14│ namespace: ansible 15│ path:/usr/share/ansible/collections/ansible_collections/ansible/utils/ 16│ readme: README.md <... output truncated...>이 모듈에 대한 설명서 예제로 건너뜁니다.
:{{ examples }} 0│ 1│ 2│#### Simple examples 3│ 4│- name: Check if 10.1.1.1 is a valid IP address 5│ ansible.builtin.set_fact: 6│ data: "{{ '10.1.1.1' is ansible.utils.ip_address }}" 7│ 8│# TASK [Check if 10.1.1.1 is a valid IP address] ********************* 9│# ok: [localhost] => { 10│# "ansible_facts": { 11│# "data": true 12│# }, 13│# "changed": false 14│# } 15│선택 사항: 편집기에서 예제를 열어 플레이북에 복사합니다.
:open
편집기를 설정하는 방법에 대한 자세한 내용은 8.2절. “자동화 콘텐츠 탐색기 일반 설정” 을 참조하십시오.
추가 리소스
6장. 자동화 콘텐츠 navigator를 사용하여 Ansible 플레이북 실행
콘텐츠 작성자는 자동화 컨텐츠 navigator를 사용하여 Ansible 플레이북을 실행하고 대화식으로 각 플레이 및 작업의 결과를 수집하여 플레이북을 확인하거나 문제를 해결할 수 있습니다. 실행 환경 내에서 및 실행 환경 없이 Ansible 플레이북을 실행하여 문제를 비교하고 해결할 수도 있습니다.
6.1. 자동화 콘텐츠 navigator에서 플레이북 실행
자동화 콘텐츠 탐색 텍스트 기반 사용자 인터페이스를 사용하여 Ansible 플레이북을 실행하여 작업 실행을 따르고 각 작업의 결과를 확인할 수 있습니다.
사전 요구 사항
- 플레이북입니다.
-
localhost또는 인벤토리 플러그인을 사용하지 않는 경우 유효한 인벤토리 파일입니다.
절차
자동화 콘텐츠 탐색 시작
$ ansible-navigator
플레이북을 실행합니다.
$ :run
-
선택 사항:
ansible-navigator를 입력하여 simple-playbook.yml -i inventory.yml을 실행하여 플레이북을 실행합니다. 인벤토리 및 기타 명령줄 매개 변수를 확인하거나 추가합니다.
INVENTORY OR PLAYBOOK NOT FOUND, PLEASE CONFIRM THE FOLLOWING ───────────────────────────────────────────────────────────────────────── Path to playbook: /home/ansible-navigator_demo/simple_playbook.yml Inventory source: /home/ansible-navigator-demo/inventory.yml Additional command line parameters: Please provide a value (optional) ────────────────────────────────────────────────────────────────────────── Submit Cancel탭을 클릭하여
제출하고Enter를 누릅니다. 실행 중인 작업이 표시되어야 합니다.
플레이 옆에 있는 숫자를 입력하여 플레이 결과에 단계별로 입력하거나 9 위의 숫자에 대해
:<number>를 입력합니다.
Automation 콘텐츠 navigator에 색상이 활성화된 경우 실패한 작업이 빨간색으로 표시됩니다.
작업 결과를 검토하는 작업 옆에 숫자를 입력하거나 9 위의 숫자에 대해
:<number>를 입력합니다.
선택 사항: type
:doc은 문제 해결을 돕기 위해 작업에 사용된 모듈 또는 플러그인에 대한 문서를 표시합니다.ANSIBLE.BUILTIN.PACKAGE_FACTS (MODULE) 0│--- 1│doc: 2│ author: 3│ - Matthew Jones (@matburt) 4│ - Brian Coca (@bcoca) 5│ - Adam Miller (@maxamillion) 6│ collection: ansible.builtin 7│ description: 8│ - Return information about installed packages as facts. <... output omitted ...> 11│ module: package_facts 12│ notes: 13│ - Supports C(check_mode). 14│ options: 15│ manager: 16│ choices: 17│ - auto 18│ - rpm 19│ - apt 20│ - portage 21│ - pkg 22│ - pacman <... output truncated ...>
추가 리소스
6.2. Automation 콘텐츠 navigator 아티팩트 파일을 사용하여 플레이북 결과 검토
Automation Content navigator는 플레이북 실행 결과를 JSON 아티팩트 파일에 저장합니다. 이 파일을 사용하여 플레이북 결과를 다른 사용자와 공유하고, 보안 또는 규정 준수 이유로 저장하거나, 나중에 검토 및 문제를 해결할 수 있습니다. 플레이북 실행을 검토하려면 아티팩트 파일만 있으면 됩니다. 플레이북 자체 또는 인벤토리 액세스 권한에 액세스할 필요가 없습니다.
사전 요구 사항
- 플레이북 실행의 자동화 콘텐츠 navigator 아티팩트 JSON 파일
절차
아티팩트 파일을 사용하여 자동화 콘텐츠 탐색을 시작합니다.
$ ansible-navigator replay simple_playbook_artifact.json
플레이북이 실행될 때 일치하는 플레이북 결과를 검토합니다.
이제 플레이북을 실행한 후와 같이 결과를 검토하기 위해 플레이 및 작업 옆에 있는 숫자를 입력하여 결과를 검토할 수 있습니다.
추가 리소스
7장. 자동화 콘텐츠 탐색을 사용하여 Ansible 구성 검토
콘텐츠 작성자는 Automation 컨텐츠 navigator를 사용하여 Ansible 구성을 검토하고 대화식으로 설정을 확인할 수 있습니다.
7.1. Automation 콘텐츠 탐색에서 Ansible 구성 검토
대화형 모드에서 자동화 콘텐츠 탐색 텍스트 기반 사용자 인터페이스를 사용하여 Ansible 구성을 검토하고 설정을 확인할 수 있습니다. 자동화 콘텐츠 navigator는 액세스 가능한 Ansible 구성 파일의 결과를 가져오거나 구성 파일이 없는 경우 기본값을 반환합니다.
사전 요구 사항
- 추가 자동화 실행 환경에 액세스해야 하는 경우 Red Hat 레지스트리에 인증했습니다. 자세한 내용은 Red Hat Container Registry 인증을 참조하십시오.
절차
자동화 콘텐츠 탐색 시작
$ ansible-navigator
선택 사항: 명령줄에서
ansible-navigator config를 입력하여 Ansible 구성 설정에 액세스합니다.Ansible 구성을 검토합니다.
:config
일부 값은 자동화 실행 환경이 작동하는 데 필요한 자동화 실행 환경 내에서 설정을 반영합니다. 이러한 설정은 기본이 아닌 설정으로 표시됩니다. Ansible 구성 파일에 설정할 수 없습니다.
delve에 해당하는 설정에 해당하는 숫자를 입력하거나 9보다 큰 숫자의 경우
:<number>를 입력합니다.ANSIBLE COW ACCEPTLIST (current: ['bud-frogs', 'bunny', 'cheese']) (default: 0│--- 1│current: 2│- bud-frogs 3│- bunny 4│- cheese 5│default: 6│- bud-frogs 7│- bunny 8│- cheese 9│- daemon
출력에는 현재 설정과 기본값 이 표시됩니다. 이 예제의 소스는 설정이 자동화 실행 환경에서 제공되므로 env 입니다.
검증
구성 출력을 검토합니다.
추가 리소스
9장. 자동화 콘텐츠 navigator를 사용하여 Ansible 콘텐츠 문제 해결
콘텐츠 작성자는 자동화 콘텐츠 navigator를 사용하여 Ansible 콘텐츠(컬렉션, 자동화 실행 환경 및 플레이북)의 문제를 해결하고 플레이북을 대화식으로 해결할 수 있습니다. 자동화 실행 환경 내부 또는 외부 결과를 비교하고 문제를 해결할 수도 있습니다.
9.1. Automation 콘텐츠 navigator 아티팩트 파일을 사용하여 플레이북 결과 검토
Automation Content navigator는 플레이북 실행 결과를 JSON 아티팩트 파일에 저장합니다. 이 파일을 사용하여 플레이북 결과를 다른 사용자와 공유하고, 보안 또는 규정 준수 이유로 저장하거나, 나중에 검토 및 문제를 해결할 수 있습니다. 플레이북 실행을 검토하려면 아티팩트 파일만 있으면 됩니다. 플레이북 자체 또는 인벤토리 액세스 권한에 액세스할 필요가 없습니다.
사전 요구 사항
- 플레이북 실행의 자동화 콘텐츠 navigator 아티팩트 JSON 파일
절차
아티팩트 파일을 사용하여 자동화 콘텐츠 탐색을 시작합니다.
$ ansible-navigator replay simple_playbook_artifact.json
플레이북이 실행될 때 일치하는 플레이북 결과를 검토합니다.
이제 플레이북을 실행한 후와 같이 결과를 검토하기 위해 플레이 및 작업 옆에 있는 숫자를 입력하여 결과를 검토할 수 있습니다.
추가 리소스
