Penginstalan BaaS API

Edge untuk Private Cloud v. 4.16.09

Menggunakan Load Balancer

Penginstalan produksi API BaaS menggunakan load balancer antara node Portal BaaS API dan node BaaS Stack API. Saat mengonfigurasi Portal, tentukan alamat IP atau nama DNS load balancer, bukan node Stack.

Sebagai alternatif load balancer, Anda dapat menggunakan DNS round-robin. Dalam skenario ini, Anda membuat entri DNS dengan beberapa data A yang sesuai dengan alamat IP stack BaaS. Selama pencarian DNS, server DNS otomatis menampilkan nilai data A dengan metode round robin.

Menghubungkan ke Cassandra

Saat menginstal BaaS, Anda dapat memilih untuk menghubungkan BaaS dan Edge ke cluster Cassandra yang sama, atau membuat cluster Cassandra terpisah untuk BaaS. Instalasi BaaS yang lebih kecil, berarti penginstalan dengan volume traffic lebih rendah, sering kali berbagi cluster Cassandra dengan Edge.

Untuk throughput dan ketersediaan tinggi, atau untuk memisahkan cluster Cassandra ke dalam zona jaringan yang berbeda, Apigee merekomendasikan agar Anda menggunakan cluster Cassandra yang terpisah. Cluster terpisah akan memaksimalkan performa jika Anda mengalami beban traffic yang tinggi di BaaS.

Sinkronisasi tanggal

Anda harus menyinkronkan tanggal/waktu di semua server. Jika belum dikonfigurasi, utilitas 'ntpdate' dapat membantu tujuan ini, yang memverifikasi apakah server disinkronkan dengan waktu. Anda dapat menggunakan “yum install ntp” untuk menginstal utilitas.

Keamanan Tomcat

Installer API BaaS juga menginstal server Apache Tomcat pada semua node BaaS Stack API, termasuk UI administrator Tomcat. Penginstal tidak mengubah kredensial administrator default dari admin:admin.

Jika perlu, Anda dapat mengubah kredensial ini sebagai bagian dari mengamankan Tomcat. Untuk informasi selengkapnya, lihat:

Ringkasan penginstalan

Setelah Anda menginstal utilitas apigee-setup pada Edge pada sebuah node, gunakan utilitas tersebut untuk menginstal satu atau beberapa komponen BaaS pada node tersebut. 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 untuk memasukkannya pada command line.

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

Misalnya, gunakan perintah berikut untuk menginstal API BaaS Stack:

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

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

Opsi

Deskripsi

e

Instal ElasticSearch saja.

b

Instal API BaaS Stack saja, yang juga menginstal Tomcat.

p

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

c

Instal Cassandra saja.

eb

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

penurunan

Instal ElasticSearch, API BaaS Portal, API BaaS Stack, dan Tomcat. Portal ini sangat ringan dan tidak memerlukan sumber daya tambahan untuk ini.

Asa

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

Membuat file konfigurasi senyap

Berikut adalah contoh file konfigurasi senyap untuk penginstalan BaaS API 10 node. Edit file ini seperlunya untuk konfigurasi Anda. Gunakan opsi -f untuk setup.sh guna menyertakan file ini.

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

# Only if you are installing Cassandra.
# Specify Cassandra configuration information.
# 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"

# 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.

# 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

# 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

Tabel berikut berisi informasi tambahan tentang properti ini:

Properti

Catatan

CASS_HOSTS

Jika Anda menginstal Cassandra, tentukan IP node Cassandra (bukan nama DNS) dan sertakan pengubah “:dc,ra” yang menentukan pusat data dan rak node Cassandra.

Misalnya '192.168.124.201:1,1 = pusat data 1 dan zona rak/ketersediaan 1, dan '192.168.124.204:2,1 = pusat data 2 dan zona rak/ketersediaan 1.

CASS_USERNAME
CASS_KATA SANDI

Nama pengguna dan sandi Cassandra.

Jika autentikasi Cassandra dinonaktifkan, Anda tetap harus meneruskan nilai ini. Namun, nilai tersebut akan diabaikan.

BAAS_CASS_LOCALDC

Nama wilayah harus dalam bentuk dc-#, dengan # terkait dengan nilai bilangan bulat.

Misalnya, dc-1, dc-2, dll. Jika terhubung ke cluster Cassandra yang diinstal dengan Edge, Anda dapat meminta nilai ini kepada administrator sistem Edge. Pada penginstalan pusat data tunggal Edge, nilai defaultnya adalah dc-1.

Jika Anda menginstal Cassandra sebagai bagian dari penginstalan API BaaS, selama penginstalan Cassandra Anda menambahkan pengubah “:dc,ra” ke alamat IP Cassandra. Nilai pertama "dc" adalah nomor pusat data. Nama pusat data adalah string "dc-" dengan nomor pusat data sebagai akhiran.

BAAS_CASS_REPLICATION

Formatnya adalah "dataCenterName:#CassandraNodes". Misalnya, untuk dc-1 dengan tiga node Cassandra, nilainya adalah dc-1:3.

BAAS_USERGRID_URL

Di lingkungan produksi, ini adalah URL dan port load balancer yang ada di depan node Stack BaaS API, dalam bentuk:

http://myStackLoadBalancer:8443

