개발자 서비스 포털 설치

Private Cloud용 Edge v4.18.01

설치하기 전에 다음을 확인하세요.

  • 포털을 설치하기 전에 Postgres를 설치합니다. Postgres를 또는 포털에서 사용할 Postgres를 독립형으로 설치하세요.
    • Postgres를 독립형으로 설치하면 포털과 동일한 노드에 설치될 수 있습니다.
    • Edge의 일부로 설치된 Postgres에 연결 중이며 Postgres가 구성된 경우 마스터/대기 모드에서 마스터 Postgres 서버의 IP 주소를 지정합니다.
  • 지원되는 Red Hat 버전의 64비트 버전에서 설치를 수행하고 있습니다. Enterprise Linux, CentOS, Oracle입니다. 다음 페이지에서 지원되는 버전 목록을 참조하십시오. 지원되는 소프트웨어 및 지원되는 버전
  • Yum이 설치되어 있습니다.

설치 프로그램에는 Apigee 개발자 서비스 포털 (또는 간단히 포털)입니다. 다른 제공된 모듈 설치에 관한 자세한 내용은 다음을 참고하세요. Drupal 7 확장.

설치 개요

노드에 Edge apigee-setup 유틸리티를 설치한 후 이를 사용합니다. 유틸리티를 사용하여 노드에 포털을 설치할 수 있습니다. apigee-setup 유틸리티의 형식은 다음과 같습니다.

sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

다음 항목이 포함된 apigee-setup 유틸리티에 구성 파일을 전달합니다. 설치에 대한 정보를 제공합니다. 구성 파일에 필수 항목이 누락된 경우 apigee-setup 유틸리티가 명령줄에 이를 입력하라는 메시지를 표시합니다.

유일한 요구사항은 'Apigee' 있습니다.

예를 들어 다음 명령어를 사용하여 포털을 설치합니다.

sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

Edge Apigee-setup 유틸리티 설치를 참조하세요. 확인하세요.

SMTPSSL 속성 지원 중단

이전 출시에서는 SMTPSSL 속성을 사용하여 포털에 연결된 SMTP 서버에서 사용하는 프로토콜을 설정합니다. 해당 속성은 지원 중단되었습니다.

이제 SMTP_PROTOCOL 속성을 사용합니다. SMTPSSL 속성 대신 포털에 연결된 SMTP 서버에서 사용하는 프로토콜입니다. 유효한 값은 'standard', 'ssl' 또는 'tls'

구성 파일 만들기

다음은 포털 설치를 위한 자동 구성 파일의 예입니다. 이 파일 수정 필요에 따라 변경할 수 있습니다 setup.sh에 -f 옵션을 사용하여 이를 포함합니다. 파일에서 참조됩니다.

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres.
PG_NAME=devportal 

# Specify the Postgres admin credentials.
# The portal connects to Postgres by using the 'apigee' user.
# If you changed the Postgres password from the default of 'postgres'
# then set PG_PWD accordingly.
# If connecting to a Postgres node installed with Edge,
# contact the Edge sys admin to get these credentials.
PG_USER=apigee
PG_PWD=postgres

# The IP address of the Postgres server.
# If it is installed on the same node as the portal, specify that IP.
# If connecting to a remote Postgres server,specify its IP address.
PG_HOST=$IP1

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# Optionally configure the SMTP server used by the portal. 
# If you do, the properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the 
# SMTPSSL property. That property has been deprecated. 
SMTP_PROTOCOL="standard" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

1. Apigee Edge 연결 테스트

다음 cURL 명령어를 실행하여 에지 관리 서버에 대한 연결을 테스트합니다. 포털 서버의 명령 프롬프트에서:

curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

또는:

curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/v1/organizations/{ORGNAME}

여기서 EMAILPASSWORD는 이메일입니다. ORGNAME 관리자의 주소와 비밀번호입니다.

Edge 설치에 해당하는 호스트 이름과 포트 번호를 지정해야 합니다. 포트 8080은 Edge에서 사용하는 기본 포트입니다. 클라우드의 조직에 연결하는 경우 요청 URL은 https://api.enterprise.apigee.com/v1/organizations/ORGNAME입니다.

성공하면 이 명령어는 다음과 유사한 응답을 반환합니다.

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. PHP 7.0 이전 버전 삭제

설치 스크립트는 설치해야 합니다 PHP 7.0 이전 버전이 있는 경우 다음과 같은 경고 메시지가 표시됩니다.

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

다음 명령어를 사용하여 PHP 패키지를 삭제합니다.

yum remove package-name

3. Postgres 설치

포털을 설치하려면 먼저 Postgres를 설치해야 합니다. 다음 중 원하는 방법을 선택하면 됩니다. Edge 설치 과정에서 Postgres를 설치하거나, 있습니다.

  • Edge의 일부로 설치된 Postgres에 연결 중이며 Postgres가 마스터/대기 모드에서 마스터 Postgres 서버의 IP 주소를 지정합니다.
  • Postgres를 독립형으로 설치하면 포털과 동일한 노드에 설치될 수 있습니다.

Edge 설치 과정에서 Postgres를 설치하는 방법에 대한 자세한 내용은 다음을 참조하세요. 노드에 Edge 구성요소를 설치합니다.

독립형 Postgres를 설치하려면 다음 안내를 따르세요.

  1. 다음을 사용하여 노드에 Edge apigee-setup 유틸리티를 설치합니다. 비인터넷 절차입니다. 자세한 내용은 자세한 내용을 보려면 Edge Apigee-setup 유틸리티를 설치하세요.
  2. 아래와 같이 Postgres용 구성 파일을 만듭니다.
    # Must resolve to IP address or DNS
        name of host - not to 127.0.0.1 or localhost.
        HOSTIP=$(hostname -i)
    
        # The pod and region of Postgres. Use the default values shown below.
        MP_POD=gateway
        REGION=dc-1
    
        # Set the Postgres password. The default value is 'postgres'.
        PG_PWD=postgres
  3. 명령어 프롬프트에서 설정 스크립트를 실행하여 Postgres를 설치합니다.
    /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    -p pdb 옵션은 Postgre를 설치하도록 지정합니다. 구성 파일은 'Apigee'에서 액세스하거나 읽을 수 있어야 합니다. 있습니다.

4. 포털 설치

