8.7. 3scale ActiveDoc 사용자 정의 리소스 배포
Red Hat 3scale API Management ActiveDocs는 OpenAPI 사양을 준수하는 RESTful 웹 서비스를 정의하는 API 정의 문서를 기반으로 합니다. CR( ActiveDoc 사용자 정의 리소스)은 개발자 포털의 ActiveDocs에 사용할 수 있는 OAS(OpenAPI Specification) 문서를 가져오는 한 가지 방법입니다. OAS는 API에 하나의 특정 프로그래밍 언어를 사용하도록 연결하지 않는 표준입니다. 사람과 컴퓨터는 소스 코드 액세스, 문서 또는 네트워크 트래픽 검사없이 API 제품의 기능을 더 쉽게 이해할 수 있습니다.
사전 요구 사항
- 3scale 2.14 On-Premises 인스턴스에 대한 관리자 권한이 있는 사용자 계정.
- API를 정의하는 OAS 문서입니다.
-
ActiveDocCR이 테넌트에 연결하는 방법에 대한 이해
8.7.1. 시크릿에서 OAS 문서를 가져오는 3scale ActiveDoc 사용자 정의 리소스 배포 링크 복사링크가 클립보드에 복사되었습니다!
3scale 백엔드 및 제품을 생성할 수 있도록 ActiveDoc CR(사용자 정의 리소스)을 배포합니다.
Operator는 시크릿의 콘텐츠만 읽습니다. Operator는 시크릿에서 필드 이름을 읽지 않습니다. 예를 들어 데이터는 key: 값 쌍으로 구조화됩니다. 여기서 value 쌍은 파일의 내용을 나타내고 key 는 파일 이름입니다. 이 ActiveDoc CRD의 이 컨텍스트에서 Operator는 파일 이름을 무시합니다. Operator는 파일의 콘텐츠만 읽습니다.
사전 요구 사항
- 3scale Operator가 사용자 지정 리소스가 연결되는 테넌트를 식별하는 방법을 이해할 수 있습니다.
OAS(OpenAPI 사양) 문서가 포함된 시크릿을 정의합니다. 예를 들어 이 콘텐츠를 사용하여
myoasdoc1.yaml을 생성할 수 있습니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
절차
시크릿을 생성합니다. 예를 들어 다음과 같습니다.
oc create secret generic myoasdoc1 --from-file myoasdoc1.yaml
$ oc create secret generic myoasdoc1 --from-file myoasdoc1.yaml secret/myoasdoc1 createdCopy to Clipboard Copied! Toggle word wrap Toggle overflow ActiveDocCR을 정의합니다. OAS 문서가 포함된 보안에 대한 참조를 지정해야 합니다. 예를 들어myactivedoccr1.yaml파일을 생성할 수 있습니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow 방금 정의한 리소스를 만듭니다. 예를 들어 다음과 같습니다.
oc create -f myactivedoccr1.yaml
$ oc create -f myactivedoccr1.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 지정된 예에서 출력은 다음과 같습니다.
activedoc.capabilities.3scale.net/myactivedoccr1 created
activedoc.capabilities.3scale.net/myactivedoccr1 createdCopy to Clipboard Copied! Toggle word wrap Toggle overflow
검증
- Red Hat OpenShift Container Platform (OCP) 관리자 계정에 로그인합니다.
- Operators > 설치된 Operators 로 이동합니다.
- Red Hat Integration - 3scale 을 클릭합니다.
- Active Doc 탭을 클릭합니다.
-
OAS 문서가 있는지 확인합니다. 위의 예제에서는
myactivedoccr1이라는 새로운 OAS 문서가 표시됩니다.
8.7.2. 3scale ActiveDoc 사용자 정의 리소스 정의 기능 링크 복사링크가 클립보드에 복사되었습니다!
ActiveDoc CRD(사용자 정의 리소스 정의)는 개발자를 위한 OpenAPI 문서 형식의 제품 문서에 관한 것입니다. ActiveDoc CRD 배포 기능에 대한 지식이 있으면 개발자 포털용 ActiveDocs를 생성할 수 있습니다.
ActiveDocCR은 다음 중 하나에서 읽고 OpenAPI 문서를 사용할 수 있습니다.- Secret
-
http또는https형식의 URL
-
선택적으로
productSystemName필드를 사용하여ActiveDocCR을 3scale 제품에 연결할 수 있습니다. 값은 3scale 제품 CR의system_name이어야 합니다. -
게시된필드를 사용하여 3scale에서ActiveDoc문서를 게시하거나 숨길 수 있습니다. 기본적으로 이 값은숨겨집니다. -
skipSwaggerValidations필드를 사용하여 OpenAPI 3.0 검증을 건너뛸 수 있습니다. 기본적으로ActiveDocCR이 검증됩니다.
8.7.3. URL에서 OAS 문서를 가져오는 3scale ActiveDoc 사용자 정의 리소스 배포 링크 복사링크가 클립보드에 복사되었습니다!
지정하는 URL에서 OAS(OpenAPI Specification) 문서를 가져오는 ActiveDoc CR(사용자 정의 리소스)을 배포할 수 있습니다. 그런 다음 이 OAS 문서를 개발자 포털에서 API용 ActiveDocs의 기반으로 사용할 수 있습니다.
사전 요구 사항
- 3scale Operator가 사용자 지정 리소스가 연결되는 테넌트를 식별하는 방법을 이해할 수 있습니다.
절차
- OpenShift 계정에서 Operator > 설치된 Operator로 이동합니다.
- 3scale Operator를 클릭합니다.
- Active Doc 탭을 클릭합니다.
ActiveDocCR을 생성합니다. 예를 들어 다음과 같습니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow 선택 사항: 자체 관리형 APIcast의 경우
ActiveDocCR에서productionPublicBaseURL및stagingPublicBaseURL필드를 배포 URL로 설정합니다. 예를 들어 다음과 같습니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
저장을 클릭합니다. 3scale Operator가
ActiveDocCR을 생성하는 데 몇 초가 걸립니다.
검증
- Red Hat OpenShift Container Platform (OCP) 관리자 계정에 로그인합니다.
- Operators > 설치된 Operators 로 이동합니다.
- Red Hat Integration 3scale 을 클릭합니다.
- Active Doc 탭을 클릭합니다.
-
OAS 문서가 있는지 확인합니다. 위의 예제에서는
myactivedoccr1이라는 새로운 OAS 문서가 표시됩니다.