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

Edge for Private Cloud phiên bản 4.17.09

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 dưới dạng một phần 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ì ứng dụng này 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 dưới dạng một phần của Edge và Postgres được định cấu hình ở chế độ chính/chế độ chờ, chỉ định địa chỉ IP của máy chủ Postgres chính.
• Bạn đang thực hiện cài đặt trên phiên bản 64 bit của phiên bản Red Hat được hỗ trợ Enterprise Linux, CentOS hoặc Oracle. Xem danh sách các phiên bản được hỗ trợ tại Phần mềm được hỗ trợ và các phiên bản được hỗ trợ.
• Đã cài đặt Yum.

Trình cài đặt chỉ bao gồm các mô-đun do Drupal đóng góp mà Cổng Dịch vụ dành cho nhà phát triển Apigee (hoặc đơn giản là cổng). Để biết thông tin về cách cài đặt các mô-đun được đóng góp khác, hãy xem Mở rộng Drupal 7.

Tổng quan về việc cài đặt

Sau khi bạn cài đặt tiện ích apigee-setup 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 phần tử thông tin về việc 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ông tin, phương thức thiết lập apigee tiện ích sẽ nhắc bạn nhập mã đó vào dòng lệnh.

Yêu cầu duy nhất là tệp cấu hình phải được "api" người dùng.

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 bài viết Cài đặt tiện ích thiết lập apigee của Edge để tìm hiểu thêm.

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

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

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 của bạn với máy chủ quản lý Edge bằng cách thực thi lệnh cURL sau 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à email địa chỉ 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 dành riêng cho quá trình cài đặt Edge. Cổng sạc 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 sẽ 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á phiên bản PHP trước 7.0

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

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

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. Bạn có thể: cài đặt Postgres như một phần của quá trình cài đặt Edge hoặc cài đặt Postgres độc lập để cổng thông tin.

• Nếu bạn đang kết nối với Postgres được cài đặt dưới dạng một phần của Edge và Postgres được định cấu hình trong chế độ chính/chế độ chờ, 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ì ứng dụng này 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 phần Cài đặt các thành phần của 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 Edge trên nút bằng cách dùng internet hoặc không phải là Internet. Xem bài viết Cài đặt tiện ích thiết lập apigee của Edge để khác.
2. Tạo một tệp cấu hình cho Postgres, như minh hoạ dưới đây:
   
   # Phải phân giải thành địa chỉ IP hoặc DNS tên của máy chủ lưu trữ - không phải là 127.0.0.1 hoặc localhost.
   HOSTIP=$(tên máy chủ -i)
   
   # Nhóm và vùng của Postgres. Sử dụng các giá trị mặc định được hiển thị bên dưới.
   MP_POD=gateway
   KHU VỰC=dc-1
   
   # Đặt mật khẩu Postgres. 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 việc cài đặt Postgre.
   
   Tệp cấu hình phải có thể truy cập hoặc có thể đọc được bởi "api" người dùng.

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 Edge trên nút sử dụng Internet hoặc quy trình không phải là Internet. Xem bài viết Cài đặt tiện ích thiết lập apigee của Edge để khác.
2. Đảm bảo rằng bạn đã cài đặt Postgres, Postgres độc lập hoặc là một phần của 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 việc cài đặt cổng thông tin.
   
   Tệp cấu hình phải có thể truy cập hoặc có thể đọc được bởi "api" người dùng.
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 của bạn.
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 hãy đảm bảo rằng cổng thông tin đang hoạt động đúng cách.
6. Chọn Báo cáo > Báo cáo trạng thái trong trình đơn Drupal để đảm bảo rằng bạn có thể xem trạng thái hiện tại của cổng.

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

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

Sau khi bật, bạn có thể xem các bản cập nhật có sẵn bằng cách sử dụng Báo cáo > Có sẵn Mục trong trình đơn Cập nhật. 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, mã Nhà phát triển Cổng thông tin được cài đặt tại /opt/apigee/apigee-drupal/wwwroot. Do đó, trước tiên, bạn nên thay đổi thư mục thành /opt/apigee/apigee-drupal/wwwroot trước 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 thay đổi thành thư mục cài đặt.

Sử dụng trang Báo cáo > Bản cập nhật hiện có > Mục trong trình đơ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 đều sử dụng công cụ tìm kiếm nội bộ Drupal nên không cần có mô-đun Drupal Solr.

Nếu quyết định 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ủ 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 với tư cách là người dùng có đặc quyền của quản trị viên hoặc quyền 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à Apache Solr của Apache Tìm kiếm.
4. Lưu các thay đổi.
5. Định cấu hình Solr như 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 API của mình trên cổng 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ì SmartDocuments đã được cài đặt mà không cần định cấu hình gì thêm.
• Nếu đang kết nối cổng thông tin với một Edge để cài đặt Đám mây riêng tư, bạn phải đảm bảo mà 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 phần 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 phần Sử dụng SmartDocs để tạo tài liệu API.

8. Định cấu hình Mô-đun Cập nhật JQuery dành cho các lượt cài đặt không phải trên Internet (Không bắt buộc)

Nếu bạn cài đặt và sử dụng mô-đun JQuery Update khi cài đặt không phải trên Internet, bạn cần định cấu hình mô-đun để sử dụng phiên bản JQuery cục bộ. Nếu bạn định cấu hình mô-đun để sử dụng CDN đối với trường hợp cài đặt không phải kết nối Internet, hệ thống sẽ cố truy cập CDN và gây chậm trễ cho trang đang tải. Để biết thêm thông tin về mô-đun Cập nhật JQuery, hãy xem https://www.drupal.org/project/jquery_update.

Để định cấu hình mô-đun Cập nhật JQuery để sử dụng phiên bản JQuery cục bộ:

1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc quyền tạo nội dung.
2. Chọn Cấu hình > Phát triển > JQuery Update trong trình đơn Drupal.
3. Nhấp vào Hiệu suất trong bảng điều hướng bên trái.
4. Trong trình đơn thả xuống CDN của giao diện người dùng JQuery và JQuery, hãy chọn Không.
5. Nhấp vào Lưu cấu hình.

9. Ðiều gì kế tiếp?

Bước tiếp theo của bạn sau khi 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 phù hợp với 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 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ố tác vụ phổ biến nhất mà bạn thực hiện sau khi cài đặt, và có đường liên kết đến tài liệu về Apigee để bạn tìm thêm thông tin:

/opt/apigee/apigee-drupal-devportal-opdk_version/source/conf/settings.php