포털을 설치하려면 다음 안내를 따르세요.

  1. 다음에 Edge apigee-setup 유틸리티 설치 인터넷 또는 비인터넷 절차를 사용하여 노드에 전송합니다. 자세한 내용은 다음을 위한 Edge Apigee-setup 유틸리티 설치 자세히 알아보세요.
  2. Postgres를 독립형으로 또는 Edge를 설치합니다
  3. 명령어 프롬프트에서 설정 스크립트를 실행합니다.
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    -p dp 옵션은 포털을 설치하도록 지정합니다.

    구성 파일은 'Apigee'에서 액세스하거나 읽을 수 있어야 합니다. 있습니다.

  4. 포털 홈페이지(http://localhost:8079) 또는 DNS 이름으로 이동합니다. 있습니다.
  5. 구성 파일에서 설정한 관리자 사용자 인증 정보를 사용하여 포털에 로그인합니다. 포털이 제대로 실행되는지 확인합니다
  6. 보고서 > Drupal 메뉴의 상태 보고서를 사용하여 현재 포털의 상태를 확인할 수 있습니다.

5. 업데이트 관리자 모듈이 사용중

Drupal 업데이트 알림을 받으려면 Drupal 업데이트 관리자 모듈이 사용 설정되어 있는지 확인합니다. 사용 설정되어 있습니다. Drupal 메뉴에서 Modules를 선택하고 업데이트 관리자 모듈 사용 설정되어 있지 않으면 사용 설정합니다.

사용 설정한 후에는 보고서 > 사용 가능 업데이트 메뉴 항목을 선택합니다. 다음과 같은 Drush 명령어를 사용할 수도 있습니다.

drush pm-info update

이 명령어는 사이트의 루트 디렉터리에서 실행해야 합니다. 기본적으로 개발자는 포털이 /opt/apigee/apigee-drupal/wwwroot에 설치되었습니다. 따라서 먼저 디렉터리를 /opt/apigee/apigee-drupal/wwwroot로 변경해야 실행할 수 있습니다 기본 디렉터리에 포털을 설치하지 않은 경우 설치 디렉터리에 들어갑니다

보고서 > 사용 가능한 업데이트 > 구성할 설정 메뉴 항목 모듈에서 업데이트가 가능할 때 이메일을 발송하고 업데이트.

6. Apache Solr 검색엔진 구성 (선택사항)

기본적으로 Apache Solr 검색엔진에 연결되는 Drupal 모듈은 포털을 설치합니다 대부분의 포털은 내부 Drupal 검색엔진을 사용하므로 Drupal Solr 모듈이 필요합니다

Solr을 검색엔진으로 사용하려면 서버에 로컬로 Solr를 설치해야 합니다. 포털에서 Drupal Solr 모듈을 사용 설정하고 구성합니다.

Drupal Solr 모듈을 사용 설정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 메뉴에서 Modules를 선택합니다.
  3. Apache Solr Framework 모듈 및 Apache Solr를 사용 설정합니다. 검색 모듈을 마칩니다.
  4. 변경사항을 저장합니다.
  5. 다음 페이지에 설명된 대로 Solr를 구성합니다. https://drupal.org/node/1999280.

7. SmartDocs 설치 (선택사항)

SmartDocs를 사용하면 개발자 서비스 포털의 API를 완전히 상호작용할 수 있는 API 문서입니다. 포털에서 SmartDocs를 사용하려면 먼저 Edge에 SmartDocs를 설치하세요.

  • Edge Cloud 설치에 포털을 연결하는 경우 SmartDocs가 이미 추가 구성이 필요하지 않습니다
  • Private Cloud 설치를 위해 포털을 Edge에 연결하는 경우 SmartDocs가 Edge에 설치되어 있습니다 Edge 및 SmartDocs 설치에 관한 자세한 내용은 다음을 참고하세요. SmartDocs를 설치합니다.

포털에서 SmartDocs도 사용 설정해야 합니다. SmartDocs에 대한 자세한 내용은 다음을 참고하세요. SmartDocs를 사용하여 문서화하기 API를 참고하세요.

8. 구성: 인터넷 이외의 설치를 위한 JQuery 업데이트 모듈 (선택사항)

인터넷이 아닌 설치 환경에서 JQuery 업데이트 모듈을 설치 및 사용하는 경우 JQuery의 로컬 버전을 사용하도록 모듈을 구성합니다. CDN을 사용하도록 모듈을 구성하는 경우 인터넷이 아닌 다른 방법으로 설치된 경우, CDN에 액세스하려 하므로 페이지 로드가 있습니다. JQuery 업데이트 모듈에 대한 자세한 내용은 다음을 참조하세요. https://www.drupal.org/project/jquery_update.

JQuery의 로컬 버전을 사용하도록 JQuery 업데이트 모듈을 구성하려면 다음 단계를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 구성 > 개발 > Drupal 메뉴에서 JQuery Update를 사용합니다.
  3. 왼쪽 탐색 메뉴에서 실적을 클릭합니다.
  4. JQuery 및 JQuery UI CDN 드롭다운에서 없음을 선택합니다.
  5. 구성 저장을 클릭합니다.

9. 다음 단계

개발자 서비스 포털을 설치한 후 다음 단계는 구성 및 맞춤설정입니다. 맞춤설정할 수 있습니다 Apigee 웹사이트의 문서에는 포털 구성, 스타일 지정, 관리에 대한 정보 다음 페이지에서 문서에 액세스하세요. http://apigee.com/docs/developer-services/content/what-developer-portal.

다음 표에는 설치 후 수행하는 가장 일반적인 작업이 나열되어 있습니다. 여기에는 자세한 내용을 확인할 수 있는 Apigee 문서 링크가 포함되어 있습니다.

작업 설명

테마 맞춤설정

테마는 색상, 스타일 및 기타 요소를 포함하여 포털의 모양을 정의합니다. 볼 수 있습니다.

디자인

홈페이지에는 기본 메뉴, 환영 메시지, 머리글, 바닥글, 제목이 포함됩니다.

추가 및 사용자 계정 관리

등록 프로세스는 신규 개발자가 있습니다. 예를 들어 신규 개발자가 포털에 즉시 액세스할 수 있나요? 관리자가 확인해야 합니다. 이 프로세스는 포털에서 새 계정이 생성되면 관리자에게 알림이 전송됩니다.

구성 이메일

포털에서 특정 이벤트에 대한 응답으로 이메일을 전송합니다. 예를 들어 개발자가 포털에 등록하고 개발자가 비밀번호를 잊어버린 경우

추가 및 사용자 계정 관리

약관 추가 및 앱이 허용되기 전에 개발자가 동의해야 하는 조건 페이지 확인할 수 있습니다

추가 및 사용자 계정 관리

포털에서 역할 기반 승인 모델을 구현합니다. 개발자가 포털에서 사용하는 권한과 역할을 정의합니다.

블로그 및 포럼 게시물

포털에서는 블로그 및 대화목록 형식 포럼을 기본적으로 지원합니다. 권한 정의 블로그 및 포럼 게시물을 보고, 추가하고, 수정하고, 삭제하는 데 필요합니다.

데이터베이스 백업 수행 확인

Drupal 데이터베이스를 백업하고 있는지 확인합니다. 모든 데이터가 백업하는 방식이 다르기 때문에 해당 애플리케이션을 설치하는 가장 좋은 방법은 데이터베이스입니다.

참고: 백업 및 마이그레이션 모듈은 Postgres와 호환되지 않습니다. 살펴보겠습니다

백업 방법도 참조하세요.

호스트 이름 설정

DNS 서버에 호스트 이름을 설정하지 않은 경우 언제든지 다음을 통해 사이트에 액세스할 수 있습니다. 서버의 IP 주소입니다. 호스트 이름을 사용하려면 다음을 위해 DNS를 구성할 수 있습니다. 기본 설정에 다른 구성이 없어도 올바르게 작동합니다.

부하 분산기를 설정했거나 사이트에 잘못된 URL이 수신되는 경우 다른 이유로 다음 단계에 따라 Drupal에 $base_url를 설정할 수 있습니다.

  1. /opt/apigee/data/apigee-drupal-devportal/sites/default/includes 디렉터리를 만듭니다. 찾을 수 없습니다.
  2. 이 디렉터리에 settings.php라는 파일을 만듭니다.
  3. settings.php 파일에 다음을 추가합니다.
    /**
    * Base URL (optional).
    *
    * If Drupal is generating incorrect URLs on your site, which could
    * be in HTML headers (links to CSS and JS files) or visible links
    * on pages (such as in menus), uncomment the Base URL statement
    * below (remove the leading hash sign) and fill in the absolute URL
    * to your Drupal installation.
    *
    * You might also want to force users to use a given domain.
    * See the .htaccess file for more information.
    *
    * Examples:
    *   $base_url = 'http://www.example.com';
    *   $base_url = 'http://www.example.com:8888';
    *   $base_url = 'http://www.example.com/drupal';
    *   $base_url = 'https://www.example.com:8888/drupal';
    *
    * It is not allowed to have a trailing slash; Drupal will add it
    * for you.
    */
    # $base_url = 'http://www.example.com/';  // NO trailing slash!
    $base_url = ‘http://www.example.com’;
    
  4. 마지막 $base_url 줄을 사이트의 호스트 이름으로 변경합니다.
  5. 파일을 저장합니다.

/opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php의 다른 설정은 이 파일에 배치할 수 있습니다.

$base_url 속성에 관한 자세한 내용은 다음을 참고하세요.

커스텀 개발 외부 맞춤 코드를 사용하여 포털의 기능을 확장할 수도 있습니다. 있습니다. 이렇게 하려면 Drupal의 모듈 개발 주제를 살펴보고 모듈을 /sites/all/modules에 넣습니다. 를 참조하세요.