ติดตั้งพอร์ทัล

Edge for Private Cloud v4.18.05

ก่อนติดตั้งพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ Apigee (หรือเรียกสั้นๆ ว่าพอร์ทัล) โปรดตรวจสอบว่าคุณได้ดำเนินการต่อไปนี้แล้ว

1. คุณติดตั้ง Postgres ก่อนติดตั้งพอร์ทัล คุณจะติดตั้ง Postgres เป็นส่วนหนึ่งของการติดตั้ง Edge หรือติดตั้ง Postgres แบบสแตนด์อโลนเพื่อใช้โดยพอร์ทัลก็ได้
   • หากคุณติดตั้ง Postgres แบบสแตนด์อโลน ก็สามารถติดตั้งในโหนดเดียวกับพอร์ทัลได้
   • หากคุณกำลังเชื่อมต่อกับ Postgres ที่ติดตั้งเป็นส่วนหนึ่งของ Edge และมีการกำหนดค่า Postgres ในโหมดมาสเตอร์/สแตนด์บาย ให้ระบุที่อยู่ IP ของเซิร์ฟเวอร์ Postgres หลัก
2. คุณกำลังติดตั้งใน Red Hat Enterprise Linux, CentOS หรือ Oracle เวอร์ชัน 64 บิตที่รองรับ ดูรายการเวอร์ชันที่รองรับได้ที่ซอฟต์แวร์และเวอร์ชันที่รองรับ
3. ติดตั้ง Yum แล้ว

โปรแกรมติดตั้งจะมีเฉพาะโมดูลที่ Drupal สนับสนุนซึ่งจำเป็นสำหรับพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ Apigee (หรือเรียกสั้นๆ ว่าพอร์ทัล) ดูข้อมูลเกี่ยวกับการติดตั้งโมดูลอื่นๆ ที่มีส่วนร่วมได้ที่การขยาย Drupal 7

ภาพรวมการติดตั้ง

หากต้องการติดตั้งพอร์ทัล ให้ทำตามขั้นตอนต่อไปนี้ เราจะอธิบายขั้นตอนเหล่านี้แต่ละขั้นตอนอย่างละเอียดในส่วนถัดไป

1. ทดสอบการเชื่อมต่อ
2. นำ PHP เวอร์ชันก่อน 7.0 ออก
3. ติดตั้ง Postgres
4. ติดตั้งพอร์ทัล
5. ตรวจสอบว่าเปิดใช้เครื่องมือจัดการการอัปเดตแล้ว
6. (ไม่บังคับ) กำหนดค่า Apache Solr
7. (ไม่บังคับ) ติดตั้ง SmartDocs
8. (ไม่บังคับ) กำหนดค่า JQuery

การเลิกใช้งานพร็อพเพอร์ตี้ SMTPSSL

ในรุ่นก่อนหน้า คุณใช้พร็อพเพอร์ตี้ SMTPSSL เพื่อตั้งค่าโปรโตคอลที่เซิร์ฟเวอร์ SMTP ใช้ซึ่งเชื่อมต่อกับพอร์ทัล เราเลิกใช้งานพร็อพเพอร์ตี้นั้นแล้ว

ตอนนี้คุณใช้พร็อพเพอร์ตี้ SMTP_PROTOCOL แทนพร็อพเพอร์ตี้ SMTPSSL เพื่อตั้งค่าโปรโตคอลที่เซิร์ฟเวอร์ SMTP ใช้ซึ่งเชื่อมต่อกับพอร์ทัล ค่าที่ใช้ได้คือ "standard", "ssl" หรือ "tls"

สร้างไฟล์การกำหนดค่าพอร์ทัล

ด้านล่างนี้คือตัวอย่างไฟล์การกำหนดค่าแบบไม่มีการโต้ตอบสำหรับการติดตั้งพอร์ทัล แก้ไขไฟล์นี้ตามที่จำเป็นสำหรับการกำหนดค่าของคุณ ใช้ตัวเลือก -f เพื่อ setup.sh เพื่อรวมไฟล์นี้

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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

# 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=YOUR_EMAIL_PASSWORD

1. ทดสอบการเชื่อมต่อกับ Apigee Edge

ทดสอบการเชื่อมต่อระหว่างเซิร์ฟเวอร์ที่คุณจะติดตั้งพอร์ทัลกับเซิร์ฟเวอร์การจัดการ 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

