GITBOOK-32: No subject

SUMMARY.md

@@ -3,63 +3,62 @@
 ## APIM
 
 * [문의하기](README.md)
-* [APIM 톺아보기](<README (1).md>)
+* [APIM 톺아보기](apim/start-apim.md)
 
-## 사용자 관리콘솔
+## 사용자 관리콘솔 <a href="#tmc" id="tmc"></a>
 
-* [사용자 관리 콘솔이란?](undefined/undefined.md)
-* [시스템 사용자 관리(SSO 통합하기)](undefined/sso.md)
-* [시스템 사용자 관리(권한 및 상세 편집과 삭제)](undefined/undefined-1.md)
-* [프로젝트 관리](undefined/undefined-2.md)
-* [프로젝트 생성하기](undefined/undefined-3.md)
-* [프로젝트 상세(프로젝트 사용자 관리)](undefined/undefined-4.md)
+* [사용자 관리 콘솔이란?](tmc/tenant-manager-console.md)
+* [시스템 사용자 관리(SSO 통합하기)](tmc/tenant-manager-sso.md)
+* [시스템 사용자 관리(권한 및 상세 편집과 삭제)](tmc/tenant-manage.md)
+* [프로젝트 관리](tmc/project-manage.md)
+* [프로젝트 생성하기](tmc/project-create.md)
+* [프로젝트 상세(프로젝트 사용자 관리)](tmc/project-detail.md)
 
-## APIM 콘솔
+## APIM 콘솔 <a href="#apim-console" id="apim-console"></a>
 
-* [APIM 콘솔이란?](apim-1/apim.md)
-* [APIM 관리](apim-1/apim-1/README.md)
-  * [API 기본 정책](apim-1/apim-1/api.md)
-  * [API KEY](apim-1/apim-1/api-key.md)
-  * [JWT](apim-1/apim-1/jwt.md)
-  * [Docker Registry Secret](apim-1/apim-1/docker-registry-secret.md)
-  * [AWS Credentials](apim-1/apim-1/aws-credentials.md)
-  * [설정](apim-1/apim-1/undefined.md)
-* [Gateway 관리](apim-1/gateway/README.md)
-  * [게이트웨이 생성](apim-1/gateway/undefined.md)
-  * [Gateway 정보](apim-1/gateway/gateway.md)
-  * [Gateway URL 정보](apim-1/gateway/gateway-url.md)
-* [API 관리](apim-1/api/README.md)
-  * [API 생성](apim-1/api/api.md)
-  * [API 상세](apim-1/api/api-1/README.md)
-    * [API 정책](apim-1/api/api-1/api.md)
-* [API 배포 현황](apim-1/api-1/README.md)
-  * [API 배포 현황 상세](apim-1/api-1/api.md)
-* [API Document](apim-1/api-document/README.md)
-  * [API 문서 상세](apim-1/api-document/api.md)
-* [Monitoring](apim-1/monitoring.md)
-* [Logging](apim-1/logging/README.md)
-  * [Discover](apim-1/logging/discover.md)
-  * [Dashboard](apim-1/logging/dashboard.md)
-* [Event](apim-1/event.md)
-* [Alert 관리](apim-1/alert/README.md)
-  * [Slack App 관리](apim-1/alert/slack-app.md)
-  * [Slack 채널 관리](apim-1/alert/slack.md)
-  * [Admin Alert](apim-1/alert/admin-alert.md)
-  * [Project Alert](apim-1/alert/project-alert.md)
+* [APIM 콘솔이란?](apim-console/what-is-a-apim-console.md)
+* [APIM 관리](apim-console/apim-manage/README.md)
+  * [API 기본 정책](apim-console/apim-manage/api-basic-policy.md)
+  * [API KEY](apim-console/apim-manage/api-key.md)
+  * [JWT](apim-console/apim-manage/jwt.md)
+  * [AWS Credentials](apim-console/apim-manage/aws-credentials.md)
+  * [설정](apim-console/apim-manage/apim-setting.md)
+* [Gateway 관리](apim-console/gateway/README.md)
+  * [게이트웨이 생성](apim-console/gateway/gateway-create.md)
+  * [Gateway 정보](apim-console/gateway/gateway-info.md)
+  * [Gateway URL 정보](apim-console/gateway/gateway-url-info.md)
+* [API 관리](apim-console/api/README.md)
+  * [API 생성](apim-console/api/api.md)
+  * [API 상세](apim-console/api/api-1/README.md)
+    * [API 정책](apim-console/api/api-1/api.md)
+* [API 배포 현황](apim-console/api-1/README.md)
+  * [API 배포 현황 상세](apim-console/api-1/api.md)
+* [API Document](apim-console/api-document/README.md)
+  * [API 문서 상세](apim-console/api-document/api.md)
+* [Monitoring](apim-console/monitoring.md)
+* [Logging](apim-console/logging/README.md)
+  * [Discover](apim-console/logging/discover.md)
+  * [Dashboard](apim-console/logging/dashboard.md)
+* [Event](apim-console/event.md)
+* [Alert 관리](apim-console/alert/README.md)
+  * [Slack App 관리](apim-console/alert/slack-app.md)
+  * [Slack 채널 관리](apim-console/alert/slack.md)
+  * [Admin Alert](apim-console/alert/admin-alert.md)
+  * [Project Alert](apim-console/alert/project-alert.md)
 
-## 개발자 포탈
+## 개발자 포털 <a href="#devportal" id="devportal"></a>
 
-* [개발자 포탈이란?](undefined-1/undefined.md)
-* [개발자 포탈 관리자의 역할](undefined-1/undefined-1/README.md)
-  * [Home 관리](undefined-1/undefined-1/home.md)
-  * [Menu 관리](undefined-1/undefined-1/menu.md)
-  * [Product 관리](undefined-1/undefined-1/product.md)
-  * [API 사용 요청 관리](undefined-1/undefined-1/api.md)
-  * [개발자 포탈 설정](undefined-1/undefined-1/undefined.md)
-* [개발자 포탈 멤버의 역할](undefined-1/undefined-2.md)
-  * [기본 정보](undefined-1/undefined-2/undefined.md)
-  * [API KEY](undefined-1/undefined-2/api-key.md)
-  * [API 사용](undefined-1/undefined-2/api.md)
-  * [멤버 관리](undefined-1/undefined-2/undefined-1.md)
-* [애플리케이션 관리자의 역할](undefined-1/undefined-3.md)
-* [애플리케이션 멤버의 역할](undefined-1/undefined-4.md)
+* [개발자 포털이란?](devportal/what-is-a-devportal.md)
+* [개발자 포털 관리자의 역할](devportal/devportal-admin/README.md)
+  * [Home 관리](devportal/devportal-admin/home-mgn.md)
+  * [Menu 관리](devportal/devportal-admin/menu-mgn.md)
+  * [Product 관리](devportal/devportal-admin/product-mgn.md)
+  * [API 사용 요청 관리](devportal/devportal-admin/api-approve-mgn.md)
+  * [개발자 포털 설정](devportal/devportal-admin/devportal-setting.md)
+* [개발자 포털 멤버의 역할](devportal/undefined/README.md)
+  * [기본 정보](devportal/undefined/undefined.md)
+  * [API KEY](devportal/undefined/api-key.md)
+  * [API 사용](devportal/undefined/api.md)
+  * [멤버 관리](devportal/undefined/undefined-1.md)
+* [애플리케이션 관리자의 역할](devportal/undefined-1.md)
+* [애플리케이션 멤버의 역할](devportal/undefined-2.md)

apim-1/api-1/README.md → apim-console/api-1/README.md

@@ -4,7 +4,7 @@ description: 이미 배포된 API를 조회합니다.
 
 # API 배포 현황
 
-<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 배포된 API를 조회합니다.
 

apim-1/api/api-1/README.md → apim-console/api/api-1/README.md

@@ -8,7 +8,7 @@ API 상세 페이지는 Overview, API 문서, API Test 기능을 확인할 수 
 
 ## Overview
 
-<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 Overview에서는 Frontend와 Backend 그리고 게이트웨이 정책을 확인할 수 있습니다.
 
@@ -42,4 +42,4 @@ Method 변경을 통해 Rest API 호출 Method를 지원합니다. 오른쪽 아
 
 <figure><img src="../../../.gitbook/assets/image (4) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
-<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

apim-1/apim-1/api-key.md → apim-console/apim-manage/api-key.md

@@ -1,5 +1,5 @@
 ---
-description: API 정책 중 key-auth에서 사용하는 값을 관리합니다.
+description: API key-auth 정책의 KEY를 관리합니다.
 ---
 
 # API KEY
@@ -10,9 +10,7 @@ description: API 정책 중 key-auth에서 사용하는 값을 관리합니다.
 
 API KEY를 사용하기 전에 **key-auth** 정책에 대하여 먼저 알아봅니다.
 
-REST API에서 key-auth는 API 요청에 인증키를 함께 전송하여 API에 대한 접근을 인증하는 방식입니다.
-
-인증키는 API를 사용하는 사용자에게 발급되며, 사용자는 API 요청 시 해당 인증키를 함께 전송해야 합니다.
+REST API에서 key-auth는 API 요청에 인증키를 함께 전송하여 API에 대한 접근을 인증하는 방식입니다. 인증키는 API를 사용하는 사용자에게 발급되며, 사용자는 API 요청 시 해당 인증키를 함께 전송해야 합니다.
 
 인증키를 발급하는 방법은 다음과 같습니다.
 
@@ -22,7 +20,7 @@ REST API에서 key-auth는 API 요청에 인증키를 함께 전송하여 API에
 
 ## key-auth 정책 사용하기
 
-### KEY 발급하기
+### KEY 생성
 
 key-auth 정책을 API에 적용하였다면, 인증을 위한 key를 발급받아야 합니다. API KEY 화면에서 오른편 <mark style="background-color:blue;">API KEY 생성</mark> 버튼을 눌러 생성을 위한 화면으로 이동합니다.
 
@@ -47,7 +45,3 @@ API 호출 시 프로젝트마다 위의 [생성 단계](api-key.md#key)를 수
 호출 헤더의 예는 다음과 같습니다.
 
 `headers: { "x-apim-key": "202cb962ac59075b964b07152d234b70" }`
-
-
-
-\

apim-console/apim-manage/aws-credentials.md

@@ -0,0 +1,13 @@
+---
+description: APIM에서 사용하는 AWS Credentials를 관리합니다.
+---
+
+# AWS Credentials
+
+<figure><img src="../../.gitbook/assets/image (79).png" alt=""><figcaption></figcaption></figure>
+
+APIM에서 API 생성 시, lambda type을 생성하기 위해 AWS Credentials 정보가 필요합니다.
+
+필요한 정보는 다음과 같습니다. **AWS Access Key ID**, **AWS Secret Access Key**
+
+올바른 값을 입력하고 오른쪽 위 <mark style="background-color:blue;">저장</mark> 버튼을 눌러 과정을 진행합니다.

apim-console/apim-manage/jwt.md

@@ -0,0 +1,62 @@
+---
+description: API jwt 정책의 JWT KEY를 관리합니다.
+---
+
+# JWT
+
+<figure><img src="../../.gitbook/assets/image.png" alt=""><figcaption><p>JWT 홈</p></figcaption></figure>
+
+## JWT 란?
+
+jwt 정책을 사용하기 위해서 먼저 JWT에 대해서 알아봅니다.
+
+JSON Web Token (JWT)은 웹 표준으로, 데이터를 안전하게 전달하기 위한 컴팩트하고 자가수용적인 방법을 정의하는 토큰입니다. JWT는 클레임을 JSON 객체로 안전하게 전송하기 위한 방법으로 사용됩니다.
+
+JWT는 세 부분으로 구성됩니다: Header(헤더), Payload(내용), Signature(서명). 이 세 부분은 Base64 URL로 인코딩되어 하나의 문자열로 합쳐집니다.
+
+자세한 내용은 [jwt.io](https://jwt.io/)를  참고합니다.
+
+## jwt 정책 사용하기
+
+### JWT KEY 생성
+
+jwt 정책을 API에 적용하였다면, 인증을 위한 토큰이 필요합니다. 이를 위하여 오른쪽 <mark style="background-color:blue;">JWT KEY 생성</mark> 버튼을 눌러 JWT KEY와 JWT SECRET 발급화면으로 이동합니다.
+
+APIM에서는 JWT 사용 방법으로 **HS256**과 **RS256** 두 가지 알고리즘을 지원합니다.
+
+* HS256
+
+<figure><img src="../../.gitbook/assets/image (75).png" alt=""><figcaption></figcaption></figure>
+
+HS256 알고리즘을 사용하는 경우 자동으로 KEY와 SECRET을 생성해줍니다.
+
+* RS256
+
+<figure><img src="../../.gitbook/assets/image (76).png" alt=""><figcaption></figcaption></figure>
+
+RS256 알고리즘을 사용하는 경우 사용자 정의에 따라 Public KEY와 Private KEY를 구성합니다.
+
+각 값을 확인하고, 오른쪽 아래 <mark style="background-color:blue;">생성</mark> 버튼을 눌러 생성을 진행합니다.
+
+생성을 완료하고 JWT 홈 화면으로 이동하면 아래 이미지 예시처럼 정상적으로 생성 완료된 JWT KEY를 조회할 수 있습니다.
+
+<figure><img src="../../.gitbook/assets/image (77).png" alt=""><figcaption></figcaption></figure>
+
+홈 화면에서 조회된 목록에서 **Active** **활성화/비활성화**를 전환하여 해당 JWT KEY 인증이 동작하지 않도록 할 수 있으며 사용에 주의해야 합니다.&#x20;
+
+또한, 가장 오른쪽의 <mark style="background-color:blue;">X</mark> 버튼으로 삭제할 수 있습니다.
+
+### JWT 정책 사용 가이드
+
+API Gateway는 설정에 따라 API 요청 시 포함되는 JWT 토큰 검증을 수행합니다.
+
+RequiredPath / NotRequiredPath 설정을 통해 jwt 토큰 검증을 수행하지 않는 Method 및 Path 설정이 가능합니다. 예시) GET\_/login (요청 시, jwt 토큰이 없기 때문에 jwt 토큰 검증을 미수행해야 하는 Path)
+
+HTTP Request Header에 **authorization: bearer {JWT Token}**의 형태로 설정 합니다.
+
+JWT 정책이 적용된 API에 대하여 Authorization Header가 없는 경우, API를 정상 호출할 수 없음에 유의 바랍니다.
+
+#### 참고하기
+
+[jwt 사용 방법](https://jwt.io/introduction)
+

apim-1/gateway/undefined.md → apim-console/gateway/gateway-create.md

@@ -1,11 +1,19 @@
+---
+description: APIM에서 관리하는 게이트웨이 생성에 대해 알아봅니다.
+---
+
 # 게이트웨이 생성
 
+## 게이트웨이 생성하기
+
 게이트웨이 생성을 진행합니다.
 
 **이름**, **설명**, **태그를** 지정하고 게이트웨이의 클러스터 등 스펙을 설정합니다.
 
 <figure><img src="../../.gitbook/assets/image (40).png" alt=""><figcaption></figcaption></figure>
 
+### 게이트웨이 정보 - 1
+
 <table><thead><tr><th width="212">이름</th><th>설명</th></tr></thead><tbody><tr><td>Gateway 타입</td><td>프로젝트에 지정된 게이트웨이의 종류</td></tr><tr><td>Gateway 이름</td><td>생성될 게이트웨이의 이름</td></tr><tr><td>Gateway 설명</td><td>게이트웨이 조회 시 보일 설명 (편집 가능)</td></tr><tr><td>Gateway 태그</td><td>검색 등에 사용되는 게이트웨이에 지정되는 태그 (편집 가능)</td></tr><tr><td>Gateway CPU</td><td>게이트웨이에 할당되는 CPU 사양</td></tr><tr><td>Gateway Memory</td><td>게이트웨이에 할당되는 Memory 사양</td></tr><tr><td>DataBase CPU</td><td>게이트웨이의 데이터베이스에 할당되는 CPU 사양</td></tr><tr><td>DataBase Memory</td><td>게이트웨이의 데이터베이스에 할당되는 Memory 사양</td></tr><tr><td>Kong Cluster</td><td>게이트웨이가 생성될 클러스터</td></tr><tr><td>Kong Namespace</td><td>게이트웨이가 생성될 네임스페이스</td></tr><tr><td>Kong Storage Class</td><td>게이트웨이가 사용하는 스토리지 클래스의 타입</td></tr><tr><td>Storage capacity</td><td>게이트웨이가 사용하는 스토리지의 크기</td></tr><tr><td>Inner Redis</td><td>게이트웨이가 사용하는 레디스의 사양(off 선택 시, 사용자의 레디스 설정 필요)</td></tr></tbody></table>
 
 > 따라해보기.

apim-1/gateway/gateway.md → apim-console/gateway/gateway-info.md

@@ -4,10 +4,14 @@ description: 게이트웨이 생성 후, 구성된 상세 내용을 살펴봅니
 
 # Gateway 정보
 
+## 게이트웨이 정보
+
 <figure><img src="../../.gitbook/assets/image (42).png" alt=""><figcaption></figcaption></figure>
 
 게이트웨이 생성 버튼을 눌러 구성 내용을 저장하였다면, 상세 내용을 확인할 수 있습니다.
 
 생성 시 작성했던 내용과 더불어 추가로 몇 가지 항목을 더 확인할 수 있습니다.
 
+### 게이트웨이 정보 - 2
+
 <table><thead><tr><th width="289">이름</th><th>설명</th></tr></thead><tbody><tr><td>Gateway Replicas</td><td>게이트웨이의 복제본 수 설정. (무중단 배포)</td></tr><tr><td>Kong Proxy K8s Service Name</td><td>게이트웨이의 쿠버네티스 서비스 이름</td></tr><tr><td>Kong Proxy k8s Service Port</td><td>게이트웨이의 쿠버네티스 서비스 포트</td></tr></tbody></table>

apim-1/gateway/gateway-url.md → apim-console/gateway/gateway-url-info.md

@@ -4,10 +4,14 @@ description: 게이트웨이에 지정되는 URL 정보입니다. (쿠버네티
 
 # Gateway URL 정보
 
+## 게이트웨이 URL
+
 <figure><img src="../../.gitbook/assets/image (41).png" alt=""><figcaption></figcaption></figure>
 
 이후, 게이트웨이에 등록되는 API가 사용할 URL과 사양을 구성합니다. 언제든지 편집이 가능합니다.
 
+### 게이트웨이 URL 정보
+
 <table><thead><tr><th width="257">이름</th><th>설명</th></tr></thead><tbody><tr><td>Gateway URL</td><td>API 호출을 위한 주소</td></tr><tr><td>Global BasePath</td><td>게이트웨이에 등록되는 모든 API의 기본 BasePath</td></tr><tr><td>HTTPS ONLY</td><td>HTTPS 프로토콜만 사용하는 경우 ON</td></tr><tr><td>TLS certificates</td><td>TLS를 직접 등록하여 사용하는 경우</td></tr><tr><td>Annotations</td><td>쿠버네티스 인그래스의 Annotations 구성 내용</td></tr></tbody></table>
 
 > 따라해보기.

undefined-1/undefined-1/README.md → devportal/devportal-admin/README.md

@@ -1,20 +1,20 @@
 ---
-description: 개발자 포탈 관리자만의 역할과 기능에 관하여 소개합니다.
+description: 개발자 포털 관리자만의 역할과 기능에 관하여 소개합니다.
 ---
 
-# 개발자 포탈 관리자의 역할
+# 개발자 포털 관리자의 역할
 
 <figure><img src="../../.gitbook/assets/image (46).png" alt=""><figcaption></figcaption></figure>
 
-개발자 포탈에서는 개발자 포탈 관리자와 프로젝트 관리자 그리고 프로젝트 멤버의 역할이 구분되어 있습니다.
+개발자 포털에서는 개발자 포털 관리자와 프로젝트 관리자 그리고 프로젝트 멤버의 역할이 구분되어 있습니다.
 
-개발자 포탈 관리자의 역할을 알아봅니다.
+개발자 포털 관리자의 역할을 알아봅니다.
 
-관리자는 포탈 로그인 후, 우측 상단 로그인 아이콘의 좌측에서 <mark style="background-color:blue;">Developers 관리자</mark>버튼을 통해 관리자 전용 페이지로 이동할 수 있습니다.
+관리자는 포털 로그인 후, 우측 상단 로그인 아이콘의 좌측에서 <mark style="background-color:blue;">Developers 관리자</mark> 버튼을 통해 관리자 전용 페이지로 이동할 수 있습니다.
 
 <figure><img src="../../.gitbook/assets/image (45).png" alt="" width="139"><figcaption></figcaption></figure>
 
 관리자 전용 페이지에서는 다음과 같은 기능을 제공합니다.
 
-<table><thead><tr><th width="231">이름</th><th>설명</th></tr></thead><tbody><tr><td>Home 관리</td><td>Developers 포탈 Home 화면을 설정</td></tr><tr><td>Menu 관리</td><td>메뉴 구조를 설정하고, 메뉴별 Contents를 작성</td></tr><tr><td>Product 관리</td><td>Product 목록으로, Product는 여러 API의 묶음으로 구성</td></tr><tr><td>API 사용 요청 관리</td><td>API 사용 요청에 대한 승인 및 반려</td></tr><tr><td>설정</td><td>포럼 활성화, IP Whitelist 기능, Origin/Copied API 게시, API KEY 갱신 권한, API 이름 정렬, Swagger API 숨김, API 중복 추가 설정</td></tr></tbody></table>
+<table><thead><tr><th width="231">이름</th><th>설명</th></tr></thead><tbody><tr><td>Home 관리</td><td>Developers 포털 Home 화면을 설정</td></tr><tr><td>Menu 관리</td><td>메뉴 구조를 설정하고, 메뉴별 Contents를 작성</td></tr><tr><td>Product 관리</td><td>Product 목록으로, Product는 여러 API의 묶음으로 구성</td></tr><tr><td>API 사용 요청 관리</td><td>API 사용 요청에 대한 승인 및 반려</td></tr><tr><td>설정</td><td>포럼 활성화, IP Whitelist 기능, Origin/Copied API 게시, API KEY 갱신 권한, API 이름 정렬, Swagger API 숨김, API 중복 추가 설정</td></tr></tbody></table>
 

undefined-1/undefined-1/api.md → devportal/devportal-admin/api-approve-mgn.md

@@ -6,7 +6,7 @@ description: API 사용 요청에 대한 승인과 반려를 관리합니다.
 
 <figure><img src="../../.gitbook/assets/image (2) (1).png" alt=""><figcaption></figcaption></figure>
 
-프로젝트 관리자가 **My Application**에서 API를 사용하기 위해서 사용 요청을 보내면, 개발자 포탈 관리자는 이곳에서 승인 또는 반려를 합니다.
+프로젝트 관리자가 **My Application**에서 API를 사용하기 위해서 사용 요청을 보내면, 개발자 포털 관리자는 이곳에서 승인 또는 반려를 합니다.
 
 액션탭의 <mark style="background-color:blue;">승인</mark> 버튼을 눌러 아래와 같은 모달을 확인할 수 있습니다. 해당 모달 창에서 **API명**이 나타난곳을 클릭하면 반려 상태로 전환됩니다.