2.3. OpenShift 4.x에 API Cryostat 설치

Red Hat Fuse on OpenShift는 REST API를 설계하는 데 사용할 수 있는 웹 기반 API Creator 툴인 API Creator를 제공합니다. API Splunk Operator는 OpenShift Container Platform 4.x에서 API Builder의 설치 및 업그레이드를 간소화합니다.

OpenShift 관리자는 API Creator Operator를 OpenShift 프로젝트(네임스페이스)에 설치합니다. Operator가 설치되면 선택한 네임스페이스에서 Operator가 실행됩니다. 그러나 API window를 OpenShift 관리자로 사용하여 서비스로 사용 가능하게 하려면 개발자가 API Cryostat의 인스턴스를 생성해야 합니다. API Cryostat 서비스는 API window web console에 액세스할 수 있는 URL을 제공합니다.

사전 요구 사항

  • OpenShift 클러스터에 대한 관리자 액세스 권한이 있어야 합니다.
  • Red Hat Container Registry에 대한 인증을 구성했습니다.

절차

  1. OpenShift 4.x 서버를 시작합니다.
  2. 웹 브라우저에서 브라우저에서 OpenShift 콘솔로 이동합니다. 인증 정보를 사용하여 콘솔에 로그인합니다.
  3. Operators 를 클릭한 다음 OperatorHub 를 클릭합니다.
  4. 검색 필드에 API window를 입력합니다.
  5. API Cryostat 카드를 클릭합니다. API Cryostat Operator 설치 페이지가 열립니다.

  6. 설치를 클릭합니다. Operator 설치 페이지가 열립니다.

    1. 설치 모드 의 경우 클러스터의 네임스페이스 목록에서 네임스페이스(프로젝트)를 선택합니다.

    2. 승인 전략 의 경우 자동 또는 수동 을 선택하여 OpenShift에서 API Cryostat Operator에 대한 업데이트를 처리하는 방법을 구성합니다.

      • 자동 업데이트를 선택하면 새 버전의 API Builder Operator를 사용할 수 있는 경우 OLM(Operator Lifecycle Manager)은 개입 없이 API Cryostat의 실행 중인 인스턴스를 자동으로 업그레이드합니다.
      • 수동 업데이트를 선택하면 최신 버전의 Operator가 사용 가능할 때 OLM에서 업데이트 요청을 생성합니다. 클러스터 관리자는 API Policy Operator를 새 버전으로 업데이트하려면 해당 업데이트 요청을 수동으로 승인해야 합니다.
  7. 설치를 클릭하여 지정된 네임스페이스(프로젝트)에서 API Creator Operator를 사용할 수 있도록 합니다.
  8. API window가 프로젝트에 설치되어 있는지 확인하려면 Operators 를 클릭한 다음 Installed Operators 를 클릭하여 목록의 APIFilter를 확인합니다.

다음 단계

API Builder Operator가 설치되면 API Cryostat의 인스턴스를 생성하여 API Builder를 OpenShift 프로젝트에 서비스로 추가해야 합니다. 이 작업은 다음 두 가지 방법으로 수행할 수 있습니다.

2.3.1. OpenShift 4.x 프로젝트에 API Cryostat를 서비스로 추가

OpenShift 4.x 프로젝트에 API Creator Operator를 설치한 후 OpenShift 개발자(또는 OpenShift 개발자)에서 OpenShift 프로젝트에 서비스로 추가할 수 있습니다. API Splunk 서비스는 개발자가 API users users 웹 콘솔에 액세스하는 데 사용하는 URL을 제공합니다.

참고

OpenShift 개발자가 OpenShift 4.x 프로젝트에 API Creator를 서비스로 추가하기 위해 수행하는 단계는 API 설계를 참조하십시오.

사전 요구 사항

  • OpenShift 클러스터에 대한 관리자 액세스 권한이 있어야 합니다.
  • API Cryostat Operator는 현재 OpenShift 프로젝트에 설치됩니다.

절차

  1. OpenShift 웹 콘솔에서 Operator를 클릭한 다음 설치된 Operator 를 클릭합니다.
  2. 이름 열에서 API Creator를 클릭합니다.

  3. 제공된 API 에서 인스턴스 생성을 클릭합니다.

    API Builder 인스턴스에 대한 최소 시작 템플릿이 있는 기본 양식이 열립니다.

  4. 기본값을 수락하거나 선택적으로 다음 값을 편집합니다.

    • size: API Splunk 인스턴스의 Pod 수입니다.

      기본값은 API Cryostat 관리와 관련된 논리가 포함된 두 개의 새 리소스 유형의 Pod입니다.

    • image: APIDesign 이미지입니다. 이 이미지를 변경하면 클러스터에서 API Creator Operator가 자동으로 업그레이드됩니다.
  5. 생성 을 클릭하여 새 apicurito-service 를 생성합니다. OpenShift는 새 API Creator 서비스에 대한 pod, 서비스 및 기타 구성 요소를 시작합니다.

  6. API Creator 서비스를 사용할 수 있는지 확인하려면 다음을 수행하십시오.

    1. Operators 를 클릭한 다음 Installed Operators 를 클릭합니다.

    2. Provided APIs 열에서 Apicurito CRD 를 클릭합니다.

      Operator 세부 정보 페이지에 apicurito-service 가 나열됩니다.

  7. API Cryostat의 URL을 가져오려면 다음을 수행합니다.

    1. 네트워킹 > 경로를 클릭합니다.
    2. 올바른 프로젝트가 선택되어 있는지 확인합니다.
    3. apicurito-service-ui 행에서 위치 열에서 API Builder 웹 콘솔의 URL을 찾습니다.

2.3.2. OpenShift 4.x에서 APIDesign 업그레이드

Red Hat OpenShift 4.x는 Red Hat Fuse Operator를 포함하여 Operator에 대한 업데이트를 처리합니다. 자세한 내용은 Operator OpenShift 설명서 를 참조하십시오.

결과적으로 Operator 업데이트는 애플리케이션 업그레이드를 트리거할 수 있습니다. 애플리케이션 업그레이드 방법은 애플리케이션 구성 방법에 따라 다릅니다.

API Builder 애플리케이션의 경우 OpenShift는 API Creator Operator를 업그레이드할 때 클러스터의 모든 APIDesign 애플리케이션도 자동으로 업그레이드합니다.

2.3.3. API window의 미터링 라벨

OpenShift Metering Operator를 사용하여 설치된 API Builder Operator, UI 구성 요소 및 코드 생성기를 분석하여 Red Hat 서브스크립션을 준수할지 여부를 확인할 수 있습니다. 미터링에 대한 자세한 내용은 OpenShift 설명서 를 참조하십시오.

다음 표에는 API Splunk의 미터링 레이블이 나열되어 있습니다.

표 2.1. API Cryostat Metering 라벨

레이블가능한 값

com.company

Red_Hat

rht.prod_name

Red_Hat_Integration

rht.prod_ver

7.8

rht.comp

Fuse

rht.comp_ver

7.8

rht.subcomp

fuse-apicurito

apicurito-service-ui

apicurito-service-generator

rht.subcomp_t

infrastructure

예

  • API Creator Operator의 예: 

    apicurito-operator
com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.8
rht.comp: Fuse
rht.comp_ver: 7.8
rht.subcomp: fuse-apicurito
rht.subcomp_t: infrastructure

  • API Cryostat UI 구성 요소의 예는 다음과 같습니다. 

    com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.8
rht.comp: Fuse
rht.comp_ver: 7.8
rht.subcomp: apicurito-service-ui
rht.subcomp_t: infrastructure

  • API Creator Generator 구성 요소의 예는 다음과 같습니다. 

    com.company: Red_Hat
rht.prod_name: Red_Hat_Integration
rht.prod_ver: 7.8
rht.comp: Fuse
rht.comp_ver: 7.8
rht.subcomp: apicurito-service-generator
rht.subcomp_t: infrastructure

2.3.4. 제한된 환경에서 API Builder를 설치하기 위한 고려 사항

제한된 환경에 설치된 OpenShift 클러스터는 기본적으로 Red Hat 제공 OperatorHub 소스에 액세스할 수 없습니다. 이러한 원격 소스에는 완전한 인터넷 연결이 필요하기 때문입니다. 이러한 환경에서 APIDesign 연산자를 설치하려면 다음 사전 요구 사항을 완료해야 합니다.

  • OLM(Operator Lifecycle Manager)의 기본 원격 OperatorHub 소스를 비활성화합니다.
  • 완전한 인터넷 액세스 권한이 있는 워크스테이션을 사용하여 OperatorHub 콘텐츠의 로컬 미러를 생성합니다.
  • 기본 원격 소스 대신 로컬 소스에서 Operator를 설치하고 관리하도록 OLM을 구성합니다.

자세한 내용은 OpenShift 문서의 제한된 네트워크에서 Operator Lifecycle Manager 사용 섹션을 참조하십시오. OperatorHub의 로컬 미러를 생성한 후에는 다음 단계를 수행할 수 있습니다.