Penginstalan BaaS API

Edge for Private Cloud v4.18.01

Ringkasan penginstalan

Setelah menginstal utilitas apigee-setup Edge di node, gunakan utilitas tersebut untuk menginstal satu atau beberapa komponen BaaS di node.

Utilitas apigee-setup memiliki bentuk:

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

Teruskan file konfigurasi ke utilitas apigee-setup yang berisi informasi tentang penginstalan. Jika file konfigurasi tidak memiliki informasi yang diperlukan, utilitas apigee-setup akan meminta Anda memasukkannya di command line.

Satu-satunya persyaratan adalah file konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".

Misalnya, gunakan perintah berikut untuk menginstal Stack BaaS API:

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

Menentukan komponen yang akan diinstal

Utilitas setup.sh Apigee mendukung beberapa opsi untuk menginstal komponen API BaaS. Petunjuk di bawah ini menggunakan opsi mandiri (c, e, b, dan p), tetapi Anda dapat menggunakan opsi yang berbeda berdasarkan konfigurasi node:

Opsi

Deskripsi

e

Hanya instal ElasticSearch.

b

Hanya menginstal API BaaS Stack, yang juga menginstal Tomcat.

p

Hanya menginstal Portal BaaS API, yang juga menginstal router Nginx untuk digunakan sebagai server web.

c

Instal Cassandra saja.

eb

Instal ElasticSearch, API BaaS Stack, dan Tomcat di node.

ebp

Menginstal ElasticSearch, API BaaS Portal, API BaaS Stack, dan Tomcat, tetapi tidak menginstal Cassandra. Portal ini sangat ringan sehingga tidak memerlukan resource tambahan untuk ini.

asa

Instal semua komponen API BaaS di satu node (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat). Gunakan opsi ini hanya untuk pengembangan dan pengujian, bukan untuk produksi.

Membuat file konfigurasi

File konfigurasi berisi semua informasi yang diperlukan untuk menginstal API BaaS. Anda sering kali dapat menggunakan file konfigurasi yang sama untuk menginstal semua komponen dalam penginstalan BaaS.

Setiap topologi penginstalan yang dijelaskan di bawah menunjukkan contoh file konfigurasi untuk topologi tersebut. Untuk referensi lengkap tentang file konfigurasi, lihat Referensi File Konfigurasi BaaS.

Menginstal API BaaS di satu node

File konfigurasi untuk menginstal API BaaS di satu node ditampilkan di bawah. Edit file ini sesuai kebutuhan untuk konfigurasi Anda. Untuk referensi lengkap tentang file konfigurasi, lihat Referensi File Konfigurasi 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>"

Untuk menginstal API BaaS di node-nya sendiri:

  1. Instal utilitas apigee-setup Edge di node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas penyiapan apigee Edge untuk mengetahui informasi selengkapnya.
  2. Di command prompt, jalankan skrip penyiapan:
    > /opt/apigee/apigee-setup/bin/setup.sh -p asa -f configFile

    Opsi “-p asa” menentukan untuk menginstal semua komponen API BaaS di satu node (Cassandra, Elasticsearch, API BaaS Stack, API BaaS Portal, Tomcat).
    File konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".
  3. Karena Anda menginstal ElasticSearch pada node mandiri, sesuaikan opsi memori default untuk meningkatkan memori yang dialokasikan untuk ElasticSearch dari 4 GB menjadi 6 GB:
    1. Buka /opt/apigee/customer/application/elasticsearch.properties di editor. Jika file ini tidak ada, buatlah.
    2. Tetapkan properti setenv_elasticsearch_max_mem_size ke 6 g (default-nya adalah 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Simpan file.
    4. Jalankan perintah berikut:
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart
  4. ?Melakukan orientasi organisasi seperti yang dijelaskan di bawah dalam Melakukan orientasi organisasi baru.

Konfigurasi berhasil menyelesaikan penyiapan di node.

Menginstal API BaaS di 7 atau 10 node

Prosedur untuk menginstal API BaaS versi 7 atau 10 node sangat mirip. Satu-satunya perbedaan adalah untuk:

  • 10 node, Anda menginstal tiga komponen ElasticSearch dan tiga komponen API BaaS Stack di node yang terpisah, dengan total enam node. Ini adalah konfigurasi yang direkomendasikan untuk performa tertinggi karena ElasticSearch memerlukan I/O dan memori disk dalam jumlah besar.
  • 7 node, Anda menginstal tiga komponen ElasticSearch dan tiga komponen API BaaS Stack di node yang sama, dengan total tiga node.

Untuk API BaaS versi node 7 dan 10, Anda harus terhubung ke cluster Cassandra. Jika telah menginstal Edge, Anda dapat terhubung ke cluster Cassandra-nya, yang berarti Anda tidak harus menginstal Cassandra sebagai bagian dari menginstal API BaaS.

Di bawah ini adalah contoh file konfigurasi senyap untuk penginstalan API BaaS 10 node. Jika Anda menginstal komponen ElasticSearch dan API BaaS Stack pada tiga node yang sama, edit file sehingga:

  • IP1 dan IP4 ditetapkan ke alamat IP yang sama
  • IP2 dan IP5 ditetapkan ke alamat IP yang sama
  • IP3 dan IP6 ditetapkan ke alamat IP yang sama

Edit file ini sesuai kebutuhan untuk konfigurasi Anda. Untuk referensi lengkap tentang file konfigurasi, lihat Referensi File Konfigurasi 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>"

Opsional - Instal Cassandra: Komputer 8, 9, dan 10

Anda dapat menghubungkan BaaS API ke cluster Cassandra yang sama seperti yang digunakan oleh Edge. Jika belum menginstal Edge, Anda dapat menginstal Cassandra untuk digunakan oleh API BaaS secara opsional.

Cluster Cassandra dapat menggunakan autentikasi, atau autentikasi Cassandra dapat dinonaktifkan. Lihat Mengaktifkan autentikasi Cassandra untuk mengetahui informasi selengkapnya.

  1. Instal utilitas apigee-setup Edge di node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas penyiapan Edge apigee untuk informasi selengkapnya.
  2. Di command prompt, jalankan skrip penyiapan:
    > /opt/apigee/apigee-setup/bin/setup.sh -p c -f configFile

    Opsi “-p c” menentukan untuk menginstal Cassandra.
    File konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".

Konfigurasi berhasil menyelesaikan penyiapan datastore di node.

Perhatikan bahwa JMX diaktifkan secara default untuk Cassandra. Akses jarak jauh JMX ke Cassandra tidak memerlukan sandi. Anda dapat mengonfigurasi Cassandra untuk menggunakan autentikasi untuk JMX. Untuk mengetahui informasi selengkapnya, lihat Cara Memantau.

Menyiapkan cron job Cassandra

Jika Anda harus menginstal Cassandra, siapkan tugas cron yang menggunakan nodetool untuk menghapus kunci agar berjalan setiap jam di setiap node Cassandra.

Jika Anda memiliki beberapa node Cassandra, offset tugas cron di setiap server dengan lima menit sehingga semua node tidak dihapus sekaligus.

Tugas cron harus menjalankan perintah berikut:

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

dengan IP_address adalah alamat IP node Cassandra.

Instal ElasticSearch: Mesin 1, 2, dan 3

Untuk menginstal ElasticSearch di node-nya sendiri:

  1. Instal utilitas penyiapan apigee Edge di node menggunakan internet atau prosedur non-internet. Lihat Menginstal utilitas penyiapan apigee Edge untuk mengetahui informasi selengkapnya.
  2. Di command prompt, jalankan skrip penyiapan:
    > /opt/apigee/apigee-setup/bin/setup.sh -p e -f configFile

    Opsi “-p e” menentukan untuk menginstal ElasticSearch.
    File konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".
  3. (Opsional) Jika Anda menginstal ElasticSearch di node mandiri, yang berarti tidak diinstal dengan API BaaS Stack, sesuaikan opsi memori default untuk meningkatkan memori yang dialokasikan untuk ElasticSearch dari 4 GB menjadi 6 GB:
    1. Buka /opt/apigee/customer/application/elasticsearch.properties di editor. Jika file ini tidak ada, buatlah.
    2. Tetapkan properti setenv_elasticsearch_max_mem_size ke 6g (default-nya adalah 4g):
      setenv_elasticsearch_max_mem_size=6g
    3. Simpan file.
    4. Jalankan perintah berikut:
      > /opt/apigee/apigee-service/bin/apigee-service apigee-elasticsearch restart

Konfigurasi berhasil menyelesaikan penyiapan di node.

Menginstal API BaaS Stack: Mesin 4, 5, dan 6

Untuk menginstal API BaaS Stack di node-nya sendiri:

  1. Instal utilitas penyiapan apigee Edge di node menggunakan internet atau prosedur non-internet. Lihat Menginstal utilitas penyiapan apigee Edge untuk mengetahui informasi selengkapnya.
  2. Di command prompt, jalankan skrip penyiapan:
    > /opt/apigee/apigee-setup/bin/setup.sh -p b -f configFile

    Opsi “-p b” menentukan untuk menginstal API BaaS Stack.
    File konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".

Setelah penginstal mengambil kredensial admin yang benar, penginstal akan menginstal Tomcat, membuat ruang kunci API BaaS, dan menyiapkan API BaaS Stack di server. SMTP juga dikonfigurasi untuk mengizinkan UI mengirim email konfirmasi sandi.

Menginstal Portal BaaS API: Mesin 7

Untuk menginstal Portal BaaS API:

  1. Instal utilitas penyiapan apigee Edge pada node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas penyiapan apigee Edge untuk mengetahui informasi selengkapnya.
  2. Di command prompt, jalankan skrip penyiapan:
    > /opt/apigee/apigee-setup/bin/setup.sh -p p -f configFile

    Opsi “-p p” menentukan untuk menginstal Portal BaaS API.
    File konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".

    Instalator memulai server web Nginx, lalu menyelesaikan konfigurasi Portal BaaS API.
  3. ?Langkah berikutnya bergantung pada penginstalan Anda.
    1. Jika Anda memiliki load balancer di depan node Portal atau Stack, bagian berikutnya menjelaskan cara mengonfigurasi BaaS API untuk load balancer.
    2. Jika Anda tidak memiliki load balancer di depan node Portalor Stack, lakukan aktivasi organisasi seperti yang dijelaskan di bawah dalam Melakukan aktivasi organisasi baru.

Catat URL Portal BaaS API. Ini adalah URL yang Anda masukkan ke browser untuk mengakses antarmuka pengguna Portal BaaS API.

Mengonfigurasi node BaaS API untuk load balancer Stack atau Portal

Jika menyertakan load balancer di depan node Stack atau Portal, Anda harus mengonfigurasi node dengan URL load balancer yang benar. Misalnya, node Stack memerlukan informasi ini saat:

  • Menyertakan URL dalam respons di permintaan BaaS API.
  • Menambahkan link di template email saat mereset sandi, atau mengirim notifikasi lainnya.
  • Mengalihkan pengguna ke halaman Portal tertentu.

Jika Anda menggunakan load balancer di depan node Stack, tetapkan properti berikut di /opt/apigee/customer/application/usergrid.properties: 

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

Ganti http://localhost:8080 dengan URL load balancer. Jika load balancer dikonfigurasi untuk menggunakan TLS, gunakan protokol HTTPS. Anda hanya perlu menyertakan port jika menggunakan port non-standar, yang berarti selain port 80 untuk HTTP dan port 443 untuk HTTPS.

Anda juga harus menetapkan properti berikut di /opt/apigee/customer/application/portal.properties jika Anda menggunakan load balancer di depan node Stack:

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

Ganti http://localhost:8080 dengan URL load balancer untuk Stack.

Jika Anda menggunakan load balancer di depan node Portal, tetapkan properti berikut di usergrid.properties: 

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

Ganti http://localhost:9000 dengan URL load balancer. Jika load balancer dikonfigurasi untuk menggunakan TLS, gunakan protokol HTTPS. Anda hanya perlu menyertakan port jika menggunakan port non-standar, yang berarti selain port 80 untuk HTTP dan port 443 untuk HTTPS.

Setelah mengedit usergrid.properties dan portal.properties:

  1. Konfigurasikan node Stack:
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid configure
  2. Mulai ulang Stack BaaS:
    > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid restart

    Catatan: Saat memulai ulang node BaaS Stack, mulai ulang node tersebut dalam urutan yang sama seperti yang tercantum di BAAS_CLUSTER_SEEDS. BAAS_CLUSTER_SEEDS mencantumkan maksimal dua node Stack. Setelah memulai ulang kedua node tersebut secara berurutan, Anda dapat memulai ulang node yang tersisa dalam urutan apa pun.

  3. Jika Anda mengubah portal.properties, konfigurasikan node Portal:?
    > /opt/apigee/apigee-service/bin/apigee-service baas-portal configure
  4. Mulai ulang Portal BaaS:
    > /opt/apigee/apigee-service/bin/apigee-service baas-portal restart

Melakukan aktivasi organisasi baru

Orientasi adalah proses pembuatan organisasi dan administrator organisasi. Setelah membuat organisasi dan administrator organisasi, Anda dapat login ke UI Portal API BaaS dan membuat permintaan ke API REST API BaaS.

Saat Anda membuat organisasi, alamat email administrator organisasi:

  • Harus berbeda dengan alamat email administrator sistem.
  • Harus unik di antara semua organisasi lain. Artinya, Anda tidak dapat membuat dua organisasi dengan alamat email yang sama untuk administrator organisasi. Namun, setelah membuat organisasi, Anda dapat menambahkan administrator lain yang dapat diduplikasi di beberapa organisasi.

Untuk melakukan orientasi, gunakan skrip Python create_org_and_user.py. Memanggil skrip ini tanpa argumen command line akan menyebabkan skrip meminta semua informasi:

> python create_org_and_user.py

Atau, Anda dapat meneruskan salah satu atau semua opsi sebagai argumen command line. Anda akan diminta untuk memasukkan informasi apa pun yang Anda hapus dari command line:

> 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>'

Untuk membuat organisasi:

  1. Ubah direktori ke /opt/apigee/baas-usergrid/bin.
  2. Panggil skrip Python create_org_and_user.py.
    Anda akan diminta untuk memasukkan nama pengguna dan sandi administrator sistem BaaS sehingga hanya admin sistem yang dapat menjalankannya.
  3. Login ke Portal BaaS API di browser web menggunakan URL yang Anda catat di akhir penginstalan URL Portal BaaS API. Untuk mengakses portal, masukkan URL Portal BaaS API dalam bentuk:
    http://{portalExternalIP}:9000/

    Catatan: IP adalah alamat IP eksternal/nama host mesin Portal. Pastikan port tersebut terbuka.
  4. Saat layar login portal muncul, Anda dapat:
    • Login menggunakan nama pengguna dan sandi administrator organisasi.
    • Login menggunakan nama pengguna dan sandi administrator sistem.

Mengakses API BaaS REST API

Untuk mengakses API BaaS REST API, gunakan URL dalam bentuk:

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

Di lingkungan pengembangan, Anda dapat menginstal semua komponen BaaS API di satu node, yang berarti Anda memiliki satu Stack BaaS API. Atau, Anda mungkin memiliki lingkungan kecil dengan satu node API BaaS Stack dan tidak memiliki load balancer. Dalam jenis lingkungan ini, Anda dapat melakukan panggilan API langsung ke node API BaaS Stack:

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

Untuk informasi selengkapnya tentang cara memulai Portal BaaS API, lihat dokumentasi Apigee di: http://apigee.com/docs/content/build-apps-home.