Cài đặt cổng dịch vụ dành cho nhà phát triển

Edge cho Private Cloud phiên bản 4.17.01

Trước khi cài đặt, hãy đảm bảo rằng:

• Bạn cài đặt Postgres trước khi cài đặt cổng thông tin. Bạn có thể cài đặt Postgres trong quá trình cài đặt Edge hoặc cài đặt Postgres độc lập để cổng thông tin sử dụng.
  • Nếu bạn cài đặt Postgres độc lập, thì Postgres có thể nằm trên cùng một nút với cổng thông tin.
  • Nếu bạn đang kết nối với Postgres được cài đặt trong Edge và Postgres được định cấu hình ở chế độ chính/chế độ chờ, hãy chỉ định địa chỉ IP của máy chủ Postgres chính.
• Bạn đang cài đặt trên phiên bản 64 bit của một phiên bản được hỗ trợ của Red Hat Enterprise Linux, CentOS hoặc Oracle. Xem danh sách các phiên bản được hỗ trợ tại phần Phần mềm và phiên bản được hỗ trợ.
• Yum đã được cài đặt.

Tổng quan về quy trình cài đặt

Sau khi bạn cài đặt tiện ích apigee-setup của Edge trên một nút, hãy sử dụng tiện ích đó để cài đặt cổng thông tin trên nút. Tiện ích apigee-setup có dạng như sau:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Truyền tệp cấu hình đến tiện ích apigee-setup chứa thông tin về quá trình cài đặt. Nếu tệp cấu hình thiếu bất kỳ thông tin bắt buộc nào, thì tiện ích apigee-setup sẽ nhắc bạn nhập thông tin đó trên dòng lệnh.

Yêu cầu duy nhất là người dùng "apigee" phải truy cập hoặc đọc được tệp cấu hình.

Ví dụ: sử dụng lệnh sau để cài đặt cổng thông tin:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

Xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.

Tạo tệp cấu hình

Dưới đây là ví dụ về tệp cấu hình tự động cho quá trình cài đặt cổng thông tin. Chỉnh sửa tệp này nếu cần cho cấu hình của bạn. Sử dụng tuỳ chọn -f cho setup.sh để thêm tệp này.

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. Kiểm tra kết nối với Apigee Edge

Kiểm tra kết nối với máy chủ quản lý Edge bằng cách thực thi lệnh cURL sau đây từ dấu nhắc lệnh trên máy chủ cổng thông tin:

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

hoặc:

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/v1/organizations/{ORGNAME}

Trong đó EMAIL và PASSWORD là địa chỉ email và mật khẩu của quản trị viên cho ORGNAME.

Hãy nhớ chỉ định tên máy chủ và số cổng cụ thể cho bản cài đặt Edge của bạn. Cổng 8080 là cổng mặc định mà Edge sử dụng. Nếu bạn đang kết nối với một tổ chức trên đám mây, thì URL yêu cầu là: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

Nếu thành công, lệnh này sẽ trả về một phản hồi tương tự như sau:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. Xoá các phiên bản PHP trước 7.0

Tập lệnh cài đặt sẽ kiểm tra các phiên bản PHP trước 7.0 trên hệ thống trước khi bắt đầu cài đặt. Nếu có các phiên bản PHP trước 7.0, thông báo cảnh báo sau đây sẽ xuất hiện:

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

Đối với CentOS và RedHat Enterprise Linux (RHEL), hãy xoá các gói PHP bằng lệnh sau:

yum remove <package-name>

3. Cài đặt Postgres

Cổng thông tin yêu cầu bạn phải cài đặt Postgres trước khi có thể cài đặt cổng thông tin. Bạn có thể cài đặt Postgres trong quá trình cài đặt Edge hoặc cài đặt Postgres độc lập để sử dụng cho cổng thông tin.

• Nếu bạn đang kết nối với Postgres được cài đặt trong Edge và Postgres được định cấu hình ở chế độ chính/chế độ chờ, hãy chỉ định địa chỉ IP của máy chủ Postgres chính.
• Nếu bạn cài đặt Postgres độc lập, thì Postgres có thể nằm trên cùng một nút với cổng thông tin.

Để biết thông tin về cách cài đặt Postgres trong quá trình cài đặt Edge, hãy xem bài viết Cài đặt các thành phần Edge trên một nút.

Cách cài đặt Postgres độc lập:

1. Cài đặt tiện ích apigee-setup của Edge trên nút bằng cách sử dụng quy trình có Internet hoặc không có Internet. Hãy xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.
2. Tạo tệp cấu hình cho Postgres như dưới đây:
   
   # Nhóm và khu vực của Postgres. Sử dụng các giá trị mặc định như dưới đây.
   MP_POD=gateway
   REGION=dc-1
   
   # Set the Postgres password. Giá trị mặc định là "postgres".
   PG_PWD=postgres
3. Tại dấu nhắc lệnh, hãy chạy tập lệnh thiết lập để cài đặt Postgres:
   > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile
   
   Tuỳ chọn "-p pdb" chỉ định cài đặt Postgres.
   
   Người dùng "apigee" phải truy cập hoặc đọc được tệp cấu hình.

4. Cài đặt cổng thông tin

Cách cài đặt cổng thông tin:

