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.05

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 độc lập Postgres để cổng 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 như một phần của 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 thực hiện cài đặt trên phiên bản 64 bit của một phiên bản Red Hat Enterprise Linux, CentOS hoặc Oracle được hỗ trợ. Xem danh sách các phiên bản được hỗ trợ tại bài viết Phần mềm và phiên bản được hỗ trợ.
  • Đã cài đặt Yum.

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

Sau khi bạn cài đặt tiện ích apigee-setup cho 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

Chuyển tệp cấu hình vào 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, tiện ích apigee-setup sẽ nhắc bạn nhập tệp đó vào 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:

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

Hãy xem bài viết Cài đặt tiện ích thiết lập apigee 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 im lặng để cài đặt cổng. 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 để 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 của bạn với Apigee Edge

Hãy 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 đây từ lời 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 đó EMAILpasswords 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 dành riêng cho việc cài đặt Edge. 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 sẽ là: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

Nếu thành công, lệnh này sẽ trả về 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 quá trình cài đặt. Nếu có phiên bản trước 7.0 của PHP, thông báo cảnh báo sau 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

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 cài đặt Postgres trước khi bạn có thể cài đặt cổng. 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 sử dụng.

  • Nếu bạn đang kết nối với Postgres được cài đặt như một phần của 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 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 Internet hoặc không phải Internet. Hãy xem bài viết Cài đặt tiện ích thiết lập apigee của Edge để biết thêm thông tin.
  2. Tạo 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 tên DNS của máy chủ – không phải thành 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
    REGION=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” sẽ chỉ định việc cài đặt Postgre.

    Người dùng "apigee" phải truy cập được hoặc đọc được tệp cấu hình.

4. Cài đặt cổng

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 theo quy trình Internet hoặc không phải Internet. Hãy xem bài viết Cài đặt tiện ích thiết lập apigee của Edge để biết thêm thông tin.
  2. Hãy đảm bảo rằng bạn đã cài đặt Postgres, độc lập hoặc đã 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.

    Người dùng "apigee" phải truy cập được 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 của bạn.
  5. Đăng nhập vào cổng thông tin bằng thông tin đăng nhập quản trị viên mà bạn đã thiết lập trong tệp cấu hình.

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

Để nhận thông báo về nội dung cập nhật của Drupal, hãy đảm bảo rằng bạn đã bật mô-đun trình quản lý Bản cập nhật Drupal. Trên trình đơn của Drupal, hãy chọn Mô-đun rồi cuộn xuống mô-đun Trình quản lý cập nhật. 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 mục trong trình đơn Báo cáo > Nội dung cập nhật có sẵn. Bạn cũng có thể dùng lệnh Drush sau đây:

> 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/wwwroot. Do đó, trước tiên bạn nên thay đổi thư mục thành /opt/apigee/apigee-drupal/wwwroot 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 đổi sang thư mục cài đặt.

Sử dụng mục trong trình đơn 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 các 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ị vô hiệu hóa khi bạn cài đặt cổng. 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 yêu cầu mô-đun Drupal Solr.

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 với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Mô-đun trong trình đơn Drupal.
  3. Bật mô-đun Apache Solr Framework và mô-đun Apache Solr Search.
  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 khiến tài liệu API có khả năng 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 kết nối cổng với một bản cài đặt Edge Cloud, thì SmartDocs đã được cài đặt và không cần định cấu hình 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 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 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 để ghi tài liệu API.

8. Định cấu hình mô-đun Cập nhật JQuery để cài đặt mạng không kết nối Internet (Không bắt buộc)

Nếu cài đặt và sử dụng mô-đun Cập nhật JQuery khi lắp đặt không qua 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 cho việc cài đặt nội dung không qua Internet, mô-đun này sẽ tìm cách truy cập vào CDN và gây chậm trễ khi tải trang. Để biết thêm thông tin về mô-đun Cập nhật JQuery, hãy truy cập vào https://www.drupal.org/project/jquery_update.

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

  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 tạo nội dung.
  2. Chọn Cấu hình > Phát triển > Cập nhật JQuery trong trình đơn Drupal.
  3. Nhấp vào mục 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. Tiếp theo sẽ là gì?

Các bước tiếp theo 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 cổng thông tin cho các yêu cầu cụ thể của bạn. Tài liệu trên trang web Apigee có mọi thông tin về cách định cấu hình, định 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, đồng thời có các đường liên kết đến tài liệu về Apigee để bạn có thể tìm thêm thông tin:

Việc cần làm

Mô tả

Tuỳ chỉnh giao diện

Giao diện xác định giao diện của cổng, bao gồm màu sắc, kiểu và các khía cạnh hình ảnh khác.

Tuỳ chỉnh giao diện

Trang chủ bao gồm trình đơn chính, thư chào mừng, đầu trang, chân trang và tiêu đề.

Thêm và quản lý tài khoản người dùng

Quy trình đăng ký này kiểm soát cách nhà phát triển mới đăng ký tài khoản trên cổng thông tin. Ví dụ: nhà phát triển mới có quyền truy cập ngay vào cổng thông tin hay không, hay họ phải được quản trị viên xác minh. Quy trình này cũng kiểm soát cách quản trị viên cổng thông tin nhận được thông báo khi tài khoản mới được tạo.

Định cấu hình email

Cổng thông tin này gửi email để phản hồi cho một số sự kiện nhất định. Ví dụ: khi một nhà phát triển mới đăng ký trên cổng thông tin và khi nhà phát triển mất mật khẩu của họ.

Thêm và quản lý tài khoản người dùng

Thêm trang Điều khoản và điều kiện mà nhà phát triển phải chấp nhận trước khi được phép truy cập vào cổng thông tin này.

Thêm và quản lý tài khoản người dùng

Cổng thông tin này triển khai mô hình uỷ quyền dựa trên vai trò. Trước khi cho phép nhà phát triển đăng ký, hãy xác định các quyền và vai trò mà cổng sử dụng.

Thêm bài đăng trên blog và diễn đàn

Cổng thông tin được tích hợp sẵn tính năng hỗ trợ cho blog và diễn đàn theo chuỗi. Xác định các quyền cần thiết để xem, thêm, chỉnh sửa cũng như xoá bài đăng trên blog và diễn đàn.

Đảm bảo rằng bạn đang thực hiện sao lưu cơ sở dữ liệu

Đảm bảo rằng bạn đang sao lưu cơ sở dữ liệu của Drupal. Hãy lưu ý rằng vì mỗi lượt cài đặt đều khác nhau nên bạn có quyền quyết định cách tốt nhất để sao lưu cơ sở dữ liệu.

Lưu ý: Mô-đun Sao lưu và di chuyển không tương thích với cơ sở dữ liệu Postgres.

Xem thêm Cách sao lưu.

Thiết lập tên máy chủ

Nếu không thiết lập tên máy chủ trong máy chủ DNS, thì bạn luôn có thể truy cập vào trang web qua địa chỉ IP của máy chủ. Nếu muốn sử dụng một tên máy chủ, bạn có thể định cấu hình DNS cho máy chủ. DNS này sẽ hoạt động chính xác mà không cần bất kỳ cấu hình nào khác trong quy trình thiết lập cơ bản.

Nếu đã thiết lập trình cân bằng tải hoặc nhận được URL không chính xác trên trang web của mình vì lý do nào đó, bạn có thể đặt $base_url trong tệp settings.php của Cổng thông tin cho nhà phát triển, tệp này theo mặc định nằm trong thư mục /opt/apigee/apigee-drupal/wwwroot/sites/default.

Phát triển tuỳ chỉnh Bạn cũng nên mở rộng khả năng của cổng bằng mã tuỳ chỉnh bên ngoài giao diện. Để thực hiện việc này, hãy tạo mô-đun Drupal riêng như mô tả trong các chủ đề về phát triển mô-đun của Drupal rồi đặt mô-đun đó vào thư mục /sites/all/modules.