워크플로우 관리
이 페이지의 명령은 Agent v0.2.0부터 제공돼요.
Agent v0.1.0을 사용 중이면 업데이트를 참고해 먼저 업데이트해주세요.
Agent 호스트의 워크플로우 파일은 deplite-agent 명령으로 확인하고 만들고 고칠 수 있어요.
저장하기 전에 항상 검사를 거치므로 깨진 YAML이 워크플로우 디렉토리에 들어가지 않아요.
실행 중인 Agent는 재시작 없이 변경을 반영해요.
| 명령 | 설명 |
|---|---|
list | Agent가 인식한 워크플로우와 파일 위치를 보여줘요. |
add | 새 워크플로우를 편집기로 작성해요. |
edit | 기존 워크플로우를 편집기로 고쳐요. |
cp | 워크플로우를 새 이름으로 복사해요. copy로도 실행할 수 있어요. |
delete | 워크플로우 파일을 삭제해요. rm으로도 실행할 수 있어요. |
워크플로우 YAML 형식은 워크플로우 YAML을 참고해주세요.
sudo로 실행하기
systemd 서비스로 설치한 Agent는 root의 워크플로우 디렉토리(/root/.config/deplite-agent/workflows)를 사용해요.
따라서 워크플로우 관리 명령도 sudo로 실행해주세요.
sudo deplite-agent listsudo 없이 실행해 서비스와 다른 디렉토리를 보고 있으면 list는 서비스가 사용하는 디렉토리를 안내해요.
쓰기 명령인 add, edit, cp, delete는 이 경우 실행을 거부해요.
다른 디렉토리를 직접 다루려면 --workflows-dir DIR을 지정해주세요.
--workflows-dir나 DEPLITE_WORKFLOWS_DIR, DEPLITE_DATA_DIR로 경로를 지정하면 이 확인은 생략돼요.
list
Agent가 인식한 워크플로우를 보여줘요.
콘솔에 보고되는 목록과 같아서 워크플로우가 콘솔에 표시되지 않을 때 확인할 수 있어요.
deplite-agent list [--workflows-dir DIR] [--json]$ sudo deplite-agent list
워크플로우 디렉토리: /root/.config/deplite-agent/workflows
이름 버전 스텝 파라미터 시크릿 외부 호출 승인 방식 파일
hello - 1 - - 불가 - hello.yml표 위에는 워크플로우 디렉토리의 절대경로가 표시돼요.
마지막 파일 열은 워크플로우 디렉토리 기준 파일 경로예요.
파라미터 열에서 *가 붙은 이름은 필수 파라미터예요.
외부 호출 열은 on: webhook 선언 여부를 보여주며, 호출을 허용한 ref가 있으면 ref 목록을 표시해요.
읽지 못한 파일이 있으면 표 아래에 파일 경로가 표시돼요.
이런 파일은 deplite-agent validate로 원인을 확인하고, 표시된 파일 경로로 deplite-agent edit <파일>을 실행해 고쳐주세요.
이름이 겹쳐 무효가 된 워크플로우는 표에서 빠지고, 표 아래 별도 구역에 이름과 파일 경로가 표시돼요.
자세한 내용은 같은 이름의 워크플로우를 참고해주세요.
읽지 못한 파일이나 이름이 중복된 파일이 있으면 종료 코드 1로 끝나요.
--json을 지정하면 각 항목에 파일의 절대경로가 path 필드로 추가돼요.
이름이 겹쳐 무효가 된 워크플로우는 --json 결과에 포함되지 않아요.
add
새 워크플로우를 편집기로 작성해요.
deplite-agent add <이름> [--workflows-dir DIR] [--editor CMD]| 옵션 | 설명 |
|---|---|
--workflows-dir | 워크플로우 디렉토리예요. 기본값은 <data-dir>/workflows예요. |
--editor | 사용할 편집기예요. 생략하면 편집기 선택 순서로 정해요. |
명령을 실행하면 name이 채워진 템플릿이 편집기로 열려요.
저장하고 편집기를 닫으면 내용을 검사하고, 통과했을 때만 워크플로우 디렉토리에 <이름>.yml로 저장해요.
name: hello
description: ""
steps:
- name: hello
run: |
echo "hello"이름은 영문, 숫자, _, ., -로 1~128자까지 사용할 수 있어요.
name 값은 명령에 지정한 이름과 같아야 해요.
같은 이름의 워크플로우나 <이름>.yml, <이름>.yaml 파일이 이미 있으면 만들지 않아요.
템플릿을 고치지 않고 닫거나 내용을 모두 지우면 워크플로우를 만들지 않아요.
검사에 실패하면 오류와 함께 다시 편집할까요? [Y/n]를 물어봐요.
Enter나 y를 입력하면 작성하던 내용으로 편집기가 다시 열려요.
n을 입력하면 저장하지 않고, 작성한 내용이 든 임시 파일 경로를 알려줘요.
편집기를 사용하므로 터미널에서 실행해주세요.
edit
기존 워크플로우를 편집기로 고쳐요.
deplite-agent edit <이름|파일> [--workflows-dir DIR] [--editor CMD]| 옵션 | 설명 |
|---|---|
--workflows-dir | 워크플로우 디렉토리예요. 기본값은 <data-dir>/workflows예요. |
--editor | 사용할 편집기예요. 생략하면 편집기 선택 순서로 정해요. |
add와 같은 흐름으로 동작해요.
편집기를 닫으면 검사하고, 통과했을 때만 원래 파일에 반영해요.
검사에 실패하면 다시 편집할지 물어보고, 거절하면 작성한 내용이 든 임시 파일 경로를 알려줘요.
내용을 바꾸지 않고 닫으면 변경 사항이 없습니다.를 출력하고 끝나요.
워크플로우는 이름으로 지정하거나, 워크플로우 디렉토리 기준 파일 경로로 지정할 수 있어요.
YAML 오류 등으로 읽지 못한 파일은 이름을 알 수 없으므로 list에 표시된 파일 경로로 열어주세요.
이름이 겹쳐 무효가 된 파일도 이름으로는 열 수 없으므로 파일 경로로 지정해주세요.
sudo deplite-agent edit hello
sudo deplite-agent edit broken.ymlname은 바꿀 수 없어요.
이름을 바꾸려면 cp로 새 이름의 워크플로우를 만든 뒤 원래 워크플로우를 delete해주세요.
단, 읽지 못한 파일이나 이름이 겹쳐 무효가 된 파일을 파일 경로로 열었을 때는 name을 바꿔 저장할 수 있어요.
편집하는 동안 다른 곳에서 같은 파일이 바뀌면 덮어쓰지 않고, 작성한 내용이 든 임시 파일 경로를 알려줘요.
cp
워크플로우를 새 이름으로 복사해요.
deplite-agent cp <원본_이름> <새_이름> [--workflows-dir DIR] [--edit] [--editor CMD]| 옵션 | 설명 |
|---|---|
--workflows-dir | 워크플로우 디렉토리예요. 기본값은 <data-dir>/workflows예요. |
--edit | 저장하기 전에 복사한 내용을 편집기로 열어요. |
--editor | 사용할 편집기예요. 지정하면 --edit 없이도 편집기로 열어요. |
name만 새 이름으로 바꾸고 주석과 형식을 포함한 나머지 내용은 그대로 두어요.
복사본은 워크플로우 디렉토리에 <새_이름>.yml로 저장되고, 원본 파일의 권한을 그대로 따라요.
--edit을 지정하면 저장하기 전에 편집기로 열리고, add와 같은 방식으로 검사해요.
원본과 같은 이름의 워크플로우가 여러 개면 중복을 먼저 정리해주세요.
sudo deplite-agent cp deploy deploy-staging --editdelete
워크플로우 파일을 삭제해요.
deplite-agent delete <이름|파일> [--workflows-dir DIR] [--yes]| 옵션 | 설명 |
|---|---|
--workflows-dir | 워크플로우 디렉토리예요. 기본값은 <data-dir>/workflows예요. |
--yes | 확인 질문 없이 삭제해요. |
삭제하기 전에 [y/N]로 확인을 받아요.
y를 입력해야 삭제되고, 그 외의 입력은 삭제하지 않고 종료 코드 1로 끝나요.
워크플로우는 이름이나 워크플로우 디렉토리 기준 파일 경로로 지정할 수 있어요.
대상이 심볼릭 링크이면 링크만 삭제하고 원본 파일은 그대로 두어요.
편집기 선택
add, edit, cp --edit이 사용할 편집기는 다음 순서로 정해요.
--editor옵션VISUAL환경변수EDITOR환경변수editor,nano,vim,vi중 설치된 첫 번째 편집기
--editor에 지정한 편집기를 찾지 못하면 다른 편집기로 넘어가지 않고 오류로 끝나요.
sudo는 보통 EDITOR 환경변수를 넘기지 않으므로, 원하는 편집기가 있으면 --editor로 지정해주세요.
sudo deplite-agent add hello --editor nano편집기 이름 뒤에 인자를 함께 지정할 수도 있어요.
sudo deplite-agent edit hello --editor "code --wait"같은 이름의 워크플로우
워크플로우는 YAML의 name으로 구분해요.
같은 name을 가진 파일이 둘 이상이면 그 이름의 파일 전부가 무효가 되어 실행되지 않아요.
콘솔에는 무효 배지와 사유, 해결 방법이 표시되고 실행 버튼이 비활성화돼요.
이름 기반 실행 API는 409 workflow_invalid로 거절하고, 토큰의 워크플로우 목록 조회에서도 빠져요.
list는 무효가 된 워크플로우를 표 아래 별도 구역에 보여주고 종료 코드 1로 끝나요.
$ sudo deplite-agent list
워크플로우 디렉토리: /root/.config/deplite-agent/workflows
이름 버전 스텝 파라미터 시크릿 외부 호출 승인 방식 파일
unique - 1 - - 불가 - unique.yml
이름이 겹쳐 무효가 된 워크플로우 1개 (파일을 하나만 남겨주세요)
hello: hello.yml, team/hello.ymlvalidate는 이름이 겹친 파일마다 오류와 사유를 보여줘요.
$ sudo deplite-agent validate
OK unique (unique.yml)
FAIL hello.yml
workflow "hello": name is defined in 2 files (hello.yml, team/hello.yml)
FAIL team/hello.yml
workflow "hello": name is defined in 2 files (hello.yml, team/hello.yml)
정상 1개, 오류 2개무효가 된 워크플로우를 run으로 실행하면 사유와 파일 목록을 보여주고 실행하지 않아요.
파일을 하나만 남기면 바로 해소돼요.
이름이 겹친 동안에는 이름으로 edit, delete, cp, add를 실행하면 파일 목록과 함께 거부돼요.
필요 없는 파일은 파일 경로로 지정해 delete하고, 둘 다 필요하면 한쪽을 파일 경로로 edit해 name을 바꿔주세요.
# 필요 없는 파일 삭제
sudo deplite-agent delete team/hello.yml
# 또는 한쪽 파일의 name 변경
sudo deplite-agent edit team/hello.ymladd, edit, cp는 저장하기 전에 같은 이름의 워크플로우가 있는지 확인하므로 새 중복을 만들지 않아요.
디렉토리 구성
워크플로우 디렉토리 아래 하위 디렉토리에 둔 .yml, .yaml 파일도 워크플로우로 인식해요.
하위 디렉토리 안의 파일 변경도 실행 중인 Agent에 바로 반영돼요.
add와 cp는 새 파일을 항상 워크플로우 디렉토리 바로 아래에 만들어요.
워크플로우 디렉토리 자체는 심볼릭 링크로 둘 수 있고, 링크가 가리키는 디렉토리의 파일 변경도 바로 반영돼요.
디렉토리 안에 있는 심볼릭 링크 디렉토리는 순환을 막기 위해 따라가지 않으므로, 그 안의 파일은 인식되지 않아요.