1. Cài đặt tiện ích apigee-setup của Edge trên nút bằng quy trình có Internet hoặc không có Internet. Hãy xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.
2. Đảm bảo rằng bạn đã cài đặt Postgres, Postgres độc lập hoặc trong quá trình cài đặt Edge.
3. Tại dấu nhắc lệnh, hãy chạy tập lệnh thiết lập:
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   Tuỳ chọn "-p dp" chỉ định cài đặt cổng thông tin.
   
   Người dùng "apigee" phải truy cập hoặc đọc được tệp cấu hình.
4. Chuyển đến trang chủ của cổng thông tin tại http://localhost:8079 hoặc đến tên DNS của cổng thông tin.
5. Đăng nhập vào cổng thông tin bằng thông tin đăng nhập của quản trị viên mà bạn đã đặt trong tệp cấu hình.

5. Đảm bảo rằng bạn đã bật mô-đun Trình quản lý cập nhật

Để nhận thông báo về các bản cập nhật Drupal, hãy đảm bảo rằng bạn đã bật mô-đun Trình quản lý cập nhật Drupal. Trên trình đơn Drupal, hãy chọn Modules (Mô-đun) rồi di chuyển xuống mô-đun Update manager (Trình quản lý cập nhật). Nếu API chưa bật, hãy bật API đó.

Sau khi bật, bạn có thể xem các bản cập nhật hiện có bằng cách sử dụng mục trình đơn Reports > Available Updates (Báo cáo > Bản cập nhật hiện có). Bạn cũng có thể sử dụng lệnh Drush sau:

> drush pm-info update

Bạn phải chạy lệnh này từ thư mục gốc của trang web. Theo mặc định, Cổng thông tin cho nhà phát triển được cài đặt tại /opt/apigee/apigee-drupal. Do đó, trước tiên, bạn nên thay đổi thư mục thành /opt/apigee/apigee-drupal trước khi chạy lệnh. Nếu bạn không cài đặt cổng thông tin trong thư mục mặc định, hãy chuyển sang thư mục cài đặt của bạn.

Sử dụng mục trình đơn Reports > Available Updates > Settings (Báo cáo > Bản cập nhật có sẵn > Cài đặt) để định cấu hình mô-đun gửi email cho bạn khi có bản cập nhật và đặt tần suất kiểm tra bản cập nhật.

6. Định cấu hình công cụ tìm kiếm Apache Solr (Không bắt buộc)

Theo mặc định, các mô-đun Drupal kết nối với công cụ tìm kiếm Apache Solr sẽ bị tắt khi bạn cài đặt cổng thông tin. Hầu hết các cổng thông tin đều sử dụng công cụ tìm kiếm nội bộ của Drupal, do đó không cần đến các mô-đun Solr của Drupal.

Nếu quyết định sử dụng Solr làm công cụ tìm kiếm, bạn phải cài đặt Solr cục bộ trên máy chủ của mình, sau đó bật và định cấu hình các mô-đun Drupal Solr trên cổng thông tin.

Cách bật các mô-đun Drupal Solr:

1. Đăng nhập vào cổng thông tin của bạn bằng tài khoản người dùng có đặc quyền quản trị hoặc sáng tạo nội dung.
2. Chọn Modules (Mô-đun) trong trình đơn Drupal.
3. Bật mô-đun Apache Solr Framework và mô-đun Apache Solr Search.
4. Lưu thay đổi.
5. Định cấu hình Solr theo mô tả tại https://drupal.org/node/1999280.

7. Cài đặt SmartDocs (Không bắt buộc)

SmartDocs cho phép bạn ghi lại các API của mình trên cổng thông tin Dịch vụ dành cho nhà phát triển theo cách giúp tài liệu API có tính tương tác đầy đủ. Tuy nhiên, để sử dụng SmartDocs với cổng thông tin, trước tiên, bạn phải cài đặt SmartDocs trên Edge.

• Nếu bạn đang kết nối cổng thông tin với một bản cài đặt Edge Cloud, thì SmartDocs đã được cài đặt và bạn không cần phải định cấu hình thêm.
• Nếu đang kết nối cổng thông tin với một bản cài đặt Edge cho đám mây riêng tư, bạn phải đảm bảo rằng SmartDocs đã được cài đặt trên Edge. Để biết thêm thông tin về cách cài đặt Edge và SmartDocs, hãy xem bài viết Cài đặt SmartDocs.

Bạn cũng phải bật SmartDocs trên cổng thông tin. Để biết thêm thông tin về SmartDocs, hãy xem bài viết Sử dụng SmartDocs để ghi lại API.

8. Bước tiếp theo là gì?

Các bước tiếp theo sau khi bạn cài đặt cổng Dịch vụ dành cho nhà phát triển là định cấu hình và tuỳ chỉnh cổng này theo yêu cầu cụ thể của bạn. Tài liệu trên trang web Apigee chứa tất cả thông tin về cách định cấu hình, tạo kiểu và quản lý cổng thông tin. Truy cập vào tài liệu tại http://apigee.com/docs/developer-services/content/what-developer-portal.

Bảng sau đây liệt kê một số việc cần làm phổ biến nhất mà bạn thực hiện sau khi cài đặt, đồng thời cung cấp đường liên kết đến tài liệu về Apigee, nơi bạn có thể tìm thêm thông tin: