29.2. 검색 가능한 서비스 기준

3scale을 보유하려면 OCP(OpenShift) 클러스터에서 API 서비스를 검색하려면 OCP 서비스가 아래의 각 요소에 대한 기준을 충족해야 한다고 설명했습니다.

content-Type 헤더

API 사양의 Content-Type 헤더는 다음 값 중 하나여야 합니다.

  • application/swagger+json
  • application/vnd.oai.openapi+json
  • application/json

OpenShift Service 오브젝트 YAML 정의

  • OpenShift Service Object YAML 정의에는 다음 메타데이터가 포함되어야 합니다.

    • discovery.3scale.net 레이블: (필수)은 "true"로 설정합니다. 3scale은 검색이 필요한 모든 서비스를 찾기 위해 선택기 정의를 실행할 때 이 레이블을 사용합니다.
    • 다음 주석은 다음과 같습니다.

      discovery.3scale.net/discovery-version: (선택 사항) 3scale 검색 프로세스의 버전입니다.

      discovery.3scale.net/scheme: (필수) 서비스가 호스팅되는 URL의 체계 부분입니다. 가능한 값은 "http" 또는 "https"입니다.

      discovery.3scale.net/port: (필수) 클러스터 내의 서비스 포트 번호입니다.

      discovery.3scale.net/path: (선택 사항) 서비스가 호스팅되는 URL의 상대 기본 경로입니다. 경로가 루트인 경우 "/"에 이 주석을 생략할 수 있습니다.

      discovery.3scale.net/description-path: 서비스의 OpenAPI 서비스 설명 문서 경로입니다.

      예를 들면 다음과 같습니다.

          metadata:
            annotations:
              discovery.3scale.net/scheme: "https"
              discovery.3scale.net/port: '8081'
              discovery.3scale.net/path: "/api"
              discovery.3scale.net/description-path: "/api/openapi/json"
           labels:
              discovery.3scale.net: "true"
           name: i-task-api
           namespace: fuse
    • 관리 권한이 있는 OpenShift 사용자인 경우 OpenShift 콘솔에서 API 서비스의 YAML 파일을 볼 수 있습니다.

      1. Applications> Services 를 선택합니다.
      2. 서비스(예: i-task-api )를 선택하여 Details(세부 정보) 페이지를 엽니다.
      3. Actions> Edit YAML(YAML 편집) 을 선택하여 YAML 파일을 엽니다.
      4. 파일을 표시한 후 Cancel(취소 )을 선택합니다.

ovs-networkpolicy 플러그인이 있는 클러스터

  • OpenShift와 3scale 프로젝트 간의 트래픽을 허용하려면 ovs-networkpolicy 플러그인이 있는 클러스터에 애플리케이션 프로젝트 내에서 NetworkPolicy 오브젝트가 생성되어야 합니다.
  • NetworkPolicy 오브젝트 구성에 대한 자세한 내용은 네트워크 정책정보를 참조하십시오.