새 Edge UI 설치

이 문서에서는 프라이빗 클라우드용 Apigee Edge용 Edge UI를 설치하는 방법을 설명합니다. Edge UI는 Edge용 차세대 UI입니다.

기본 요건

Private Cloud용 Apigee Edge 설치에서 새 Edge UI를 사용해 보려면 다음을 수행해야 합니다.

  • Edge UI를 자체 노드에 설치합니다. 기존 기존 UI가 있는 노드를 비롯하여 다른 Edge 구성요소가 포함된 노드에는 설치할 수 없습니다. 이렇게 하면 사용자가 기존 UI에 로그인할 수 없습니다.

    Edge UI의 노드는 다음 요구사항을 충족해야 합니다.

    • JAVA 1.8
    • RAM 4GB
    • 코어 2개
    • 60GB 디스크 공간
    • 먼저 Edge Apigee-setup 유틸리티 설치에 설명된 대로 4.51.00 버전의 apigee-setup 유틸리티를 노드에 설치해야 합니다.
    • 포트 3001이 열려 있어야 합니다. Edge UI 요청에 사용되는 기본 포트입니다. 새 UE 구성 파일에 설명된 속성을 사용하여 포트를 변경하는 경우 포트가 열려 있는지 확인하세요.
  • Edge에서 외부 IDP를 사용 설정합니다. Edge UI는 SAML 또는 LDAP를 인증 메커니즘으로 지원합니다.
  • (SAML IDP만 해당) Edge UI는 TLS v1.2만 지원합니다. TLS를 통해 SAML IdP에 연결하므로 SAML을 사용하는 경우 IdP에서 TLS v1.2를 지원해야 합니다.

Edge UI에 대한 자세한 내용은 Private Cloud용 새로운 Edge UI를 참조하세요.

설치 개요

프라이빗 클라우드용 Apigee Edge의 Edge UI를 설치하는 프로세스는 대략 다음과 같습니다.

  • 클러스터에 새 노드 추가
  • 새 노드에 로그인
  • apigee-setup 유틸리티 다운로드
  • 구성 파일을 만들고 설정으로 수정
  • apigee-setup 유틸리티 실행
  • 로그인하여 새 UE 테스트

새 노드에서 실행되면 apigee-setup 유틸리티는 다음을 실행합니다.

  • 슈혼이라는 기본 기본 UI를 설치하고 외부 IDP를 사용하여 Edge에 인증하도록 기본 UI를 구성합니다.
  • 새 Edge UI를 설치하고 외부 IDP를 사용하여 Edge에 인증하도록 Edge UI를 구성합니다.

새 Edge UI를 설치하기 전 고려사항

위의 기본 요건에 설명된 대로 Edge UI를 사용하려면 Edge에서 외부 IDP를 사용 설정해야 합니다. 즉, 사용자 인증은 이메일 주소를 사용자 ID로 사용하도록 구성된 IDP에서 제어합니다. 따라서 모든 Edge UI 사용자는 IdP에 등록되어야 합니다.

프라이빗 클라우드용 Apigee Edge와 함께 설치한 기본 UI인 기본 UI에는 외부 IDP가 필요하지 않습니다. IDP 또는 기본 인증을 사용할 수 있습니다. 즉, 다음 중 하나를 수행할 수 있습니다.

  • Edge 및 기존 UI와 Edge UI 모두에서 외부 IDP 지원을 사용 설정합니다.

    이 시나리오에서는 모든 기존 UI 및 Edge UI 사용자가 IdP에 등록됩니다. IDP에 새 사용자를 추가하는 방법에 관한 자세한 내용은 새 Edge 사용자 등록을 참고하세요.

  • Edge에서 외부 IDP 지원을 사용 설정하지만 기본 인증은 사용 설정된 상태로 둡니다. Edge UI는 IDP를 사용하고 기존 UI는 여전히 기본 인증을 사용합니다.

    이 시나리오에서는 모든 기본 UI 사용자가 기본 사용자 인증 정보로 로그인하고, 사용자 인증 정보는 Edge OpenLDAP 데이터베이스에 저장됩니다. Edge UI 사용자는 IDP에 등록되며 SAML 또는 LDAP를 사용하여 로그인합니다.

    하지만 새 Edge 사용자 등록에 설명된 대로 기본 UI 사용자는 해당 사용자를 IDP에 추가하기 전에는 Edge UI에 로그인할 수 없습니다.

이전 출시의 설치 구성 변경사항

Edge UI 베타 출시 버전에서 설치 절차가 다음과 같이 변경되었습니다.

새 Edge UI 구성 파일

다음 구성 파일에는 새 Edge UI를 설치하고 구성하는 데 필요한 모든 정보가 포함되어 있습니다. 동일한 구성 파일을 사용하여 shoehorn/기존 UI와 Edge UI를 모두 설치하고 구성할 수 있습니다.

# IP of the Edge Management Server.
# This node also hosts the Apigee SSO module and the current, or Classic, UI.
IP1=management_server_IP

# IP of the Edge UI node.
IP2=edge_UI_server_IP

# Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=your_password    # If omitted, you are prompted for it.

# Edge Management Server information.
APIGEE_PORT_HTTP_MS=8080
MSIP=$IP1
MS_SCHEME=http

#
# Edge UI configuration.
#

# Enable the Edge UI.
EDGEUI_ENABLE_UNIFIED_UI=y
# Specify IP and port for the Edge UI.
# The management UI port must be open for requests to the Edge UI
MANAGEMENT_UI_PORT=3001
MANAGEMENT_UI_IP=$IP2
# Set to 'OPDK' to specify a Private Cloud deployment.
MANAGEMENT_UI_APP_ENV=OPDK
# Disable TLS on the Edge UI.
MANAGEMENT_UI_SCHEME=http

# Location of Edge UI.
MANAGEMENT_UI_PUBLIC_URIS=$MANAGEMENT_UI_SCHEME://$MANAGEMENT_UI_IP:$MANAGEMENT_UI_PORT
MANAGEMENT_UI_SSO_REGISTERED_PUBLIC_URIS=$MANAGEMENT_UI_PUBLIC_URIS
MANAGEMENT_UI_SSO_CSRF_SECRET=YOUR_CSRF_SECRET
# Duration of CSRF token.
MANAGEMENT_UI_SSO_CSRF_EXPIRATION_HOURS=24
# Defaults to 8760 hours, or 365 days.
MANAGEMENT_UI_SSO_STRICT_TRANSPORT_SECURITY_AGE_HOURS=8760

## SSO configuration for the Edge UI.
MANAGEMENT_UI_SSO_ENABLED=y

# Only required if MANAGEMENT_UI_SSO_ENABLED is 'y'
MANAGEMENT_UI_SSO_CLIENT_OVERWRITE=y

MANAGEMENT_UI_SSO_CLIENT_ID=newueclient
MANAGEMENT_UI_SSO_CLIENT_SECRET=your_client_sso_secret

#
# Shoehorn UI configuration
#
# Set to http even if you enable TLS on the Edge UI.
SHOEHORN_SCHEME=http
SHOEHORN_IP=$MANAGEMENT_UI_IP
SHOEHORN_PORT=9000

#
# Edge Classic UI configuration.
# Some settings are for the Classic UI, but are still required to configure the Edge UI.
#

# These settings assume that Classic UI is installed on the Management Server.
CLASSIC_UI_IP=$MSIP
CLASSIC_UI_PORT=9000
CLASSIC_UI_SCHEME=http
EDGEUI_PUBLIC_URIS=$CLASSIC_UI_SCHEME://$CLASSIC_UI_IP:$CLASSIC_UI_PORT

# Information about publicly accessible URL for Classic UI.
EDGEUI_SSO_REGISTERED_PUBLIC_URIS=$EDGEUI_PUBLIC_URIS

# Enable SSO
EDGEUI_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso.
# The default client name is 'edgeui'.
# Apigee recommends that you use the same settings as you used
# when enabling your IDP on the Classic UI.
EDGEUI_SSO_CLIENT_NAME=edgeui
# Oauth client password using uppercase, lowercase, number, and special chars.
EDGEUI_SSO_CLIENT_SECRET=ssoClient123
# If set, existing EDGEUI client will deleted and new one will be created.
EDGEUI_SSO_CLIENT_OVERWRITE=y

# Apigee SSO Component configuration
# Externally accessible IP or DNS of Edge SSO module.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on the Apigee SSO module.
# If Apigee SSO uses a self-signed cert, you must also set MANAGEMENT_UI_SKIP_VERIFY to "y".
SSO_PUBLIC_URL_SCHEME=http
# MANAGEMENT_UI_SKIP_VERIFY=y
# SSO admin credentials as set when you installed Apigee SSO module.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=your_sso_admin_secret

#
##      SSO Configuration (define external IDP)           #
#
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                        #
#  - LDAP Direct Binding configuration properties         #
#  - LDAP Indirect Binding configuration properties       #

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect)

## SMTP Configuration (required)
#
SKIP_SMTP=n       # Skip now and configure later by specifying "y".
SMTPHOST=smtp.gmail.com
SMTPUSER=your@email.com
SMTPPASSWORD=your_email_password
SMTPSSL=y
SMTPPORT=465      # If no SSL, use a different port, such as 25.
SMTPMAILFROM="My Company myco@company.com"

Edge UI 설치

구성 파일을 만들고 수정한 후 새 노드에 새 Edge UI를 설치할 수 있습니다.

Edge UI를 설치하려면 다음 단계를 따르세요.

  1. 클러스터에 새 노드를 추가합니다.
  2. 관리자로 새 노드에 로그인합니다.
  3. Edge apigee-setup 유틸리티 설치에 설명된 대로 노드에 apigee-setup 유틸리티의 4.51.00 버전을 설치합니다.
  4. 다음 명령어를 실행하여 Yum으로 캐시된 모든 정보를 삭제합니다. 
    sudo yum clean all
  5. 새 Edge UI 구성 파일에 설명된 대로 구성 파일을 만들고 'apigee' 사용자가 소유하고 있는지 확인합니다. 
    chown apigee:apigee configFile

    구성 파일을 다음과 같이 수정해야 합니다.

    • 구성 파일에서 MANAGEMENT_UI_SSO_CSRF_SECRET 속성 값을 CSRF 시크릿으로 변경합니다.
    • 다음 중 하나를 사용하도록 Edge를 구성합니다 (새 Edge UI에는 외부 IDP 필요).
      • SAML
      • LDAP

      자세한 내용은 외부 IDP 인증 개요를 참고하세요.

  6. Edge UI에 액세스할 사용자로 외부 IDP를 구성합니다. 자세한 내용은 새 Edge 사용자 등록을 참고하세요.
  7. 새 노드에서 다음 명령어를 실행합니다. 
    /opt/apigee/apigee-setup/bin/setup.sh -p ue -f configFile

    apigee-setup 유틸리티는 기존 UI를 설치합니다. 그런 다음 설치 프로그램은 기존 UI 위에 Edge UI를 설치합니다.

  8. 브라우저에서 다음 URL을 열어 Edge UI에 로그인합니다. 
    http://new_edge_UI_IP:3001

    여기서 new_edge_UI_IP는 새 Edge UI를 호스팅하는 노드의 IP 주소입니다.

    Edge에서 외부 IdP 사용자 인증 정보를 입력하라는 메시지가 표시됩니다.

  9. 사용자 인증 정보를 입력합니다.

    새 Edge UI가 표시됩니다. Edge UI 사용에 관한 자세한 내용은 Private Cloud용 새로운 Edge UI를 참고하세요.

    Edge UI가 표시되지 않으면 외부 연결을 위해 포트 3001이 열려 있는지 확인합니다.

새 UI 제거

노드에서 새 UI를 제거하려면 새 Edge UI와 UI 설치 프로세스 중에 노드에 설치된 기본 기존 UI (shoehorn)를 모두 제거해야 합니다.

새 Edge UI를 제거하려면 다음 안내를 따르세요.

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui uninstall

기본 기존 UI를 제거하려면 (Shoehorn) 다음 단계를 따르세요.

/opt/apigee/apigee-service/bin/apigee-service edge-ui uninstall

노드에서 모든 Edge 구성요소를 삭제하려면 다음 단계를 따르세요.

  1. 머신에서 실행 중인 모든 Edge 서비스를 중지합니다. 
    /opt/apigee/apigee-service/bin/apigee-all stop
  2. yum 캐시를 삭제합니다. 
    sudo yum clean all
  3. 모든 Apigee RPM을 삭제합니다. 
    sudo rpm -e $(rpm -qa | egrep "(apigee-|edge-)")
  4. 설치 루트 디렉터리를 삭제합니다. 
    sudo rm -rf /opt/apigee