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

Developer Services Portal phiên bản 4.16.05

Làm theo các bước sau để cài đặt cổng Developer Channel Services.

Trước khi tiến hành cài đặt, hãy sao lưu toàn bộ thư mục gốc của trang web Drupal. Vị trí cài đặt mặc định là /var/www/html, nhưng bạn có thể đã thay đổi vị trí này tại thời điểm cài đặt. Sau khi thực hiện các bước cài đặt được mô tả dưới đây, bạn có thể khôi phục các tuỳ chỉnh của mình từ bản sao lưu.

1. Tải gói Dịch vụ kênh nhà phát triển

Truy cập vào http://community.apigee.com/content/apigee-customer-support rồi chọn Đăng nhập vào Cổng hỗ trợ để yêu cầu tệp .tar của Dịch vụ kênh dành cho nhà phát triển theo một trong hai cách sau:

• Yêu cầu quyền truy cập vào thư mục tải xuống Edge for Private Cloud.
• Yêu cầu URL đến tệp .tar của Dịch vụ kênh dành cho nhà phát triển.

2. Đảm bảo hệ thống của bạn đáp ứng các yêu cầu về hệ thống

Trước khi bạn cài đặt cổng thông tin, máy chủ của bạn phải đáp ứng các yêu cầu sau:

1. Đảm bảo rằng 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 đây.
2. Đảm bảo bạn đã cài đặt Yum.
3. (Đối với việc cài đặt trên máy chủ không có kết nối Internet) Trước tiên, bạn phải tải tất cả tệp cần thiết xuống một máy chủ có kết nối Internet dưới dạng một tệp .tar.gz duy nhất. Sau đó, bạn sao chép tệp .tar.gz đó vào máy chủ không có kết nối Internet để thực hiện cài đặt.
   1. Đăng nhập vào máy chủ có kết nối Internet với tư cách là người dùng gốc hoặc siêu người dùng.
   2. Tạo một thư mục cho các tệp cài đặt, chẳng hạn như portal_tar.
   3. Chuyển đến thư mục mới và tải tệp DeveloperServices_x.y.z.tar của Dịch vụ kênh dành cho nhà phát triển xuống, trong đó x.y.z tương ứng với số phiên bản cổng thông tin.
   4. Giải nén nội dung của tệp .tar trong Developer Channel Services bằng cách sử dụng lệnh:
      > tar -xvf <tar file>
   5. Chuyển đến thư mục DeveloperServices-4.x.y.z.
   6. Tạo tệp .tar.gz của cổng thông tin bằng cách sử dụng lệnh:
      > ./non-networked-install.sh
      
      Lệnh đó sẽ tải tất cả tệp cần thiết xuống và đưa vào một tệp .tar.gz duy nhất. Sau đó, bạn sao chép tệp .tar.gz đó vào máy chủ không có kết nối Internet để hoàn tất quá trình cài đặt.
4. 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ừ dấu nhắc lệnh trên máy chủ cổng thông tin:
   > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/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 dành riêng 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"
   }

3. Cài đặt Dịch vụ kênh nhà phát triển bằng tập lệnh cài đặt tự động

Hãy làm theo quy trình sau để cài đặt cổng thông tin bằng tập lệnh cài đặt tự động. Quy trình này áp dụng cho các máy chủ có hoặc không có kết nối Internet bên ngoài.

1. Đăng nhập vào máy chủ với tư cách là người dùng gốc hoặc siêu người dùng.
2. Tạo một thư mục cho các tệp cài đặt, chẳng hạn như portal.
3. Trên máy chủ có kết nối Internet:
   1. Chuyển đến thư mục portal mới và tải tệp DeveloperServices_x.y.z.tar của Developer Channel Services xuống, trong đó x.y.z tương ứng với số phiên bản của cổng thông tin.
      
      Bạn có thể tải tệp xuống từ đường liên kết mà Apigee gửi cho bạn trong trình duyệt hoặc bằng cách sao chép đường liên kết đó rồi thêm vào lệnh cURL sau:
      > curl -kOL <paste link here>
   2. Giải nén nội dung của tệp .tar trong Developer Channel Services bằng cách sử dụng lệnh:
      > tar -xvf <tar file>
   3. Chuyển đến thư mục DeveloperServices-4.x.y.z.
   4. Chạy tập lệnh cài đặt bằng lệnh sau:
      > ./networked-install.sh
