기본 UI 속성을 새 Edge UI로 이전

프라이빗 클라우드용 Apigee Edge 4.54.00에서는 클래식 UI (edge-ui 구성요소)가 삭제되어 더 이상 사용할 수 없습니다. 새 Edge UI (edge-management-ui 구성요소)는 Private Cloud용 Edge의 유일한 UI입니다.

프라이빗 클라우드용 Edge 4.54.00에서는 edge-ui를 사용할 수 없습니다. /opt/apigee/customer/application/ui.properties에서 속성을 설정하여 기본 UI를 맞춤설정한 경우 새 Edge UI는 해당 파일을 읽지 않습니다. 4.54.00으로 업데이트한 후에는 /opt/apigee/customer/application/management-ui.properties에서 동등한 속성을 설정해야 합니다.

이 페이지에는 ui.properties에 대해 설명된 클래식 UI 속성, 새로운 Edge UI의 해당 속성, 새로운 Edge UI에서 지원되지 않는 클래식 UI 속성이 나열되어 있습니다.

새 Edge UI는 다른 Edge 구성요소와 동일한 구성이 있는 코드 (CwC) 메커니즘을 사용합니다. 자세한 내용은 Edge 구성 방법을 참조하세요.

기본 UI와 새로운 Edge UI 구성 비교

새 Edge UI는 기존 UI 구성요소, 속성 파일, 서비스 이름, 기본 포트, TLS 인증서 형식을 대체합니다. 속성을 이전하기 전에 다음 표를 검토하여 자동화 스크립트, 방화벽 규칙, TLS 파일을 업데이트하세요.

설정 기본 UI (4.53.01 이하) 새 Edge UI (4.54.00)
구성요소 이름 edge-ui edge-management-ui
속성 파일 /opt/apigee/customer/application/ui.properties /opt/apigee/customer/application/management-ui.properties
다시 시작 명령어 apigee-service edge-ui restart apigee-service edge-management-ui restart
기본 포트 9,000 3001
TLS 구성 자바 키 저장소 (JKS) 파일 PEM 인증서 및 키 파일 새 Edge UI용 TLS 구성을 참고하세요.

새 Edge UI의 속성 설정

/opt/apigee/customer/application/management-ui.properties에서 New Edge UI 구성 속성을 설정하고 edge-management-ui 서비스를 다시 시작하여 변경사항을 적용합니다.

새 Edge UI의 속성을 설정하려면 다음 안내를 따르세요.

  1. 편집기에서 management-ui.properties 파일을 엽니다. 파일이 없으면 만듭니다. 
    vi /opt/apigee/customer/application/management-ui.properties
  2. 속성을 설정합니다. 예를 들면 다음과 같습니다. 
    conf_uebe_disableGeoMap=true
  3. 변경사항을 저장합니다.
  4. 파일이 apigee 사용자가 소유하고 있는지 확인합니다. 
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  5. 새 Edge UI를 다시 시작합니다. 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart

새 Edge UI의 속성을 설정할 때는 다음 형식 지정 규칙을 따르세요.

  • 속성 이름은 대소문자를 구분합니다. 예를 들어 conf_uebe_disableGeoMap는 유효하지만 conf_uebe_disablegeomap는 유효하지 않습니다.
  • 문자열 값을 큰따옴표로 묶습니다(예: conf_uebe_branding_companyNameShort="My Company").
  • 불리언 값 (true 또는 false)이나 숫자 값은 따옴표로 묶지 않습니다. 불리언 또는 숫자 값이 따옴표로 묶여 있으면 New Edge UI가 시작되지 않습니다.

속성의 현재 값을 확인하려면 -search 옵션을 사용합니다. 예를 들면 다음과 같습니다.

/opt/apigee/apigee-service/bin/apigee-service edge-management-ui \
  configure -search conf_uebe_disableGeoMap

기존 UI 속성을 새로운 Edge UI에 매핑

다음 표에는 ui.properties의 지원되는 각 클래식 UI 속성이 management-ui.properties의 해당 새 Edge UI 속성에 매핑되어 있습니다. 기본값 열에는 New Edge UI의 기본값이 표시됩니다.

기능 속성 구성

기본 UI 기능 플래그를 management-ui.properties의 해당 conf_uebe_* 속성에 매핑합니다.

기본 UI 속성 새로운 Edge UI 속성 기본값 참고
conf_apigee_apigee.feature.disablegeomap conf_uebe_disableGeoMap false 지역 지도를 숨기려면 true로 설정합니다. 프라이빗 클라우드용 Edge의 클래식 UI에서는 지역 지도가 기본적으로 사용 중지되었습니다. 지역 집계를 사용 설정하지 않은 경우 이 속성을 true로 설정합니다. 지역 집계 및 지역 지도 사용 설정을 참조하세요.
conf_apigee_apigee.feature.disablepasswordreset conf_uebe_disablePasswordReset false 로그인 페이지에서 비밀번호 재설정 링크를 숨기려면 true로 설정합니다.
conf_apigee-base_apigee.feature.enableforcerangelimit conf_uebe_enableForceRangeLimit true 14일이 넘는 기간의 맞춤 보고서를 허용하려면 false로 설정합니다.
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses conf_uebe_trace_for_internal_addresses false Trace 도구가 로컬 또는 내부 IP 주소로 요청을 전송할 수 있도록 true로 설정합니다.
conf_apigee-base_apigee.feature.enableopenapiforinternaladdresses conf_uebe_openapi_for_internal_addresses false OpenAPI 사양을 로컬 또는 내부 IP 주소에서 가져올 수 있도록 하려면 true로 설정합니다.
conf_apigee-base_apigee.feature.enablewsdlforinternaladdresses conf_uebe_wsdl_for_internal_addresses false WSDL 파일을 로컬 또는 내부 IP 주소에서 가져올 수 있도록 하려면 true로 설정합니다.

세션 및 TLS 속성 구성

기본 UI 세션 만료 시간 및 TLS 속성을 management-ui.properties의 새 Edge UI에 해당하는 속성에 매핑합니다.

기본 UI 속성 새로운 Edge UI 속성 기본값 참고
conf_application_session.maxage conf_uebe_authsessiontimeout 12 (시간) 로그인 후 사용자 세션이 만료되는 시간입니다. 시간 수 (예: 12 또는 0.5) 또는 h (시간) 또는 m (분) 단위의 기간 (예: 24h 또는 90m)을 지정합니다. 12 및 12h 값은 동일합니다. d(일) 단위는 지원되지 않습니다. 예를 들어 1d를 24h로 바꿉니다. 값이 유효하지 않으면 기본값인 12시간이 사용되고 오류가 보고되지 않습니다. 기본 인증을 사용하는 세션에 적용됩니다.
conf_application_session.secure 필요 사항 없음 해당 없음 새 Edge UI는 TLS가 사용 설정된 경우(conf_uebe_usehttps=true) 또는 TLS가 부하 분산기에서 TLS 종료되는 경우 (conf_uebe_tlsoffload=true) 세션 쿠키에 Secure 플래그를 자동으로 설정합니다.
conf/application.conf+trustxforwarded conf_uebe_usehttps=true 및 conf_uebe_tlsoffload=true false TLS가 부하 분산기에서 종료되는 경우 두 속성을 모두 설정합니다. 부하 분산기는 HTTP를 통해 새 Edge UI로 요청을 전달하고 X-Forwarded-Proto 헤더를 설정해야 합니다. MANAGEMENT_UI_SCHEME=https 및 MANAGEMENT_UI_TLS_OFFLOAD=y인 경우 configure-ssl 명령어는 이러한 속성을 설정합니다. 새 Edge UI용 TLS 구성을 참고하세요.
conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate conf_uebe_skipverify false 관리 서버에서 자체 서명 인증서를 사용하는 경우에만 true로 설정합니다. Management API용 TLS 구성을 참조하세요.

이메일 속성 및 템플릿 구성

기본 UI 이메일 발신자, 제목, 브랜딩, 호스트 URL, 링크 만료 속성을 새 Edge UI에 매핑합니다.

기본 UI 속성 새로운 Edge UI 속성 기본값 참고
conf_apigee_apigee.mgmt.mailfrom conf_apigee_apigee.mgmt.mailfrom Apigee <sales@apigee.com> 또는 설치 시 지정된 SMTPMAILFROM 값 변경되지 않았습니다.
conf_apigee-base_apigee.emails.passwordreset.subject conf_apigee_apigee.emails.passwordReset.subject Password Reset Request camelCase passwordReset 속성 세그먼트를 확인합니다.
conf_apigee-base_apigee.emails.useraddedexisting.subject conf_apigee_apigee.emails.userAddedExisting.subject You Have Been Added to an Organization {organization} camelCase userAddedExisting 속성 세그먼트를 확인합니다.
conf_apigee-base_apigee.emails.useraddednew.subject conf_apigee_apigee.emails.userAddedNew.subject An Account Has been Created for You at {companyNameShort} camelCase userAddedNew 속성 세그먼트를 확인합니다.
conf_apigee_apigee.branding.companynameshort conf_uebe_branding_companyNameShort Apigee 이메일 제목 및 템플릿에서 {companyNameShort} 자리표시자의 값을 설정합니다.
conf_apigee_apigee.emails.hosturl conf_apigee_apigee.emails.hosturl 없음 변경되지 않았습니다. 설정되지 않은 경우 비밀번호 재설정 링크는 설치 시 지정된 New Edge UI의 URL을 사용하고 사용자 초대 링크는 요청의 호스트 이름을 사용합니다. 사용자가 부하 분산기나 DNS 이름(예: conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com")을 통해 새 Edge UI에 액세스하는 경우 이 속성을 설정합니다.
conf_apigee_apigee.forgotpassword.emaillinkexpiryseconds conf_apigee_apigee.forgotPassword.EmailLinkExpirySeconds 600 비밀번호 재설정 링크 및 사용자 초대 링크에 적용됩니다.

새 Edge UI는 기본 제공 이메일 템플릿을 사용합니다. 기본 UI에 맞춤설정한 템플릿을 사용하려면 다음 안내를 따르세요.

  1. /opt/apigee/edge-management-ui/email-templates 디렉터리를 만듭니다.
  2. 업데이트하기 전에 만든 백업 디렉터리 (예: /opt/apigee/customer/backup/)에서 맞춤설정된 password-reset.html, user-added-existing.html, user-added-new.html 파일을 /opt/apigee/edge-management-ui/email-templates에 복사합니다. 템플릿 파일 이름과 자리표시자는 기본 UI와 동일합니다.
  3. 디렉터리와 파일이 apigee 사용자가 소유하고 있는지 확인합니다.
  4. 새 Edge UI를 다시 시작합니다.

자세한 내용은 Edge 이메일 템플릿 맞춤설정을 참조하세요.

자동 생성 비밀번호 속성 구성

기본 UI 자동 생성 비밀번호 속성을 새 Edge UI에 매핑합니다.

기존 UI 속성 새로운 Edge UI 속성 기본값
conf_apigee-base_apigee.forgotPassword.underscore.minimum conf_apigee_apigee.forgotPassword.underscore.minimum 0
conf_apigee-base_apigee.forgotPassword.specialchars.minimum conf_apigee_apigee.forgotPassword.specialchars.minimum 0
conf_apigee-base_apigee.forgotPassword.lowecase.minimum conf_apigee_apigee.forgotPassword.lowecase.minimum 0
conf_apigee-base_apigee.forgotPassword.uppercase.minimum conf_apigee_apigee.forgotPassword.uppercase.minimum 0

관리 서버 연결 및 공유 보안 비밀 속성 구성

기본 UI 관리 서버 연결, 사용자 인증 정보, 애플리케이션 보안 비밀 속성을 새 Edge UI에 매핑합니다.

기존 UI 속성 새로운 Edge UI 속성 참고
conf_apigee_apigee.mgmt.baseurl mgmt_baseurl 관리 API의 URL입니다(예: https://FQ_domain_name:port/v1). 이 속성 이름은 conf_로 시작하지 않습니다. 관리 서버가 자체 서명 인증서를 사용하는 경우 conf_uebe_skipverify=true도 설정합니다.
conf_apigee_apigee.mgmt.credential conf_uebe_mgmtCredential 암호화된 시스템 관리자 사용자 인증 정보입니다. ./bin/management-ui --encrypt를 사용하여 새 Edge UI의 사용자 인증 정보를 다시 암호화해야 합니다. 다양한 시스템 관리자 사용자 인증 정보에 필요한 구성을 참고하세요.
conf_apigee_mail.smtp.credential conf_apigee_mail.smtp.credential 암호화된 SMTP 사용자 인증 정보입니다.
conf_application_application.secret conf_uebe_applicationsecret 사용자 인증 정보 및 세션 쿠키를 암호화하는 데 사용되는 보안 비밀입니다. 설치 시간에 생성됩니다.

조치가 필요하지 않은 기존 UI 속성 삭제

동작이 항상 사용 설정되어 있으므로 다음 기존 UI 속성은 새로운 Edge UI에 상응하는 속성이 없습니다. management-ui.properties에 이러한 속성을 포함하지 마세요. 자동 구성 스크립트에서 이러한 속성을 삭제하세요.

기본 UI 속성 새로운 Edge UI의 동작
conf_apigee_apigee.feature.expireSessionCookiesInternally 세션 만료는 항상 서버에서 검증됩니다.
conf_apigee_apigee.feature.trackSessionCookies 세션 정보는 항상 서버 메모리에 저장됩니다. 부하 분산기 뒤에 New Edge UI의 여러 인스턴스를 사용하는 경우 고정 세션을 사용하도록 부하 분산기를 구성합니다.

지원되지 않는 기존 UI 속성 삭제

다음 기존 UI 속성은 지원되지 않으며 새로운 Edge UI에 상응하는 속성이 없습니다. management-ui.properties에 이러한 속성을 포함하지 마세요 (자동 구성 스크립트에서 삭제).

기본 UI 속성 설명
conf_apigee_apigee.feature.apitimeout, conf_apigee_play.ws.timeout.idle, conf_apigee_play.ws.timeout.connection 관리 API 호출의 제한 시간은 New Edge UI에서 구성할 수 없습니다.
conf_application_http.proxyhost, conf_application_http.proxyport, conf_application_http.proxyuser, conf_application_http.proxypassword 새 Edge UI는 Trace 도구 요청에 대한 전달 프록시를 지원하지 않습니다.
conf_apigee-base_apigee.feature.enableconsentbanner, conf_apigee-base_apigee.consentbanner.buttoncaption, conf_apigee-base_apigee.consentbanner.body 동의 배너는 새로운 Edge UI에서 지원되지 않습니다.
conf_apigee-base_apigee.feature.apiproxypaginationenabled, conf_apigee-base_apigee.pagination.apiproxypaginationbatchsize 새 Edge UI에서 API 프록시 목록은 항상 페이지에 로드됩니다. 페이지 크기는 구성할 수 없습니다.
conf_logger_settings_application_log_level, conf_logger_settings_play_log_level, conf_application_logger.application 로그 수준은 New Edge UI에서 구성할 수 없습니다. 로그 파일은 /opt/apigee/var/log/edge-management-ui에 기록됩니다.
bin_setenv_min_mem, bin_setenv_max_mem, bin_setenv_meta_space_size, bin_setenv_ext_jvm_opts 새 Edge UI는 Java 가상 머신에서 실행되지 않습니다. Java 메모리 설정이 적용되지 않습니다.

이전 예시 검토

다음 예에서는 기본 UI ui.properties 파일과 새 Edge UI의 해당 management-ui.properties 파일을 비교합니다.

기본 UI, /opt/apigee/customer/application/ui.properties:

conf_apigee_apigee.feature.disablegeomap=false
conf_apigee-base_apigee.feature.enabletraceforinternaladdresses="true"
conf_application_session.maxage="1d"
conf_apigee-base_apigee.emails.passwordreset.subject="Reset your My Company password"
conf_apigee_apigee.branding.companynameshort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

새 Edge UI, /opt/apigee/customer/application/management-ui.properties:

conf_uebe_disableGeoMap=false
conf_uebe_trace_for_internal_addresses=true
conf_uebe_authsessiontimeout=24
conf_apigee_apigee.emails.passwordReset.subject="Reset your My Company password"
conf_uebe_branding_companyNameShort="My Company"
conf_apigee_apigee.emails.hosturl="https://ui.mycompany.com"

불리언 값 true는 따옴표로 묶이지 않으며 세션 만료 시간 1d은 24로 대체됩니다.

파일을 저장한 후 New Edge UI를 다시 시작합니다.

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

요약 체크리스트

다음 체크리스트를 사용하여 Apigee 프라이빗 클라우드용 Edge 4.54.00에서 New Edge UI로의 마이그레이션을 완료하세요.

  1. 업그레이드하기 전에 /opt/apigee/customer/application/ui.properties 및 /opt/apigee/edge-ui/email-templates의 맞춤설정된 이메일 템플릿을 백업합니다.
  2. 불리언 또는 숫자 값을 따옴표로 묶지 않고 /opt/apigee/customer/application/management-ui.properties에 매핑된 속성을 추가하고 지원되지 않는 기존 UI 속성은 생략합니다.
  3. 백업 디렉터리에서 /opt/apigee/edge-management-ui/email-templates로 맞춤설정된 이메일 템플릿을 복사합니다.
  4. conf_uebe_mgmtCredential를 설정한 경우 ./bin/management-ui --encrypt를 사용하여 sysadmin 사용자 인증 정보를 다시 암호화합니다.
  5. 파일 소유권을 apigee:apigee로 설정하고 edge-management-ui를 다시 시작합니다.