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

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

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

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

    # ต้องกำหนดเป็นที่อยู่ IP หรือ DNS ชื่อโฮสต์ ไม่ใช่ 127.0.0.1 หรือ localhost
    HOSTIP=$(ชื่อโฮสต์ -i)

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

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

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

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

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

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

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

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

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

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

หากต้องการรับการแจ้งเตือนการอัปเดต Drupal ให้ตรวจสอบว่าได้เปิดใช้โมดูลตัวจัดการการอัปเดต Drupal แล้ว จากเมนู 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. ติดตั้ง SmartDocuments (ไม่บังคับ)

SmartDocuments ช่วยให้คุณสามารถบันทึก API ของคุณในพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ในลักษณะที่จะทำให้ เอกสาร API แบบอินเทอร์แอกทีฟโดยสมบูรณ์ แต่หากต้องการใช้ SmartDocuments กับพอร์ทัลนี้ ก่อนอื่นคุณต้อง ติดตั้ง SmartDocuments ใน Edge

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

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

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

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

หากต้องการกำหนดค่าโมดูลการอัปเดต JQuery เพื่อใช้ JQuery ในเวอร์ชันที่อยู่ในเครื่อง ให้ทำดังนี้

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

9. มีอะไรต่อไป

ขั้นตอนถัดไปหลังจากติดตั้งพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์คือการกำหนดค่าและปรับแต่ง ตามความต้องการเฉพาะของคุณ เอกสารประกอบในเว็บไซต์ 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/wwwroot/sites/default

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