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

Edge สำหรับ Private Cloud เวอร์ชัน 4.17.01

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

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

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

หลังจากติดตั้งยูทิลิตี apigee-setup ของ Edge บนโหนดแล้ว ให้ใช้ยูทิลิตีนั้นติดตั้งพอร์ทัลบนโหนด ยูทิลิตี 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

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

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

> 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

สำหรับ CentOS และ RedHat Enterprise Linux (RHEL) ให้นำแพ็กเกจ PHP ออกโดยใช้คำสั่งต่อไปนี้

yum remove <package-name>

3. ติดตั้ง Postgres

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

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

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

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

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

    # พ็อดและภูมิภาคของ Postgres ใช้ค่าเริ่มต้นที่แสดงด้านล่าง
    MP_POD=gateway
    REGION=dc-1

    # ตั้งรหัสผ่าน Postgres ค่าเริ่มต้นคือ "Postgres"
    PG_PWD=postgres
  3. ไปที่พรอมต์คำสั่ง ให้เรียกใช้สคริปต์การตั้งค่าเพื่อติดตั้ง Postgres ดังนี้
    > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    ตัวเลือก “-p pdb” จะระบุให้ติดตั้ง Postgres

    ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้

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

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

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

    ตัวเลือก “-p dp” จะระบุให้ติดตั้งพอร์ทัล

    ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้
  4. ไปที่หน้าแรกของพอร์ทัลที่ http://localhost:8079 หรือไปที่ชื่อ DNS ของพอร์ทัล
  5. เข้าสู่ระบบพอร์ทัลโดยใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบที่คุณตั้งค่าไว้ในไฟล์การกำหนดค่า

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

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

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

> drush pm-info update

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

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

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

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

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

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

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

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

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

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

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

8. แล้วยังไงต่อดี

ขั้นตอนถัดไปหลังจากติดตั้งพอร์ทัลบริการสำหรับนักพัฒนาแอปคือการกำหนดค่าและปรับแต่งพอร์ทัลให้เหมาะกับข้อกำหนดเฉพาะของคุณ เอกสารประกอบในเว็บไซต์ Apigee ประกอบไปด้วยข้อมูลทั้งหมดเกี่ยวกับการกำหนดค่า การจัดรูปแบบ และการจัดการพอร์ทัล เข้าถึงเอกสารได้ที่ http://apigee.com/docs/developer-services/content/what-developer-portal

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

งาน

คำอธิบาย

การปรับแต่งธีม

ธีมจะเป็นตัวกำหนดรูปลักษณ์ของพอร์ทัล ซึ่งรวมถึงสี การจัดรูปแบบ และลักษณะอื่นๆ ของภาพ

ปรับแต่งลักษณะที่ปรากฏ

หน้าแรกจะมีเมนูหลัก ข้อความต้อนรับ ส่วนหัว ส่วนท้าย และชื่อ

เพิ่มและจัดการบัญชีผู้ใช้

ขั้นตอนการลงทะเบียนจะควบคุมวิธีที่นักพัฒนาแอปรายใหม่ลงทะเบียนบัญชีในพอร์ทัล ตัวอย่างเช่น นักพัฒนาซอฟต์แวร์รายใหม่จะเข้าถึงพอร์ทัลได้ทันทีหรือไม่ หรือต้องได้รับการยืนยันจากผู้ดูแลระบบ กระบวนการนี้ยังควบคุมวิธีแจ้งเตือนผู้ดูแลระบบพอร์ทัลเมื่อมีการสร้างบัญชีใหม่ด้วย

การกำหนดค่าอีเมล

พอร์ทัลส่งอีเมลเพื่อตอบสนองต่อเหตุการณ์บางอย่าง เช่น เมื่อนักพัฒนาแอปรายใหม่ลงทะเบียนในพอร์ทัลและเมื่อนักพัฒนาแอปทำรหัสผ่านหาย

เพิ่มและจัดการบัญชีผู้ใช้

เพิ่มหน้าข้อกำหนดและเงื่อนไขที่นักพัฒนาแอปต้องยอมรับก่อนที่จะได้รับอนุญาตให้เข้าถึงพอร์ทัล

เพิ่มและจัดการบัญชีผู้ใช้

พอร์ทัลจะใช้โมเดลการให้สิทธิ์ตามบทบาท กำหนดสิทธิ์และบทบาทที่พอร์ทัลใช้ก่อนอนุญาตให้นักพัฒนาแอปลงทะเบียน

เพิ่มบล็อกโพสต์และฟอรัม

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

ตรวจสอบว่าคุณกำลังสำรองข้อมูลฐานข้อมูล

ตรวจสอบว่าคุณกำลังสำรองข้อมูลฐานข้อมูล Drupal โปรดทราบว่าเนื่องจากการติดตั้งแต่ละครั้งมีความแตกต่างกัน ขึ้นอยู่กับคุณว่าจะกำหนดวิธีที่ดีที่สุดในการสำรองข้อมูลฐานข้อมูลอย่างไร

หมายเหตุ: โมดูลการสำรองข้อมูลและย้ายข้อมูลใช้ไม่ได้กับฐานข้อมูล Postgres

โปรดดูวิธีดำเนินการสำรองข้อมูล

ตั้งค่าชื่อโฮสต์

หากไม่ตั้งค่าชื่อโฮสต์ในเซิร์ฟเวอร์ DNS คุณจะเข้าถึงเว็บไซต์นั้นผ่านทางที่อยู่ IP ของเซิร์ฟเวอร์ได้เสมอ หากต้องการใช้ชื่อโฮสต์ คุณกำหนดค่า DNS สำหรับเซิร์ฟเวอร์ได้ ซึ่งควรทำงานได้อย่างถูกต้องโดยไม่ต้องกำหนดค่าอื่นๆ ในการตั้งค่าพื้นฐาน

หากคุณตั้งค่าตัวจัดสรรภาระงานหรือได้รับ URL ที่ไม่ถูกต้องในเว็บไซต์ด้วยเหตุผลอื่น คุณสามารถตั้งค่า $base_url ในไฟล์ settings.php ของพอร์ทัลนักพัฒนาซอฟต์แวร์ ซึ่งโดยค่าเริ่มต้นจะอยู่ในไดเรกทอรี /opt/apigee/apigee-drupal/sites/default

การพัฒนาที่กำหนดเอง นอกจากนี้ คุณยังอาจต้องการขยายความสามารถของพอร์ทัลด้วยโค้ดที่กำหนดเองภายนอกธีม วิธีการคือสร้างโมดูล Drupal ของคุณเองตามที่อธิบายไว้ในหัวข้อการพัฒนาโมดูลของ Drupal และใส่โมดูลดังกล่าวในไดเรกทอรี /sites/all/modules