확장 가능한 이름 지정, 주석 및 스타일
프로젝트를 읽기 쉽게 유지하는 규칙을 익힙니다.
확장 가능한 이름 지정, 주석 및 스타일은(는) CoddyKit의 무료 DevOps Bootcamp 강의입니다. 이것은 4개 중 4번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 DevOps Bootcamp 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. DevOps Bootcamp 강의에는 총 4개의 강의가 포함되어 있습니다.
스타일은 선택 사항이 아닙니다
플레이북은 작성하는 횟수보다 읽는 횟수가 훨씬 많습니다. 일관된 이름 지정과 스타일이 개인 스크립트를 팀에서 사용할 수 있는 자동화로 바꿉니다. ✨
작업에는 항상 이름을 지정하십시오
모든 작업에 명확한 이름을 지정하십시오. 이름이 있는 작업은 실행 결과를 읽기 쉽게 만들고, 동료에게 의도를 한눈에 알려 줍니다.
- name: Install the nginx web server
package:
name: nginx
state: present이름은 동작으로 작성하십시오
nginx 설치 또는 배포 사용자 생성처럼 이름을 명확한 동작으로 표현하십시오. 플레이가 실행될 때 체크리스트처럼 읽힙니다.
네이티브 모듈을 우선 사용하십시오
셸이나 command 모듈보다 실제 모듈을 우선 사용하십시오. 모듈은 멱등적이고 자체적으로 의미를 설명하지만, 원시 명령은 그렇지 않습니다.
key=value 대신 YAML을 사용하십시오
모듈 인수는 모든 내용을 한 줄의 문자열에 욱여넣기보다, 줄마다 키 하나를 작성하는 명확한 YAML 블록 스타일로 작성하십시오.
- name: Ensure dir exists
file:
path: /opt/app
state: directory주석은 이유를 설명합니다
무엇을 하는지가 아니라 왜 하는지를 설명하려면 # 주석을 사용하십시오. 작업 이름이 이미 무엇을 하는지 알려 주므로, 주석에는 이유나 주의할 점을 기록합니다.
# Pin version: 1.20 broke our TLS config
- name: Install nginx 1.18
package:
name: nginx=1.18*일관된 변수 이름
변수는 소문자 snake_case로 이름을 지정하고, 충돌을 피하기 위해 역할 변수를 역할 이름으로 접두사 처리하십시오. 예를 들어 nginx_port처럼 작성합니다.
확신이 없으면 따옴표를 사용하십시오
{{로 시작하는 값이나 숫자 또는 불리언으로 해석될 수 있는 값에는 따옴표를 사용하십시오. 그러면 YAML이 형식을 잘못 추측하지 않습니다.
msg: "{{ greeting }}"
version: "1.10"두 칸 들여쓰기
각 수준마다 두 칸을 사용하고 탭은 절대 사용하지 마십시오. YAML은 공백에 민감하므로 들여쓰기를 섞으면 해석이 깨집니다.
ansible-lint로 적용하십시오
ansible-lint를 실행해 스타일과 모범 사례 문제를 자동으로 찾으십시오. 도구가 규칙 준수를 점검하게 하면 검토에서는 로직에 집중할 수 있습니다.
ansible-lint site.yml작고 집중된 파일
각 파일이 한 가지 역할만 하도록 하십시오. 짧고 이름이 명확한 작업 파일이 방대한 파일보다 테스트하고, 재사용하고, 이해하기 쉽습니다. 🎯
빠른 확인
모든 작업에 이름을 추가하는 주된 이유는 무엇인가요?
복습
모든 작업에 이름을 지정하고, 셸보다 모듈을 우선하며, 명확한 YAML을 작성하고, 이유를 주석으로 설명하며, ansible-lint로 스타일을 적용하는 방법을 배웠습니다. ✅
자주 묻는 질문
“확장 가능한 이름 지정, 주석 및 스타일” 강의는 무료인가요?
네 — “확장 가능한 이름 지정, 주석 및 스타일” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 DevOps Bootcamp 강의 전체를 잠금 해제할 수 있습니다. DevOps Bootcamp 강의에는 총 4개의 강의가 포함되어 있습니다.
“확장 가능한 이름 지정, 주석 및 스타일”에서 뭘 배우나요?
프로젝트를 읽기 쉽게 유지하는 규칙을 익힙니다. 브라우저에서 직접 실행하는 실습 코드로 DevOps Bootcamp을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
DevOps Bootcamp을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 DevOps Bootcamp은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 4번째 강의입니다.
“확장 가능한 이름 지정, 주석 및 스타일” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 DevOps Bootcamp 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 DevOps Bootcamp 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.
이 강의의 모든 강의
- 권장 디렉터리 배치
- group_vars 및 host_vars 디렉터리
- import 및 include로 플레이북 분할하기
- 확장 가능한 이름 지정, 주석 및 스타일