โดยที่ EMAIL และ PASSWORD คืออีเมลและรหัสผ่านของผู้ดูแลระบบสำหรับ ORGNAME

อย่าลืมระบุชื่อโฮสต์และหมายเลขพอร์ตที่เจาะจงสำหรับการติดตั้ง Edge ของคุณ พอร์ต 8080 คือพอร์ตเริ่มต้นที่ Edge ใช้ หากคุณเชื่อมต่อกับองค์กรในระบบคลาวด์ URL คำขอจะเป็น https://api.enterprise.apigee.com/v1/organizations/ORGNAME

หากทำสำเร็จ curl จะแสดงผลการตอบกลับที่คล้ายกับตัวอย่างต่อไปนี้

{
  "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 ในระบบก่อนเริ่มการติดตั้ง หากมี 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

หากไม่แน่ใจว่ามีการติดตั้ง PHP ในเซิร์ฟเวอร์หรือไม่ ให้ใช้คำสั่งต่อไปนี้

rpm -qa | grep -i php

3. ติดตั้ง Postgres

พอร์ทัลกำหนดให้ต้องติดตั้ง Postgres ก่อนจึงจะติดตั้งพอร์ทัลได้ คุณจะติดตั้ง Postgres เป็นส่วนหนึ่งของการติดตั้ง Edge หรือติดตั้ง Postgres แบบสแตนด์อโลนเพื่อใช้โดยพอร์ทัลก็ได้

• หากคุณกำลังเชื่อมต่อกับ Postgres ที่ติดตั้งเป็นส่วนหนึ่งของ Edge และมีการกำหนดค่า Postgres ในโหมดมาสเตอร์/สแตนด์บาย ให้ระบุที่อยู่ IP ของเซิร์ฟเวอร์ Postgres มาสเตอร์
• หากคุณติดตั้ง Postgres แบบสแตนด์อโลน ก็สามารถติดตั้งในโหนดเดียวกับพอร์ทัลได้

ดูข้อมูลเกี่ยวกับการติดตั้ง Postgres เป็นส่วนหนึ่งของการติดตั้ง Edge ได้ที่หัวข้อติดตั้งคอมโพเนนต์ Edge ในโหนด

วิธีติดตั้ง Postgres แบบสแตนด์อโลน

1. ติดตั้งยูทิลิตี Edge apigee-setup ในโหนดโดยใช้ขั้นตอนแบบใช้อินเทอร์เน็ตหรือไม่ใช้อินเทอร์เน็ต ดูข้อมูลเพิ่มเติมได้ที่ติดตั้งยูทิลิตี apigee-setup ของ Edge
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. ที่ Command Prompt ให้เรียกใช้สคริปต์การตั้งค่าเพื่อติดตั้ง Postgres ดังนี้

   /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

   ตัวเลือก -p pdb จะระบุให้ติดตั้ง Postgre ไฟล์การกำหนดค่าต้องเข้าถึงหรืออ่านได้โดยผู้ใช้ "apigee"

4. ติดตั้งพอร์ทัล

ก่อนติดตั้งพอร์ทัล โปรดตรวจสอบว่าคุณได้ทำสิ่งต่อไปนี้ตามที่อธิบายไว้ใน3 ติดตั้ง Postgres:

1. ติดตั้งยูทิลิตี Edge apigee-setup ในโหนดของพอร์ทัล
2. ติดตั้ง Postgres ไม่ว่าจะเป็น Postgres แบบสแตนด์อโลนหรือเป็นส่วนหนึ่งของการติดตั้ง Edge

วิธีติดตั้งพอร์ทัล

1. เรียกใช้สคริปต์ setup ที่ Command Prompt ดังนี้

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   สถานที่:

   • configFile คือไฟล์การกำหนดค่าพอร์ทัลตามที่อธิบายไว้ในสร้างไฟล์การกำหนดค่าพอร์ทัล
   • -p dp จะสั่งให้สคริปต์ setup ติดตั้งพอร์ทัล

วิธีตรวจสอบว่าการติดตั้งพอร์ทัลสำเร็จ

1. ไปที่หน้าแรกของพอร์ทัลที่ http://localhost:8079 หรือไปที่ชื่อ DNS ของพอร์ทัล
2. เข้าสู่ระบบพอร์ทัลโดยใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบที่คุณตั้งค่าไว้ในไฟล์การกำหนดค่าพอร์ทัล
3. เลือกรายงาน > รายงานสถานะในเมนู Drupal เพื่อให้แน่ใจว่าคุณเห็นสถานะปัจจุบันของพอร์ทัล
4. ตรวจสอบว่าการเชื่อมต่อ Management Server สำเร็จแล้ว หากไม่ใช่ ให้ทำดังนี้
   1. ไปที่หน้าการกำหนดค่าการเชื่อมต่อพอร์ทัล (เช่น http://portal_IP:8079/admin/config/devconnect)
   2. คลิกปุ่มทดสอบการเชื่อมต่อ หากเชื่อมต่อสำเร็จ แสดงว่าเสร็จสิ้นแล้ว หากการเชื่อมต่อล้มเหลว ให้ดำเนินการต่อ
   3. ตรวจสอบการตั้งค่าปลายทางและการตรวจสอบสิทธิ์โดยทำดังนี้
      • URL ปลายทางของ Management API: ตรวจสอบว่าโปรโตคอล (HTTP หรือ HTTPS), IP หรือชื่อ DNS และหมายเลขพอร์ตถูกต้อง เช่น

        http://10.10.10.10:8080/v1

      • Endpoint authenticated user: ชื่อผู้ใช้ของผู้ดูแลระบบขององค์กร
      • รหัสผ่านของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว: รหัสผ่านของผู้ดูแลระบบขององค์กร

      ค่าเริ่มต้นจะแสดงการตั้งค่าในไฟล์การกำหนดค่าพอร์ทัลที่คุณสร้างขึ้นในระหว่างกระบวนการติดตั้ง

      ค่าเหล่านี้ควรตรงกับค่า ms_IP_or_DNS, email และ password ที่คุณใช้ในขั้นตอนที่ 1: ทดสอบการเชื่อมต่อกับ Apigee Edge ชื่อผู้ใช้และรหัสผ่านควรตรงกับค่าของพร็อพเพอร์ตี้ USER_NAME และ USER_PWD ในไฟล์การกำหนดค่าการเริ่มต้นใช้งาน หรือข้อมูลเข้าสู่ระบบของผู้ใช้ที่มีบทบาทเป็นผู้ดูแลระบบองค์กร

   4. หลังจากเชื่อมต่อกับเซิร์ฟเวอร์การจัดการเรียบร้อยแล้ว ให้คลิกปุ่มบันทึกการกำหนดค่าที่ด้านล่างของหน้าเพื่อบันทึกการเปลี่ยนแปลง

5. ตรวจสอบว่าเปิดใช้โมดูล Update manager แล้ว

หากต้องการรับการแจ้งเตือนเกี่ยวกับการอัปเดต Drupal ให้ตรวจสอบว่าได้เปิดใช้โมดูล Drupal Update manager แล้ว จากเมนู Drupal ให้เลือกโมดูล แล้วเลื่อนลงไปที่โมดูลเครื่องมือจัดการการอัปเดต หากไม่ได้เปิดใช้ ให้เปิดใช้

เมื่อเปิดใช้แล้ว คุณจะดูการอัปเดตที่พร้อมใช้งานได้โดยใช้รายการเมนูรายงาน > การอัปเดตที่พร้อมใช้งาน นอกจากนี้ คุณยังใช้คำสั่ง Drush ต่อไปนี้ได้ด้วย

drush pm-info update

คุณต้องเรียกใช้คำสั่งนี้จากไดเรกทอรีรากของเว็บไซต์ โดยค่าเริ่มต้น พอร์ทัลจะติดตั้งที่ /opt/apigee/apigee-drupal/wwwroot ดังนั้น คุณควรเปลี่ยนไดเรกทอรีเป็น /opt/apigee/apigee-drupal/wwwroot ก่อนเรียกใช้คำสั่ง หากคุณไม่ได้ติดตั้งพอร์ทัลในไดเรกทอรีเริ่มต้น ให้เปลี่ยนเป็นไดเรกทอรีการติดตั้งของคุณ

ใช้รายการเมนูรายงาน > การอัปเดตที่พร้อมใช้งาน > การตั้งค่าเพื่อกำหนดค่าโมดูลให้ส่งอีเมลถึงคุณเมื่อมีการอัปเดต และตั้งค่าความถี่ในการตรวจสอบการอัปเดต

6. กำหนดค่าเครื่องมือค้นหา Apache Solr (ไม่บังคับ)

โดยค่าเริ่มต้น โมดูล Drupal ที่เชื่อมต่อกับเครื่องมือค้นหา Apache Solr จะปิดใช้เมื่อคุณติดตั้งพอร์ทัล พอร์ทัลส่วนใหญ่ใช้เครื่องมือค้นหา Drupal ภายใน จึงไม่จำเป็นต้องใช้โมดูล Drupal Solr

หากตัดสินใจใช้ Solr เป็นเครื่องมือค้นหา คุณต้องติดตั้ง Solr ในเครื่องบนเซิร์ฟเวอร์ จากนั้นเปิดใช้และกำหนดค่าโมดูล Drupal Solr ในพอร์ทัล

วิธีเปิดใช้โมดูล Drupal Solr

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบหรือสิทธิ์ในการสร้างคอนเทนต์
2. เลือก Modules ในเมนู Drupal
3. เปิดใช้โมดูล Apache Solr Framework และโมดูล Apache Solr Search
4. บันทึกการเปลี่ยนแปลง
5. กำหนดค่า Solr ตามที่อธิบายไว้ที่ https://drupal.org/node/1999280

7. ติดตั้ง SmartDocs (ไม่บังคับ)

SmartDocs ช่วยให้คุณจัดทำเอกสาร API ในพอร์ทัลในลักษณะที่ทำให้เอกสารประกอบ API เป็นแบบอินเทอร์แอกทีฟอย่างเต็มรูปแบบ อย่างไรก็ตาม หากต้องการใช้ SmartDocs กับพอร์ทัล คุณต้องติดตั้ง SmartDocs ใน Edge ก่อน

• หากคุณเชื่อมต่อพอร์ทัลกับการติดตั้ง Edge Cloud แสดงว่า SmartDocs ได้รับการติดตั้งแล้วและไม่จำเป็นต้องกำหนดค่าเพิ่มเติม
• หากคุณเชื่อมต่อพอร์ทัลกับการติดตั้ง Edge for Private Cloud คุณต้องตรวจสอบว่าได้ติดตั้ง SmartDocs ใน Edge แล้ว ดูข้อมูลเพิ่มเติมเกี่ยวกับการติดตั้ง Edge และ SmartDocs ได้ที่ติดตั้ง SmartDocs

นอกจากนี้ คุณยังต้องเปิดใช้ SmartDocs ในพอร์ทัลด้วย ดูข้อมูลเพิ่มเติมเกี่ยวกับ SmartDocs ได้ที่การใช้ SmartDocs เพื่อจัดทำเอกสาร API

8. กำหนดค่าโมดูล JQuery Update สำหรับการติดตั้งแบบไม่ใช้อินเทอร์เน็ต (ไม่บังคับ)

หากติดตั้งและใช้โมดูล JQuery Update ในการติดตั้งแบบออฟไลน์ คุณจะต้องกำหนดค่าโมดูลให้ใช้ JQuery เวอร์ชันในเครื่อง หากคุณกำหนดค่าโมดูลให้ใช้ CDN สำหรับการติดตั้งแบบไม่ใช้อินเทอร์เน็ต โมดูลจะพยายามเข้าถึง CDN และทำให้การโหลดหน้าเว็บล่าช้า ดูข้อมูลเพิ่มเติมเกี่ยวกับโมดูล JQuery Update ได้ที่ https://www.drupal.org/project/jquery_update

วิธีกำหนดค่าโมดูล JQuery Update ให้ใช้ JQuery เวอร์ชันในเครื่อง

1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบหรือสิทธิ์ในการสร้างคอนเทนต์
2. เลือกการกำหนดค่า > การพัฒนา > การอัปเดต JQuery ในเมนู Drupal
3. คลิกประสิทธิภาพในการนำทางด้านซ้าย
4. ในเมนูแบบเลื่อนลง JQuery และ JQuery UI CDN ให้เลือกไม่มี
5. คลิก Save configuration

9. ขั้นตอนถัดไป

ตารางต่อไปนี้แสดงงานที่พบบ่อยที่สุดบางส่วนที่คุณทำหลังจากการติดตั้ง และมีลิงก์ไปยังเอกสารประกอบของ Apigee ซึ่งคุณจะดูข้อมูลเพิ่มเติมได้