4. Trên máy chủ không có kết nối Internet:
   1. Sao chép tệp .tar.gz mà bạn đã tạo ở trên trong phần 2. Đảm bảo hệ thống của bạn đáp ứng các yêu cầu về hệ thống.
   2. Giải nén nội dung của tệp .tar.gz bằng lệnh:
      > tar -xvf <tar file>
   3. Chuyển đến thư mục được tạo bằng lệnh tar.
   4. Đặt quyền trên tập lệnh install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
   5. Chạy tập lệnh install-from-rpm-bundle.sh bằng cách sử dụng lệnh:
      > ./install-from-rpm-bundle.sh
5. Trả lời các câu hỏi.
6. Sau khi quá trình cài đặt hoàn tất, hãy chuyển đến URL của máy chủ trong trình duyệt, chẳng hạn như:
   http://localhost. Hoặc nếu bạn đã định cấu hình một IP hoặc DNS cụ thể, hãy truy cập vào http://IP_address hoặc http://DNS_name.
   
   Bạn sẽ được chuyển hướng đến trang cấu hình Cơ sở dữ liệu hồ sơ Apigee.
   
   Lưu ý: Thông thường, bạn sẽ phải định cấu hình tên máy chủ và đăng ký tên đó với máy chủ DNS để không phải sử dụng http://localhost.
7. Định cấu hình kết nối với MySQL. Nếu MySQL nằm trên một máy từ xa, hãy mở rộng mục Advanced Options (Tuỳ chọn nâng cao) rồi nhập thông tin kết nối với máy đó, sau đó chọn Save and continue (Lưu và tiếp tục).
8. Định cấu hình kết nối với Điểm cuối Apigee bằng cách nhập thông tin sau, rồi chọn Lưu:
   Để biết thêm thông tin về các giá trị này, hãy xem phần "Thông tin bắt buộc trước khi bạn bắt đầu cài đặt" tại Yêu cầu về cổng dịch vụ dành cho nhà phát triển.
   1. Tổ chức trên Cổng thông tin dành cho nhà phát triển
   2. URL điểm cuối của cổng thông tin dành cho nhà phát triển
   3. Người dùng được xác thực điểm cuối
   4. Mật khẩu của người dùng đã xác thực
9. Khi được nhắc, hãy chọn nút Install Sample SmartDocs WADL (Cài đặt WADL SmartDocs mẫu) để cài đặt WADL SmartDocs mẫu. Nếu bạn bỏ qua bước này, thì API SmartDocs mẫu sẽ không xuất hiện trên cổng thông tin của bạn.
   Lưu ý: Nếu cổng thông tin của bạn kết nối với một bản cài đặt Apigee Edge cho Đám mây riêng tư và bản cài đặt Edge đó không có kết nối Internet bên ngoài, thì bạn phải thực hiện cấu hình bổ sung cho mô-đun SmartDocs trước khi có thể sử dụng SmartDocs. Để biết thêm thông tin về SmartDocs, hãy xem http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
10. Định cấu hình Cài đặt máy chủ SMTP. Apigee yêu cầu bạn định cấu hình một máy chủ SMTP để gửi nội dung email từ cổng thông tin.
    Để biết thêm thông tin, hãy xem http://apigee.com/docs/developer-services/content/configuring-email.
11. Định cấu hình người dùng quản trị viên bằng cách nhập thông tin sau, rồi chọn Lưu. Xin lưu ý rằng theo mặc định, Drupal sẽ tạo một người dùng quản trị có tên là "admin", vì vậy, đừng sử dụng "admin" làm tên người dùng.
    Nếu bỏ qua bước này, bạn vẫn có thể sử dụng Drush để tạo quản trị viên như mô tả dưới đây trong bước 4. Tạo người dùng quản trị.
    1. Họ và tên của nhà phát triển
    2. Tên người dùng trên cổng thông tin dành cho nhà phát triển
    3. Mật khẩu
    4. Địa chỉ email
