시나리오 생성 및 테스트

시나리오 생성

Monitoring Flow에서 시나리오 활용하여 시나리오 스텝(워크플로우)을 만들 수 있습니다. 신규 시나리오를 생성하는 방법은 다음과 같습니다.

안내

시나리오 생성 시, 연결된 플로우 커넥션은 수정할 수 없습니다.

Monitoring Flow에서 워크플로우를 동작하기 위한 시나리오를 생성합니다.

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
[시나리오 생성] 버튼을 클릭한 후, 시나리오 생성 화면으로 이동합니다.

시나리오 생성에 필요한 정보를 입력 후 [생성] 버튼을 클릭합니다.

플로우 커넥션 선택 후, 플로우 커넥션에 연결된 서브넷을 확인할 수 있습니다. 연결된 서브넷은 플로우 커넥션 상세 화면에서 수정할 수 있습니다.

항목	설명
시나리오 이름	같은 프로젝트 내에서 중복된 시나리오 이름은 사용 불가
플로우 커넥션	플로우 커넥션에 등록된 VPC만 선택 가능, 1개의 플로우 커넥션만 선택 가능 - 한 개의 플로우 커넥션은 여러 개의 시나리오를 가질 수 있음 - 카카오클라우드 내부 리소스에 접근하기 위해서는 플로우 커넥션을 선택해야 하며, 플로우 커넥션 없이도 시나리오를 생성 가능
서브넷	상위 선택한 플로우 커넥션에 연결된 서브넷만 확인 가능 - 연결된 서브넷의 수정은 플로우 커넥션의 서브넷 연결 관리를 참고
스케줄	시나리오를 실행할 스케줄 설정 - 정상적인 시나리오 스텝 동작을 위해 반드시 스케줄 설정이 필요

시나리오 스텝 유형

시나리오를 구성하는 각 5개의 스텝들(API, Set Variables, For, If, Sleep)을 조합하여 하나의 시나리오를 완성할 수 있습니다. 시나리오 스텝은 시나리오를 구성하는 워크플로우로, 시나리오 스텝을 저장해야 시나리오가 정상적으로 동작합니다.

용어 정리

스텝: 시나리오를 구성하는 단계이며, 각 스텝을 정의하고 조합하여 다양한 시나리오를 생성할 수 있습니다.
시나리오: 카카오클라우드에서 워크플로우를 의미하는 용어이며, 모니터링을 효율적으로 수행하기 위해 정의된 스텝들을 스케줄에 맞춰 자동화하는 프로세스 입니다.
Variable: 사용자가 설정한 변수를 의미하는 용어이며, 워크플로우 내에서 공통으로 접근할 수 있습니다.

시나리오 스텝 유형은 다음과 같습니다.

항목	설명
API	호출할 API를 지정하는 스텝
Set Variables	Variables 값을 설정하는 스텝 - Variable은 시나리오 동작 시 공통으로 접근할 수 있는 변수입니다. - 우선 Default Variable을 생성한 후, Set Variables 스텝에서 Variable을 선택 가능
For	반복 조건을 설정하는 스텝 - 단순 반복과 JSON List의 요소에 대하여 반복하며, 최대 반복 횟수는 1,000회로 제한 - Marker는 Variable 결과에서 현재 위치를 표시
If	비교 연산자를 활용한 조건을 설정하는 스텝
Sleep	프로세스를 일시적으로 멈추기 위해 정지 시간을 설정하는 스텝 - 최대 5분 이내로 설정 가능

시나리오 스텝 추가

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
시나리오 메뉴에서 이름 클릭하여 시나리오 상세 화면으로 이동합니다.
세부 정보 탭으로 이동 후, 하단의 [시나리오 스텝 추가] 버튼을 클릭합니다.
시나리오 스텝 편집 화면의 우측 패널에서 시나리오 스텝을 추가합니다.

안내

시나리오를 구성하는 스텝의 필수 항목이 모두 입력되지 않는 경우, 해당 스텝에 경고 아이콘이 표시됩니다.
필수 항목을 미입력 시, 시나리오 스텝을 저장할 수 없습니다. 반드시 필수 항목을 입력해 주세요.
특정 스텝 구성 시, 사전에 Default Variable을 반드시 등록해야 합니다.

Default Variable 관리

Default Variable의 개수와 정보 등을 변경할 수 있습니다. 텝을 생성하기 전에 Default Variable을 먼저 등록해야 합니다.

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
시나리오 > [더 보기] > 시나리오 스텝 편집을 클릭합니다.
우측 상단의 [Default Variable 관리] 버튼을 클릭하여, Default Variable을 등록(최대 20)합니다.
Key, Type, Value를 입력하여 저장합니다.

항목 설명
Key Variable의 Key값 입력
Type Variable의 유형 선택
- String, Integer, JSON List, Json Map 총 4가지 중 선택
Value 선택한 Type에 맞는 Variable의 기본값 입력

