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.18.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 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 phiên bản được hỗ trợ tại Các phiên bản phần mềm và 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 cài đặt tiện ích Edge, tiện ích apigee-setup trên một nút, hãy sử dụng nút đó tiện ích để cài đặt cổng thông tin trên nút. Tiện ích apigee-setup có dạng:

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

Truyền tệp cấu hình vào 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ì apigee-setup 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.

Ngừng sử dụng thuộc tính SMTPSSL

Trong các bản phát hành trước, bạn đã sử dụng thuộc tính SMTPSSL để đặt giao thức được sử dụng bởi máy chủ SMTP được kết nối với cổng. Cơ sở lưu trú đó đã không dùng nữa.

Bây giờ, bạn đang sử dụng thuộc tính SMTP_PROTOCOL, thay vì thuộc tính SMTPSSL, để đặt giao thức được sử dụng bởi máy chủ SMTP được kết nối với cổng. Các giá trị hợp lệ là: "standard", "ssl" hoặc "tls".

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 bao gồm trường 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 

# Optionally configure the SMTP server used by the portal. 
# If you do, 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 

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the 
# SMTPSSL property. That property has been deprecated. 
SMTP_PROTOCOL="standard" 

# 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 đó EMAILPASSWORD 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 tồn tại 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 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 Edge apigee-setup trên nút bằng cách sử dụng internet hoặc không phải là Internet. Xem Hãy 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ư sau:
    # Must resolve to IP address or DNS
        name of host - not to 127.0.0.1 or localhost.
        HOSTIP=$(hostname -i)
    
        # The pod and region of Postgres. Use the default values shown below.
        MP_POD=gateway
        REGION=dc-1
    
        # Set the Postgres password. The default value is '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 "api" có thể truy cập hoặc đọc được 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 Edge apigee-setup trên nút sử dụng Internet hoặc quy trình không phải là Internet. Xem Cài đặt tiện ích thiết lập apigee của Edge cho 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 để 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 vào đượ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. Kích hoạt mô-đun Apache Solr FrameworkApache 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 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 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:

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 thông tin, bao gồm màu sắc, kiểu và các thông tin khác khía cạnh trực quan.

Tuỳ chỉnh diện mạo

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ý 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ụ: liệu các nhà phát triển mới có quyền truy cập ngay lập tức vào cổng thông tin hay không, phải được quản trị viên xác minh. Quá trình này cũng kiểm soát cách cổng thông tin quản trị viên sẽ đượ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 sẽ gửi email để phản hồi một số sự kiện nhất định. Ví dụ: khi một người dùng mới nhà phát triển đăng ký trên cổng thông tin và khi nhà phát triển mất mật khẩu.

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

Thêm Điều khoản & Trang đ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 cổng thông tin.

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

Cổng thông tin này sẽ 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ý, xác định quyền và vai trò mà cổng thông tin sử dụng.

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

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

Đảm bảo bạn đang sao lưu cơ sở dữ liệu

Đảm bảo rằng bạn đang sao lưu cơ sở dữ liệu Drupal. Lưu ý rằng vì mỗi khác nhau, việc xác định cách tốt nhất để sao lưu dữ liệu là tuỳ thuộc vào bạn cơ sở dữ liệu.

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

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, bạn luôn có thể truy cập trang web qua địa chỉ IP của máy chủ. Nếu muốn sử dụng tên máy chủ, bạn có thể định cấu hình DNS cho máy chủ để hoạt động chính xác mà không cần bất kỳ cấu hình nào khác ở bước thiết lập cơ bản.

Nếu bạn 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ì một số lý do khác, bạn có thể thiết lập $base_url cho Drupal bằng cách làm theo các bước sau:

  1. Tạo thư mục /opt/apigee/data/apigee-drupal-devportal/sites/default/includes nếu mã này không tồn tại.
  2. Tạo một tệp có tên settings.php trong thư mục đó.
  3. Thêm phần sau đây vào tệp settings.php:
    /**
    * Base URL (optional).
    *
    * If Drupal is generating incorrect URLs on your site, which could
    * be in HTML headers (links to CSS and JS files) or visible links
    * on pages (such as in menus), uncomment the Base URL statement
    * below (remove the leading hash sign) and fill in the absolute URL
    * to your Drupal installation.
    *
    * You might also want to force users to use a given domain.
    * See the .htaccess file for more information.
    *
    * Examples:
    *   $base_url = 'http://www.example.com';
    *   $base_url = 'http://www.example.com:8888';
    *   $base_url = 'http://www.example.com/drupal';
    *   $base_url = 'https://www.example.com:8888/drupal';
    *
    * It is not allowed to have a trailing slash; Drupal will add it
    * for you.
    */
    # $base_url = 'http://www.example.com/';  // NO trailing slash!
    $base_url = ‘http://www.example.com’;
    
  4. Thay đổi dòng $base_url cuối cùng làm tên máy chủ của trang web.
  5. Lưu tệp.

Xin lưu ý rằng bạn có thể đặt mọi chế độ cài đặt khác từ /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php vào tệp này.

Để biết thêm thông tin về thuộc tính $base_url, hãy xem các phần dưới đây:

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