Cài đặt cổng

Edge for Private Cloud phiên bản 4.18.05

Trước khi cài đặt cổng Dịch vụ dành cho nhà phát triển của Apigee (hoặc đơn giản là cổng), hãy đảm bảo rằng:

1. 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.
2. 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ợ.
3. Đã 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

Để cài đặt cổng, bạn sẽ thực hiện các bước sau. Từng bước này được mô tả trong chi tiết hơn trong các phần tiếp theo.

1. Kiểm tra kết nối của bạn
2. Xoá PHP phiên bản trước 7.0
3. Cài đặt Postgres
4. Cài đặt cổng thông tin
5. Đảm bảo bạn đã bật Trình quản lý cập nhật
6. (Không bắt buộc) Định cấu hình Apache Solr
7. (Không bắt buộc) Cài đặt SmartDocs
8. (Không bắt buộc) Định cấu hình JQuery

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 cổng thông tin

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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

# 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=YOUR_EMAIL_PASSWORD

1. Kiểm tra kết nối với Apigee Edge

Kiểm tra kết nối giữa máy chủ mà bạn sẽ cài đặt cổng và Edge máy chủ quản lý bằng cách thực thi lệnh curl sau đây 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 của 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, curl 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á 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

Nếu bạn không chắc chắn liệu PHP đã được cài đặt trên máy chủ của mình hay chưa, hãy sử dụng lệnh sau:

rpm -qa | grep -i php

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 apigee-setup Edge 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 Postgres, như trong ví dụ 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 postgres_config_file

   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

Trước khi có thể cài đặt cổng thông tin, hãy đảm bảo rằng bạn đã thực hiện những việc sau như được mô tả trong 3. Cài đặt Postgres:

1. Cài đặt tiện ích Edge apigee-setup trên nút của cổng thông tin
2. Cài đặt Postgres, Postgres độc lập hoặc là một phần của quá trình cài đặt Edge

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

1. Tại dấu nhắc lệnh, hãy chạy tập lệnh setup:

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   Trong trường hợp:

   • configFile là tệp cấu hình cổng thông tin như mô tả trong Tạo tệp cấu hình cổng thông tin.
   • -p dp hướng dẫn tập lệnh setup cài đặt cổng thông tin.

Cách xác minh rằng quá trình cài đặt cổng thông tin đã thành công:

1. Chuyển đến trang chủ của cổng thông tin tại http://localhost:8079 hoặc đến tên DNS cổng của bạn.
2. Đă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 đã thiết lập trong cổng thông tin tệp cấu hình.
3. 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.
4. Đảm bảo rằng quá trình kết nối với Máy chủ quản lý đã thành công. Nếu không phải:
   1. Chuyển đến trang Cấu hình kết nối cổng thông tin (ví dụ: http://portal_IP:8079/admin/config/devconnect).
   2. Nhấp vào nút Kiểm tra kết nối. Nếu kết nối thành công, thế là xong. Nếu không kết nối được, hãy tiếp tục.
   3. Kiểm tra điểm cuối và chế độ cài đặt xác thực:
      • URL điểm cuối của API Quản lý: Kiểm tra để đảm bảo rằng giao thức (HTTP hoặc HTTPS), tên IP hoặc DNS và số cổng đều chính xác; ví dụ:

        http://10.10.10.10:8080/v1

      • Người dùng đã xác thực thiết bị đầu cuối: Người dùng của quản trị viên tổ chức tên người dùng.
      • Mật khẩu của người dùng xác thực: Thông tin của quản trị viên tổ chức mật khẩu.

      Giá trị mặc định phản ánh chế độ cài đặt trong tệp cấu hình cổng thông tin mà bạn tạo trong quá trình cài đặt.

      Các giá trị này phải khớp với ms_IP_or_DNS, email và password giá trị mà bạn đã sử dụng trong bước 1: Kiểm tra kết nối của bạn với Apigee Edge. Tên người dùng và mật khẩu cũng phải khớp với các giá trị của USER_NAME và USER_PWD thuộc tính trong tệp cấu hình giới thiệu hoặc thông tin đăng nhập của bất kỳ người dùng nào có vai trò là Quản trị viên tổ chức.

   4. Sau khi bạn kết nối thành công với Máy chủ quản lý, nhấp vào nút Lưu cấu hình ở cuối trang để lưu các thay đổi của bạn.

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, 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 thông tin 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. Các bước tiếp theo

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: