Cài đặt API BaaS

Edge for Private Cloud phiên bản 4.17.09

Tổng quan về quy trình cài đặt

Sau khi bạn cài đặt tiện ích Edge apigee-setup trên một nút, hãy sử dụng tiện ích đó để cài đặt một hoặc nhiều thành phần BaaS 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 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, thì tiện ích apigee-setup sẽ nhắc bạn nhập thông tin đó trên 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 API BaaS Stack:

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

Chỉ định các thành phần cần cài đặt

Tiện ích Apigee setup.sh hỗ trợ một số tuỳ chọn để cài đặt các thành phần API BaaS. Hướng dẫn dưới đây sử dụng các tuỳ chọn độc lập (c, e, b và p) nhưng bạn có thể sử dụng các tuỳ chọn khác dựa trên cấu hình nút của mình:

Lựa chọn

Nội dung mô tả

e

Chỉ cài đặt ElasticSearch.

b

Chỉ cài đặt API BaaS Stack, cũng cài đặt Tomcat.

p

Chỉ cài đặt Cổng API BaaS, cổng này cũng cài đặt bộ định tuyến Nginx để dùng làm máy chủ web.

c

Chỉ cài đặt Cassandra.

eb

Cài đặt ElasticSearch, API BaaS Stack và Tomcat trên nút.

ebp

Cài đặt ElasticSearch, Cổng API BaaS, Ngăn xếp API BaaS và Tomcat nhưng không cài đặt Cassandra. Cổng thông tin này rất gọn nhẹ nên không cần thêm tài nguyên nào khác.

asa

Cài đặt tất cả các thành phần API BaaS trên một nút (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat). Chỉ sử dụng lựa chọn này cho mục đích phát triển và thử nghiệm, không dùng cho môi trường thực tế.

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

Tệp cấu hình chứa tất cả thông tin cần thiết để cài đặt API BaaS. Bạn có thể thường sử dụng cùng một tệp cấu hình để cài đặt tất cả các thành phần trong bản cài đặt BaaS.

Mỗi cấu trúc liên kết cài đặt được mô tả dưới đây cho thấy một tệp cấu hình mẫu cho cấu trúc liên kết đó. Để biết thông tin tham khảo đầy đủ về tệp cấu hình, hãy xem phần Tài liệu tham khảo về tệp cấu hình BaaS.

Cài đặt API BaaS trên một nút duy nhất

Dưới đây là tệp cấu hình để cài đặt API BaaS trên một nút. Chỉnh sửa tệp này nếu cần cho cấu hình của bạn. Để biết thông tin tham khảo đầy đủ về tệp cấu hình, hãy xem phần Tài liệu tham khảo về tệp cấu hình BaaS.

IP1=192.168.56.101   # IP address of single node

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Because you are installing Cassandra,
# specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify Cassandra data center name.
BAAS_CASS_LOCALDC=dc-1

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes".
# For dc-1 with one Cassandra node, it is dc-1:1.
BAAS_CASS_REPLICATION=dc-1:1

# Defines the initial contact points for members of the BaaS cluster.
# For a single node install, specify the IP address of the node.
BAAS_CLUSTER_SEEDS="dc-1:$IP1"

# Single ElasticSearch IP.
ES_HOSTS="$IP1"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas"

# IP/DNS and port 8080 of a single Stack node.
BAAS_USERGRID_URL="http://$IP1:8080"

# URL and port of the BaaS Portal node.
BAAS_PORTAL_URL="http://$IP1:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPMAILFROM="My Company <myco@company.com>"

Cách cài đặt API BaaS trên nút riêng:

  1. Cài đặt tiện ích Edge apigee-setup trên nút bằng cách sử dụng quy trình có Internet hoặc không có Internet. Hãy xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.
  2. 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 asa -f configFile

    Tuỳ chọn "-p asa" chỉ định cài đặt tất cả các thành phần API BaaS trên một nút duy nhất (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat).

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

  3. Vì bạn đã cài đặt ElasticSearch trên một nút độc lập, hãy điều chỉnh tuỳ chọn bộ nhớ mặc định để tăng phân bổ bộ nhớ cho ElasticSearch từ 4 GB lên 6 GB:
    1. Mở /opt/apigee/customer/application/elasticsearch.properties trong trình chỉnh sửa. Nếu tệp này không tồn tại, hãy tạo tệp.
    2. Đặt thuộc tính setenv_elasticsearch_max_mem_size thành 6g (mặc định là 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Lưu tệp.
    4. Chạy lệnh sau: 
      /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart
  4. Đăng ký cho một tổ chức như mô tả dưới đây trong phần Đăng ký cho tổ chức mới.

Cấu hình hoàn tất thành công quá trình thiết lập trên nút.

Cài đặt API BaaS trên 7 hoặc 10 nút

Quy trình cài đặt phiên bản API BaaS 7 hoặc 10 nút rất giống nhau. Điểm khác biệt duy nhất là đối với:

  • Cài đặt 10 nút, bạn cài đặt 3 thành phần ElasticSearch và 3 thành phần API BaaS Stack trên các nút riêng biệt, tổng cộng là 6 nút. Bạn nên dùng cấu hình này để đạt được hiệu suất cao nhất vì ElasticSearch yêu cầu lượng I/O và bộ nhớ đĩa cao.
  • Trong quá trình cài đặt 7 nút, bạn cài đặt 3 thành phần ElasticSearch và 3 thành phần API BaaS Stack trên cùng nút, tổng cộng là 3 nút.

Đối với cả phiên bản 7 và 10 nút của API BaaS, bạn phải kết nối với một cụm Cassandra. Nếu đã cài đặt Edge, bạn có thể kết nối với cụm Cassandra của Edge, nghĩa là bạn không phải cài đặt Cassandra trong quá trình cài đặt API BaaS.

Dưới đây là ví dụ về tệp cấu hình tự động cho một bản cài đặt API BaaS 10 nút. Nếu bạn đang cài đặt các thành phần ElasticSearch và API BaaS Stack trên cùng ba nút, hãy chỉnh sửa tệp để:

  • IP1 và IP4 được đặt thành cùng một địa chỉ IP
  • IP2 và IP5 được đặt thành cùng một địa chỉ IP
  • IP3 và IP6 được đặt thành cùng một địa chỉ IP

Chỉnh sửa tệp này nếu cần cho cấu hình của bạn. Để biết thông tin tham khảo đầy đủ về tệp cấu hình, hãy xem phần Tài liệu tham khảo về tệp cấu hình BaaS. 

# Specify IP address or DNS name of node.
IP1=192.168.1.1   # ElasticSearch
IP2=192.168.1.2   # ElasticSearch
IP3=192.168.1.3   # ElasticSearch
IP4=192.168.1.4   # API BaaS Stack
IP5=192.168.1.5   # API BaaS Stack
IP6=192.168.1.6   # API BaaS Stack
IP7=192.168.1.7   # API BaaS Portal
IP8=192.168.1.8   # Cassandra (shared with Edge or standalone)
IP9=192.168.1.9   # Cassandra (shared with Edge or standalone)
IP10=192.168.1.10  # Cassandra (shared with Edge or standalone)

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Define the API BaaS administrator account.  
AS_ADMIN="superuser"    # User name - default is "superuser".
AS_ADMIN_EMAIL=stackAdmin@email.com
AS_PASSWD=stackAdminPWord

# Only if you are installing Cassandra.
# Specify Cassandra data center and rack suffix.
# Must use IP addresses for CASS_HOSTS, not DNS names.
# CASS_HOSTS="$IP8:1,1 $IP9:1,1 $IP10:1,1"

# If connecting to existing Cassandra nodes, 
# specify Cassandra IPs.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP8 $IP9 $IP10"

# Specify the Cassandra region.
REGION=dc-1

# Cassandra uname/pword.
# Even if Cassandra authentication is disabled,
# you must still pass values for these properties.
CASS_USERNAME=cassandra    # Default value
CASS_PASSWORD=cassandra    # Default value

# Specify BaaS Cassandra connection information.
# Specify the data center name.
BAAS_CASS_LOCALDC=dc-1    # Default is dc-1.

# For a single data center, specify the same value as BAAS_CASS_LOCALDC.
BAAS_CASS_DC_LIST=dc-1

# Replication is in the form "dataCenterName:#CassandraNodes". 
# For example, for dc-1 with three Cassandra nodes, it is dc-1:3.
BAAS_CASS_REPLICATION=dc-1:3

# Defines the initial contact points for members of the BaaS cluster. 
# Specify the IP address of no more than two Stack nodes. 
BAAS_CLUSTER_SEEDS="dc-1:$IP4,dc-1:$IP5"

# ElasticSearch IPs or DNS names, separated by spaces.
ES_HOSTS="$IP1 $IP2 $IP3"

# API BaaS Stack information.
# Default cluster name is "apigee_baas"
BAAS_USERGRID_CLUSTERNAME="apigee_baas" 

# URL and port of the load balancer for the API BaaS Stack nodes, 
# or IP/DNS and port 8080 of a single Stack node with no load balancer.
BAAS_USERGRID_URL=http://myloadbalancer:8443

# API BaaS Portal information.
# URL and port number of load balancer, if there is one in front of the Portal,
# or the URL and port of the Portal node.  
BAAS_PORTAL_URL="http://$IP7:9000"

# Portal port. Default value is 9000.
BAAS_PORTAL_LISTEN_PORT=9000 

# SMTP information. BaaS requires an SMTP server.
SMTPHOST=smtp.gmail.com
SMTPPORT=465
SMTPUSER=your@email.com
SMTPPASSWORD=yourEmailPassword
SMTPSSL=y
SMTPMAILFROM="My Company <myco@company.com>"

Không bắt buộc – Cài đặt Cassandra: Máy 8, 9 và 10

Bạn có thể kết nối API BaaS với cùng một cụm Cassandra mà Edge sử dụng. Nếu chưa cài đặt Edge, bạn có thể cài đặt Cassandra để API BaaS sử dụng.

Cụm Cassandra có thể sử dụng phương thức xác thực hoặc bạn có thể tắt phương thức xác thực Cassandra. Hãy xem phần Bật tính năng xác thực Cassandra để biết thêm thông tin.

  1. Cài đặt tiện ích Edge apigee-setup trên nút bằng cách sử dụng quy trình có Internet hoặc không có Internet. Hãy xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.
  2. 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 c -f configFile

    Tuỳ chọn "-p c" chỉ định cài đặt Cassandra.

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

Cấu hình này hoàn tất thành công quá trình thiết lập kho dữ liệu trên nút.

Xin lưu ý rằng JMX được bật theo mặc định cho Cassandra. Quyền truy cập từ xa JMX vào Cassandra không yêu cầu mật khẩu. Bạn có thể định cấu hình Cassandra để sử dụng phương thức xác thực cho JMX. Để biết thêm thông tin, hãy xem bài viết Cách giám sát.

Thiết lập dịch vụ chạy ngầm theo thời gian định trước của Cassandra

Nếu bạn phải cài đặt Cassandra, hãy thiết lập một dịch vụ chạy ngầm theo thời gian định trước sử dụng nodetool để xoá các khoá chạy mỗi giờ trên mọi nút Cassandra.

Nếu bạn có nhiều nút Cassandra, hãy bù trừ dịch vụ chạy ngầm theo thời gian định trước trên mỗi máy chủ 5 phút để tất cả các nút không xả dữ liệu cùng một lúc.

Dịch vụ chạy ngầm theo thời gian định trước phải thực thi lệnh sau:

/opt/apigee/apigee-cassandra/bin/nodetool -h IP_address flush Apigee_Baas_Locks

trong đó IP_address là địa chỉ IP của nút Cassandra.

Cài đặt ElasticSearch: Máy 1, 2 và 3

Cách cài đặt ElasticSearch trên nút riêng:

  1. Cài đặt tiện ích apigee-setup của Edge trên nút bằng quy trình có Internet hoặc không có Internet. Xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.
  2. 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 e -f configFile
      
    The "-p e" option specifies to install ElasticSearch. The configuration file must be
      accessible or readable by the "apigee" user.
  3. (Optional) If you install ElasticSearch on a standalone node, meaning it is not installed with API BaaS Stack, then adjust the default memory option to increase the memory allocated for ElasticSearch from 4GB to 6GB:
    1. Open /opt/apigee/customer/application/elasticsearch.properties in an editor. If this file does not exist, create it.
    2. Set the setenv_elasticsearch_max_mem_size property to 6g (the default is 4g): 
      setenv_elasticsearch_max_mem_size=6g
    3. Lưu tệp.
    4. Chạy lệnh sau: 
      /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart

    Cấu hình hoàn tất thành công quá trình thiết lập trên nút.

    Cài đặt API BaaS Stack: Máy 4, 5 và 6

    Cách cài đặt API BaaS Stack trên nút riêng:

    1. Cài đặt tiện ích apigee-setup của Edge trên nút bằng quy trình có Internet hoặc không có Internet. Xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.
    2. 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 b -f configFile

      Tuỳ chọn "-p b" chỉ định cài đặt API BaaS Stack. Người dùng "apigee" phải truy cập hoặc đọc được tệp cấu hình.

    Sau khi trình cài đặt tìm nạp thông tin đăng nhập quản trị viên chính xác, trình cài đặt sẽ cài đặt Tomcat, tạo không gian khoá API BaaS và thiết lập Ngăn xếp API BaaS trên máy chủ. SMTP cũng được định cấu hình để cho phép giao diện người dùng gửi email xác nhận mật khẩu.

    Cài đặt Cổng API BaaS: Máy 7

    Cách cài đặt Cổng API BaaS:

    1. Cài đặt tiện ích apigee-setup của Edge trên nút bằng quy trình có Internet hoặc không có Internet. Xem phần Cài đặt tiện ích apigee-setup của Edge để biết thêm thông tin.
    2. 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 p -f configFile

      Tuỳ chọn "-p p" chỉ định cài đặt Cổng API BaaS. Người dùng "apigee" phải truy cập hoặc đọc được tệp cấu hình.

      Trình cài đặt sẽ khởi động máy chủ web Nginx rồi hoàn tất cấu hình Cổng API BaaS.

    3. Bước tiếp theo sẽ phụ thuộc vào chế độ cài đặt của bạn.
      1. Nếu bạn có một trình cân bằng tải trước các nút Portalor Stack, thì phần tiếp theo sẽ mô tả cách định cấu hình API BaaS cho trình cân bằng tải.
      2. Nếu bạn không có trình cân bằng tải trước các nút Portalor Stack, hãy tham gia một tổ chức như mô tả dưới đây trong phần Tham gia một tổ chức mới.

    Ghi lại URL của Cổng API BaaS. Đây là URL mà bạn nhập vào trình duyệt để truy cập vào giao diện người dùng của Cổng API BaaS.

    Định cấu hình các nút API BaaS cho bộ cân bằng tải Stack hoặc Portal

    Nếu thêm một trình cân bằng tải trước các nút Stack hoặc Portal, bạn phải định cấu hình các nút đó bằng URL chính xác của trình cân bằng tải. Ví dụ: các nút Ngăn xếp cần thông tin này khi:

    • Đưa URL vào phản hồi trong các yêu cầu API BaaS.
    • Thêm đường liên kết vào mẫu email khi đặt lại mật khẩu hoặc gửi các thông báo khác.
    • Chuyển hướng người dùng đến các trang cụ thể trên Cổng thông tin.

    Nếu bạn sử dụng trình cân bằng tải trước các nút Stack, hãy đặt thuộc tính sau trong /opt/apigee/customer/application/usergrid.properties:

    usergrid-deployment_usergrid.api.url.base=http://localhost:8080

    Thay thế http://localhost:8080 bằng URL của trình cân bằng tải. Nếu trình cân bằng tải được định cấu hình để sử dụng TLS, hãy sử dụng giao thức HTTPS. Bạn chỉ cần thêm cổng nếu đang sử dụng cổng không chuẩn, tức là cổng khác với cổng 80 cho HTTP và cổng 443 cho HTTPS.

    Bạn cũng phải đặt thuộc tính sau trong /opt/apigee/customer/application/portal.properties nếu bạn sử dụng trình cân bằng tải trước các nút Stack:

    baas.portal.config.overrideUrl=http://localhost:8080

    Thay thế http://localhost:8080 bằng URL của trình cân bằng tải cho Stack.

    Nếu bạn sử dụng trình cân bằng tải trước nút Cổng thông tin, hãy đặt các thuộc tính sau trong usergrid.properties:

    usergrid-deployment_portal.url=http://localhost:9000

    Thay thế http://localhost:9000 bằng URL của trình cân bằng tải. Nếu trình cân bằng tải được định cấu hình để sử dụng TLS, hãy sử dụng giao thức HTTPS. Bạn chỉ cần thêm cổng nếu đang sử dụng cổng không chuẩn, tức là cổng khác với cổng 80 cho HTTP và cổng 443 cho HTTPS.

    Sau khi chỉnh sửa usergrid.properties và portal.properties:

    1. Định cấu hình nút Stack: 
      /opt/apigee/apigee-service/bin/apigee-service baas-usergrid configure
    2. Khởi động lại BaaS Stack: 
      /opt/apigee/apigee-service/bin/apigee-service baas-usergrid restart
    3. Nếu bạn đã sửa đổi portal.properties, hãy định cấu hình nút Cổng: 
      /opt/apigee/apigee-service/bin/apigee-service baas-portal configure
    4. Khởi động lại Cổng BaaS: 
      /opt/apigee/apigee-service/bin/apigee-service baas-portal restart

    Đăng ký một tổ chức mới

    Đăng ký là quy trình tạo tổ chức và quản trị viên tổ chức. Sau khi tạo tổ chức và quản trị viên tổ chức, bạn có thể đăng nhập vào giao diện người dùng của Cổng API BaaS và gửi yêu cầu đến API REST của API BaaS.

    Khi bạn tạo một tổ chức, địa chỉ email của quản trị viên tổ chức:

    • Phải khác với địa chỉ email của quản trị viên hệ thống.
    • Phải là duy nhất trong số tất cả các tổ chức khác. Tức là bạn không thể tạo hai tổ chức có cùng địa chỉ email cho quản trị viên tổ chức. Tuy nhiên, sau khi tạo tổ chức, bạn có thể thêm các quản trị viên khác và những quản trị viên này có thể được sao chép trên nhiều tổ chức.

    Để thực hiện quy trình làm quen với ứng dụng, hãy sử dụng tập lệnh Python create_org_and_user.py. Việc gọi tập lệnh này mà không có đối số dòng lệnh sẽ khiến tập lệnh nhắc bạn cung cấp tất cả thông tin:

    python create_org_and_user.py

    Ngoài ra, bạn có thể truyền bất kỳ hoặc tất cả các tuỳ chọn dưới dạng đối số dòng lệnh. Bạn sẽ được nhắc cung cấp mọi thông tin mà bạn bỏ qua trong dòng lệnh:

    python create_org_and_user.py -o '<org name>'
python create_org_and_user.py -o '<org name>' -a '<new admin email>' -p '<new admin password>'

    Cách tạo tổ chức:

    1. Thay đổi thư mục thành /opt/apigee/baas-usergrid/bin.
    2. Gọi tập lệnh Python create_org_and_user.py.

      Bạn sẽ được nhắc nhập tên người dùng và mật khẩu của quản trị viên hệ thống BaaS để chỉ quản trị viên hệ thống mới có thể chạy công cụ này.

    3. Đăng nhập vào Cổng API BaaS trong trình duyệt web bằng URL mà bạn đã ghi chú ở cuối quá trình cài đặt URL Cổng API BaaS. Để truy cập vào cổng thông tin, hãy nhập URL của Cổng API BaaS vào biểu mẫu: 
      http://portalExternalIP:9000/
    4. Khi màn hình đăng nhập vào cổng thông tin xuất hiện, bạn có thể:
      • Đăng nhập bằng tên người dùng và mật khẩu của quản trị viên tổ chức.
      • Đăng nhập bằng tên người dùng và mật khẩu của quản trị viên hệ thống.

    Truy cập vào API REST của API BaaS

    Để truy cập vào API REST của API BaaS, hãy sử dụng URL ở dạng:

    https://loadBalancerIP:8080/your-org/your-app

    Trong môi trường phát triển, bạn có thể cài đặt tất cả thành phần API BaaS trên một nút, nghĩa là bạn có một Ngăn xếp API BaaS duy nhất. Hoặc bạn có thể có một môi trường nhỏ với một nút API BaaS Stack và không có trình cân bằng tải. Trong các loại môi trường này, bạn có thể thực hiện lệnh gọi API trực tiếp đến nút Ngăn xếp BaaS API:

    curl -v "http://portalExternalIP:8080/status"

    Để biết thêm thông tin về cách bắt đầu sử dụng Cổng API BaaS, hãy xem tài liệu về Apigee tại: http://apigee.com/docs/content/build-apps-home.