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

Edge for Private Cloud v. 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

ดูข้อมูลเพิ่มเติมได้ที่ติดตั้งยูทิลิตี 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

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

หากต้องการรับการแจ้งเตือนการอัปเดต Drupal ให้ตรวจสอบว่าได้เปิดใช้โมดูลเครื่องมือจัดการการอัปเดต Drupal แล้ว จากเมนู Drupal ให้เลือกโมดูล แล้วเลื่อนลงไปที่โมดูล 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. เลือกโมดูลในเมนู 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 สำหรับการติดตั้ง Private Cloud คุณต้องตรวจสอบว่าได้ติดตั้ง SmartDocuments ใน Edge แล้ว ดูข้อมูลเพิ่มเติมเกี่ยวกับการติดตั้ง Edge และ SmartDocs ได้ที่ติดตั้ง SmartDocs

นอกจากนี้ คุณยังต้องเปิดใช้ SmartDocs ในพอร์ทัลด้วย ดูข้อมูลเพิ่มเติมเกี่ยวกับ SmartDocs ได้ที่การใช้ 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 ของพอร์ทัล Dev ได้ ซึ่งโดยค่าเริ่มต้นจะอยู่ในไดเรกทอรี /opt/apigee/apigee-drupal/sites/default

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