12. Sau khi cài đặt xong, hãy đặt quyền cho tệp settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
13. Chuyển đến trang chủ của cổng thông tin tại http://localhost/ hoặc đến tên DNS của cổng thông tin.
14. Đă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.

4. Tạo người dùng quản trị

Sử dụng Drush để tạo người dùng có quyền quản trị cho bản cài đặt Developer Channel Services. Theo mặc định, Drupal tự động tạo một người dùng quản trị có tên là "admin", vì vậy, đừng sử dụng "admin" làm tên người dùng.

1. Chuyển đến thư mục drupal_root/sites/default. Vị trí chuẩn cho thư mục gốc của Drupal là /var/www/html:
   > cd <drupal_root>/sites/default
2. Đảm bảo rằng bạn có quyền ghi đối với các tệp Drupal riêng tư:
   > drush vget file_private_path
   
   Lệnh này trả về đường dẫn đến các tệp Drupal riêng tư, ví dụ:
   file_private_path: 'sites/default/private'
   
   Tương ứng với /var/www/html/sites/default/private/. Sử dụng lệnh sau để đảm bảo rằng chủ sở hữu và nhóm có thể ghi vào thư mục này:
   chmod -R g+w dirPathAndName
   chmod -R o+r dirPathAndName
3. Nhập các lệnh sau để tạo người dùng quản trị, thay thế các lệnh trong "< >" bằng giá trị của bạn:
   > drush user-create <username> --mail="<email-address>" --password="<password>"
   > drush user-add-role Administrator <username>
4. Đăng nhập vào cổng thông tin cho nhà phát triển với tư cách quản trị viên bằng cách sử dụng tên người dùng và mật khẩu được chỉ định ở trên.

5. Đặt mật khẩu gốc MySQL

Nếu bạn cài đặt MySQL trong quá trình cài đặt cổng thông tin, thì tập lệnh cài đặt sẽ đặt mật khẩu gốc của MySQL thành giá trị mặc định, tức là để trống.

Sử dụng lệnh sau để đặt mật khẩu gốc:

> mysqladmin -u root password NEWPASSWORD

Nếu trước đây bạn đã đặt mật khẩu gốc và muốn thay đổi mật khẩu đó, hãy sử dụng lệnh sau:

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

Bạn cũng phải cập nhật mật khẩu trong tệp /var/www/html/sites/default/settings.php.

6. Đả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

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.

7. Không bắt buộc – Triển khai trên máy chủ chính thức

Nếu đang triển khai cổng thông tin trên máy chủ chính thức, bạn nên thực hiện thêm các bước bảo mật, bao gồm:

1. Chạy tập lệnh sau để bảo mật quá trình cài đặt MySQL:
   > /usr/bin/mysql_secure_installation
   
   Tập lệnh này đặt mật khẩu gốc và cho phép bạn hạn chế quyền truy cập gốc chỉ cho máy chủ cục bộ, đồng thời xoá cơ sở dữ liệu thử nghiệm và người dùng ẩn danh được tạo theo mặc định. Bạn nên chạy tập lệnh này cho các máy chủ chính thức.
2. Nếu chính sách của công ty bạn yêu cầu, hãy bật và định cấu hình SELinux.

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

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.

9. Không bắt buộc – Cài đặt mod_ssl để hỗ trợ HTTPS

Mô-đun mod_ssl được Máy chủ HTTP Apache sử dụng để phân phát các trang web qua HTTPS. Nếu bạn muốn sử dụng HTTPS, hãy dùng lệnh sau để cài đặt mod_ssl:

> yum install mod_ssl

Để biết thêm thông tin về cách định cấu hình cổng thông tin để sử dụng SSL, hãy xem http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Không bắt buộc – Cài đặt SmartDocs

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.

Để biết thêm thông tin về SmartDocs, hãy xem bài viết Sử dụng SmartDocs để ghi lại API.

11. 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: