การติดตั้งพอร์ทัลบริการสําหรับนักพัฒนาแอป

Edge for Private Cloud เวอร์ชัน 4.17.05

โปรดตรวจสอบสิ่งต่อไปนี้ก่อนติดตั้ง

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

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

หลังจากติดตั้ง 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

ดูข้อมูลเพิ่มเติมได้ที่ติดตั้งยูทิลิตี apigee-setup ของ Edge

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

ด้านล่างนี้คือตัวอย่างไฟล์การกำหนดค่าแบบไม่มีการโต้ตอบสำหรับการติดตั้งพอร์ทัล แก้ไขไฟล์นี้ตามที่จำเป็นสำหรับการกำหนดค่าของคุณ ใช้ตัวเลือก -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=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 

# You must configure the SMTP server used by the portal. 
# 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 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# 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

ทดสอบการเชื่อมต่อกับเซิร์ฟเวอร์การจัดการ Edge โดยเรียกใช้คำสั่ง cURL ต่อไปนี้จาก Command Prompt ในเซิร์ฟเวอร์พอร์ทัล

> 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}

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

{
  "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>

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 ดังที่แสดงด้านล่าง
   
   # ต้องแปลงเป็นที่อยู่ IP หรือชื่อ DNS ของโฮสต์ ไม่ใช่ 127.0.0.1 หรือ localhost
   HOSTIP=$(hostname -i)
   
   # พ็อดและภูมิภาคของ Postgres ใช้ค่าเริ่มต้นที่แสดงด้านล่าง
   MP_POD=gateway
   REGION=dc-1
   
   # ตั้งรหัสผ่าน Postgres ค่าเริ่มต้นคือ "postgres"
   PG_PWD=postgres
3. ที่ Command Prompt ให้เรียกใช้สคริปต์การตั้งค่าเพื่อติดตั้ง Postgres ดังนี้
   > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile
   
   ตัวเลือก "-p pdb" จะระบุให้ติดตั้ง Postgre
   
   ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้

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

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

1. ติดตั้งยูทิลิตี Edge apigee-setup ในโหนดโดยใช้ขั้นตอนที่ใช้อินเทอร์เน็ตหรือไม่ใช้อินเทอร์เน็ต ดูข้อมูลเพิ่มเติมได้ที่ติดตั้งยูทิลิตี apigee-setup ของ Edge
2. ตรวจสอบว่าคุณได้ติดตั้ง Postgres แล้ว ไม่ว่าจะเป็น Postgres แบบสแตนด์อโลนหรือเป็นส่วนหนึ่งของการติดตั้ง Edge
3. ที่ Command Prompt ให้เรียกใช้สคริปต์การตั้งค่าดังนี้
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   ตัวเลือก "-p dp" จะระบุให้ติดตั้งพอร์ทัล
   
   ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้
4. ไปที่หน้าแรกของพอร์ทัลที่ http://localhost:8079 หรือไปที่ชื่อ DNS ของพอร์ทัล
5. เข้าสู่ระบบพอร์ทัลโดยใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบที่คุณตั้งค่าไว้ในไฟล์การกำหนดค่า

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 มีข้อมูลทั้งหมดเกี่ยวกับการกำหนดค่า การจัดรูปแบบ และการจัดการพอร์ทัล เข้าถึงเอกสารประกอบได้ที่ http://apigee.com/docs/developer-services/content/what-developer-portal

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