항목	설명
Key	Variable의 Key값 입력
Type	Variable의 유형 선택 - String, Integer, JSON List, Json Map 총 4가지 중 선택
Value	선택한 Type에 맞는 Variable의 기본값 입력

주의

다른 스텝에 저장된 정보가 있는 Default Variable은 수정 및 삭제할 수 없습니다. 반드시 해당 스텝에서 해당 정보를 삭제 후 시도해 주세요.

API 스텝 설정

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
시나리오 > [더 보기] > 시나리오 스텝 편집을 클릭합니다.
우측의 새 스텝 설정에서 스텝 유형으로 API를 선택합니다.

API 설정에 필요한 정보를 입력합니다.

항목	구분	설명
유형		`API` 선택
스텝 이름		스텝에 설정할 이름 - 같은 시나리오 내에서 중복된 이름은 사용 불가
Expected code		입력한 URL의 예상 Status Code를 입력 - 미입력 시 `200` 으로 자동 설정
Method		API 요청 방법 선택
URL		접근하는 API의 URL 입력 - URL에 변수 입력 가능 (예: `${IP}` → 12.34.56.78, http://`${IP}` → http://`12.34.56.78` 값으로 치환되어 설정)
Parameters		Parameters 정보 입력 - 최대 10개의 parameter 저장 가능
	Key	Parameters Key 입력 - 동일한 Key를 여러 개 저장할 수 없음
	Value	Parameters Value 입력 - 변수 입력 가능
Headers		Headers Key/Value 입력 - 최대 10개의 parameter를 저장 가능
	Key	Headers Key 입력 - 동일한 Key를 여러 개 저장할 수 없음
	Value	Headers Value 입력 - Value에 변수 입력 가능
Body		Body 값 입력 - 변수 입력 가능 - 하단의 Body 예시를 참고

{
   "name": "kakaocloud",
   "org": {
      "name": "kakaocloud"
   }
}

필수 항목을 모두 입력한 후에 추가 스텝이 필요한 경우, 좌측 패널의 다음 스텝 추가를 클릭합니다.
- API 스텝 단독으로도 사용이 가능합니다.
- API 스텝에는 하위 스텝을 추가할 수 없습니다.
- API 스텝을 삭제하려면, 다른 스텝에 해당 API 정보가 저장되어 있지 않아야 합니다. 다른 스텝에 삭제하려는 대상의 API의 정보가 저장되어 있는 경우, 반드시 해당 스텝에 저장된 정보를 삭제해야 API 스텝을 삭제할 수 있습니다.
안내
대상 목적지의 방화벽에서 해당 IP를 허용해야 합니다.
- IP 61.109.236.21

Set Variables 스텝 설정

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
시나리오 > [더 보기] > 시나리오 스텝 편집을 클릭합니다.

우측 패널의 새 스텝 설정의 유형을 Set Variables로 선택 후, 각 항목을 설정합니다.

항목	구분	설명
유형		`Set Variables` 선택
스텝 이름		스텝에 설정할 이름 - 같은 시나리오 내에서 중복된 이름은 사용 불가
Parameters		아래의 파라미터 항목들을 입력 - 최대 5개의 parameter를 저장 가능
	Variable	Default Variable에 저장된 목록 중 1개를 선택 - 해당 스텝에 이미 저장된 Variable은 다시 선택할 수 없음 - 저장된 Variable이 없는 경우, Default Variable에서 추가
	Step	상위 스텝에서 저장된 API 스텝 중 1개를 선택 - 상위 스텝에 API가 없는 경우, API 스텝 설정에서 생성 필요
	요청/응답	response,request 중 1개를 선택
	구성 요소	request, response 선택 값에 따라 parameters, headers, body를 선택
	Key	상위에 선택한 요청/응답 결과의 값을 입력 또는 선택

[저장] 버튼을 클릭합니다.

For 스텝 설정

안내

For 스텝에는 다음 스텝을 추가할 수 없습니다.
For 스텝은 반드시 하위 스텝을 가져야 합니다.
For 스텝이 하위 스텝인 경우, 다음 스텝 또는 하위 스텝을 추가할 수 없습니다.
- (예시) IF 스텝의 하위 스텝으로 For 스텝이 추가되면, IF 스텝을 다음/하위 스텝에 추가할 수 없습니다.
1 Depth 2 Depth 3 Depth
API
If
For
If 다음 스텝 추가 불가 If 하위 스텝 추가 불가 API

1 Depth	2 Depth	3 Depth
API
If
	For
If 다음 스텝 추가 불가	If 하위 스텝 추가 불가	API

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
시나리오 > [더 보기] > 시나리오 스텝 편집을 클릭합니다.

우측 패널의 새 스텝 설정의 유형을 For로 선택 후, 각 항목을 설정합니다.

항목	구분	설명
유형		`For` 선택
스텝 이름		스텝에 설정할 이름 - 같은 시나리오 내에서 중복된 이름은 사용 불가
상태		유형에 맞게 조건을 입력
Type		count, foreach 중 1개를 선택
	Count	반복 횟수를 최대 1,000회 이내로 입력 - For 스텝의 단순 반복 횟수를 입력(1~1,000)
	Foreach	Base Variable을 선택 - Default Variable에서 Json List를 선택하며, Json List 형태의 다수의 데이터를 반복 실행 - Default Variable에 저장된 목록 중 1개를 선택 - JSON List만 선택 가능
Continue on Error		해당 조건의 오류 시, 계속 반복하여 실행할지 여부를 설정 - 설정 시, 해당 For 스텝에서 오류가 발생하더라도 계속 실행됨
Marker		선택한 Variable 결과에서 현재 위치이며, marker를 이용하여 설정한 위치에서 데이터를 읽을 수 있도록 설정 - 최대 5개의 Marker Value 저장 가능
	Marker Variable	Default Variable에 저장된 목록 중 1개를 선택 - 해당 항목에 이미 저장된 Variable을 다시 선택 가능
	Marker Value	데이터를 읽기 위한 위치에 대한 값을 입력 - `marker`로 시작

안내

Marker Value는 선택된 Variable 결과에서 현재 위치를 나타내며 해당 위치에서 데이터를 읽는 문법으로, 예시는 다음과 같습니다.

항목	예시
Default Variable	- key : name / type : string - key : age / type : integer
Marker Variable	- `${name}` - `${age}`
Marker Value	- marker.name - marker.age
입력 결과	- `${name}` = “kakao”, “john” - `${age}` = 10, 20

For 스텝의 필수 항목을 모두 입력한 후, 좌측 패널에서 [하위 스텝 추가] 버튼을 클릭하여 하위 스텝을 추가합니다.
- For 스텝은 다음 스텝을 가질 수 없으며, 반드시 하위 스텝을 가져야 합니다.

If 스텝 설정

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
시나리오 > [더 보기] > 시나리오 스텝 편집을 클릭합니다.

우측 패널의 새 스텝 설정의 유형을 If로 선택 후, 각 항목을 설정합니다.

항목	구분	설명
유형		`If` 선택
스텝 이름		스텝에 설정할 이름 - 같은 시나리오 내에서 중복된 이름은 사용 불가
Condition		유형에 맞게 조건을 입력 - 특정 조건이 참일 때, 번호 순서대로 If 스텝의 condition이 실행됨
	Logical	and와 or 함수 중 1개 선택 - 1개 이상의 조건이 저장된 경우에만 선택 가능
	Left Operand	연산에 사용하는 대상 조건 입력 - 변수 입력 가능
	Comparison	Operand를 비교하기 위한 비교 연산자 선택
	Right Operand	기준값 입력 - 변수 입력 가능

If 스텝의 필수 항목을 모두 입력한 후, 좌측 패널의 다음 스텝 또는 하위 스텝을 추가합니다.
- If 스텝은 반드시 하위 스텝을 가져야 합니다.

Sleep 스텝 설정

카카오클라우드 콘솔 > Management > Monitoring Flow > 시나리오 메뉴로 이동합니다.
시나리오 > [더 보기] > 시나리오 스텝 편집을 클릭합니다.
우측 패널의 새 스텝 설정의 유형을 Sleep으로 선택 후, 각 항목을 설정합니다.

항목 설명
유형 Sleep 선택
스텝 이름 스텝에 설정할 이름
- 같은 시나리오 내에서 중복된 이름은 사용 불가
슬립 시간 슬립을 실행할 시간을 입력
- 최대 5분
Sleep 스텝의 필수 항목을 모두 입력한 후, 좌측 패널의 다음 스텝 또는 하위 스텝을 추가합니다.

항목	설명
유형	Sleep 선택
스텝 이름	스텝에 설정할 이름 - 같은 시나리오 내에서 중복된 이름은 사용 불가
슬립 시간	슬립을 실행할 시간을 입력 - 최대 5분

시나리오 스텝 테스트 실행 및 결과 확인

시나리오 스텝의 필수 항목을 모두 입력한 후에 우측 상단의 [테스트] 버튼을 실행하고 테스트 실행 결과를 확인합니다.
- 테스트 실행 결과 화면은 실제 시나리오 실행 결과와 동일합니다.
- 스텝별 오류 항목이 있는 경우, 우측 패널 하단에서 오류 상세 정보를 확인해 주세요.
테스트 실행 결과 이후 또는 이전에 시나리오를 반드시 저장해 주세요.
주의
- 테스트 실행 이후에 수정이 없어도 저장하지 않으면, 이전에 생성해 놓은 스텝이 사라집니다.
- 저장하지 않은 시나리오 스텝은 복구할 수 없습니다.
저장된 시나리오 스텝은 시나리오에 설정된 스케줄에 맞춰 실행됩니다.
- 시나리오는 저장 즉시 실행되지는 않으며, 일정 시간이 소요됩니다.