Dalam lingkungan pengujian atau pengembangan, ketika Anda hanya memiliki satu node BaaS Stack API, node ini dapat berupa URL dan nomor port node BaaS Stack API, dalam bentuk:

http://stackIPorDNS:8080

Nomor port untuk server BaaS Stack API adalah 8080.

BAAS_PORTAL_URL

URL dan nomor port load balancer, jika ada, ada di depan Portal, dalam bentuk:

http://myPortalLoadBalancer:8443

Jika tidak ada load balancer, URL dan nomor port node Portal akan, dalam bentuk:

http://portalIPorDNS:9000

Secara default, nomor port untuk Ba90 API0

BAAS_PORTAL_LISTEN_PORT

Nomor port untuk server Portal BaaS API adalah 9000. Jika port ini tidak tersedia, tentukan port lain.

Jika Anda menyetel BAAS_PORTAL_URL ke URL node Portal, nomor port harus sama untuk kedua properti.

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

Meskipun Anda dapat menghubungkan API BaaS ke cluster Cassandra yang sama seperti yang digunakan oleh Edge, Apigee merekomendasikan agar Anda menggunakan cluster terpisah.

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

  1. Instal utilitas apigee-setup Edge pada node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas apigee-setup Edge untuk mengetahui informasi selengkapnya.
  2. Pada 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 pada node.

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

Menyiapkan cron job Cassandra

Siapkan cron job yang menggunakan nodetool untuk mengosongkan kunci agar berjalan setiap jam pada setiap node Cassandra.

Jika Anda memiliki beberapa node Cassandra, offset cron job di setiap server selama lima menit agar semua node tidak melakukan flush secara bersamaan.

cron job 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.

Menginstal ElasticSearch: Machine 1, 2, dan 3

Untuk menginstal ElasticSearch:

  1. Instal utilitas penyiapan Edge apigee pada node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas apigee-setup Edge untuk mengetahui informasi selengkapnya.
  2. Pada 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 pada node mandiri, yang berarti bahwa ElasticSearch tidak diinstal dengan API BaaS Stack, maka 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 file tersebut.
    2. Tetapkan properti setenv_elasticsearch_max_mem_size ke 6g (defaultnya 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 pada node.

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

Untuk menginstal API BaaS Stack:

  1. Instal utilitas penyiapan Edge apigee pada node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas apigee-setup Edge untuk mengetahui informasi selengkapnya.
  2. Pada 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 mengambil kredensial admin yang benar, penginstal akan menginstal Tomcat, membuat keyspace BaaS API, dan menyiapkan BaaS Stack API 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 Edge apigee pada node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas apigee-setup Edge untuk mengetahui informasi selengkapnya.
  2. Pada 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".

Penginstal memulai server web Nginx, lalu menyelesaikan konfigurasi Portal BaaS API.

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 Anda 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 dalam 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_swagger.basepath=http://localhost:8080
usergrid-deployment_usergrid.organization.activation.url=http://localhost:8080/management/organizations/%s/activate
usergrid-deployment_usergrid.admin.activation.url=http://localhost:8080/management/users/%s/activate
usergrid-deployment_usergrid.admin.resetpw.url=http://localhost:8080/management/users/%s/resetpw
usergrid-deployment_usergrid.admin.confirmation.url=http://localhost:8080/management/users/%s/confirm
usergrid-deployment_usergrid.user.activation.url=http://localhost:8080/%s/%s/users/%s/activate
usergrid-deployment_usergrid.user.confirmation.url=http://localhost:8080/%s/%s/users/%s/confirm
usergrid-deployment_usergrid.user.resetpw.url=http://localhost:8080/%s/%s/users/%s/resetpw

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, artinya sesuatu 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_usergrid.view.management.organizations.organization.activate=http://localhost:9000
usergrid-deployment_usergrid.view.management.organizations.organization.confirm=http://localhost:9000
usergrid-deployment_usergrid.view.management.users.user.activate=http://localhost:9000
usergrid-deployment_usergrid.view.management.users.user.confirm=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, artinya selain port 80 untuk HTTP dan port 443 untuk HTTPS.

Setelah mengedit usergrid.properties dan portal.properties:

  1. Konfigurasi node Stack:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid Configure
  2. Deploy perubahan ke Tomcat:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid deploy
  3. Mulai ulang BaaS Stack:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid restart
  4. Jika Anda mengubah portal.properties, konfigurasikan node Portal:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-portalconfigure
  5. Deploy perubahan:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-portal deploy
  6. Mulai ulang Portal BaaS:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-portal mulai ulang

Orientasi organisasi baru

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

Saat Anda membuat organisasi, alamat email administrator organisasi tersebut:

  • Harus berbeda dari alamat email administrator sistem.
  • Harus unik di antara organisasi lainnya. 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 menyebabkannya meminta semua informasi Anda:

> 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 dihapus 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 menjadi /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 API BaaS Portal di browser web menggunakan URL yang Anda catat di akhir penginstalan URL Portal BaaS API. Untuk mengakses portal, masukkan URL Portal BaaS API dalam formulir:
    http://{portalExternalIP}:9000/

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

Mengakses API BaaS REST API

Untuk mengakses API BaaS REST API, gunakan URL dengan format:

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

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

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.