Persyaratan Penginstalan

Edge for Private Cloud v. 4.16.05

Persyaratan Hardware

Anda harus memenuhi persyaratan hardware minimum berikut untuk infrastruktur dengan ketersediaan tinggi di lingkungan tingkat produksi. Untuk semua skenario penginstalan yang dijelaskan dalam Topologi Penginstalan, tabel berikut mencantumkan persyaratan hardware minimum untuk komponen penginstalan.

Dalam tabel ini, persyaratan hard disk adalah tambahan dari ruang hard disk yang diperlukan oleh sistem operasi. Bergantung pada aplikasi dan traffic jaringan, penginstalan Anda mungkin memerlukan lebih banyak atau lebih sedikit resource daripada yang tercantum di bawah.

Selain itu, berikut adalah persyaratan hardware jika Anda ingin menginstal Layanan Monetisasi:

Berikut ini daftar persyaratan hardware jika Anda ingin menginstal API BaaS:

Catatan:

• Jika sistem file root tidak cukup besar untuk penginstalan, sebaiknya tempatkan data ke disk yang lebih besar.
• Jika Apigee Edge untuk Private Cloud versi lama diinstal di komputer, pastikan Anda menghapus folder /tmp/java sebelum penginstalan baru.
• Folder sementara seluruh sistem /tmp memerlukan izin eksekusi untuk memulai Cassandra.
• Jika pengguna “apigee” dibuat sebelum penginstalan, pastikan “/home/apigee” ada sebagai direktori utama dan dimiliki oleh “apigee:apigee”.

Persyaratan sistem operasi dan software pihak ketiga

Petunjuk penginstalan ini dan file penginstalan yang disediakan telah diuji pada sistem operasi dan software pihak ketiga yang tercantum di sini: https://apigee.com/docs/api-services/reference/supported-software.

Membuat pengguna apigee

Prosedur penginstalan membuat pengguna sistem Unix bernama 'apigee'. Direktori dan file Edge dimiliki oleh 'apigee', seperti halnya proses Edge. Artinya, komponen Edge dijalankan sebagai pengguna 'apigee'. Jika perlu, Anda dapat menjalankan komponen sebagai pengguna yang berbeda. Lihat "Mengikat Router ke port yang dilindungi" di Menginstal komponen Edge di node untuk mengetahui contohnya.

Direktori penginstalan

Secara default, penginstal menulis semua file ke direktori /opt/apigee. Anda tidak dapat mengubah lokasi direktori ini.

Dalam petunjuk dalam panduan ini, direktori penginstalan dicatat sebagai /<inst_root>/apigee, dengan /<inst_root> adalah /opt secara default.

Java

Anda memerlukan Java1.8 versi yang didukung yang diinstal di setiap komputer sebelum penginstalan. JDK yang didukung tercantum di sini:

https://apigee.com/docs/api-services/reference/supported-software

Pastikan JAVA_HOME mengarah ke root JDK untuk pengguna yang melakukan penginstalan.

Setelan Jaringan

Sebaiknya periksa setelan jaringan sebelum penginstalan. Penginstal mengharapkan semua mesin memiliki alamat IP tetap. Gunakan perintah berikut untuk memvalidasi setelan:

• nama host menampilkan nama perangkat
• hostname -i menampilkan alamat IP untuk nama host yang dapat diberi alamat dari komputer lain.

Bergantung pada jenis dan versi sistem operasi, Anda mungkin harus mengedit /etc/hosts dan /etc/sysconfig/network jika nama host tidak ditetapkan dengan benar. Lihat dokumentasi untuk sistem operasi tertentu Anda guna mendapatkan informasi selengkapnya.

Cassandra

Semua node Cassandra harus terhubung ke sebuah cincin.

Cassandra secara otomatis menyesuaikan ukuran heap Java-nya berdasarkan memori yang tersedia. Untuk mengetahui informasi selengkapnya, lihat Menyesuaikan resource Java. Jika terjadi penurunan performa atau konsumsi memori yang tinggi.

Setelah menginstal Edge for Private Cloud, Anda dapat memeriksa apakah Cassandra dikonfigurasi dengan benar dengan memeriksa file /<inst_root>/apigee/apigee-cassandra/conf/cassandra.yaml. Misalnya, pastikan skrip penginstalan Edge for Private Cloud menetapkan properti berikut:

• cluster_name
• initial_token
• partisioner
• benih
• listen_address
• rpc_address
• snitch

Peringatan: Jangan edit file ini.

Database PostgreSQL

Setelah menginstal Edge, Anda dapat menyesuaikan setelan database PostgreSQL berikut berdasarkan jumlah RAM yang tersedia di sistem Anda:

conf_postgresql_shared_buffers = 35% of RAM      # min 128kB
conf_postgresql_effective_cache_size = 45% of RAM
conf_postgresql_work_mem = 512MB       # min 64kB

Untuk menetapkan nilai ini:

1. Edit postgresql.properties:
   > vi /<inst_root>/apigee/customer/application/postgresql.properties
   
   Jika file tidak ada, buat file tersebut.
2. Tetapkan properti yang tercantum di atas.
3. Simpan hasil editan Anda.
4. Mulai ulang database PostgreSQL:
   > /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-postgresql restart

jsvc

"jsvc" adalah prasyarat untuk menggunakan API BaaS. Versi 1.0.15-dev diinstal saat Anda menginstal BaaS API.

Layanan Keamanan Jaringan (NSS)

Network Security Services (NSS) adalah kumpulan library yang mendukung pengembangan aplikasi klien dan server yang mengaktifkan keamanan. Anda harus memastikan bahwa Anda telah menginstal NSS v3.19, atau yang lebih baru.

Untuk memeriksa versi saat ini:

> yum info nss

Untuk mengupdate NSS:

> yum update nss

Lihat artikel ini dari RedHat untuk mengetahui informasi selengkapnya.

AMI AWS

Jika menginstal Edge di Amazon Machine Image (AMI) AWS untuk Red Hat Enterprise Linux 7.x, Anda harus menjalankan perintah berikut terlebih dahulu:

> yum-config-manager --enable rhui-REGION-rhel-server-extras rhui-REGION-rhel-server-optional

Alat

Penginstal menggunakan alat UNIX berikut dalam versi standar seperti yang disediakan oleh EL5 atau EL6.

Catatan:

• File yang dapat dieksekusi untuk alat 'useradd' terletak di /usr/sbin dan untuk chkconfig di /sbin.
• Dengan akses sudo, Anda dapat memperoleh akses ke lingkungan pengguna yang memanggil, misalnya, biasanya Anda akan memanggil “sudo <command>” atau “sudo PATH=$PATH:/usr/sbin:/sbin <command>”.
• Pastikan Anda telah menginstal alat “patch” sebelum penginstalan paket layanan (patch).

ntpdate – Sebaiknya sinkronkan waktu server. Jika belum dikonfigurasi, utilitas 'ntpdate' dapat memenuhi tujuan ini, yang memverifikasi apakah server telah disinkronkan waktu. Anda dapat menggunakan “yum install ntp” untuk menginstal utilitas. Hal ini sangat berguna untuk mereplikasi pengaturan OpenLDAP. Perhatikan bahwa Anda menyiapkan zona waktu server dalam UTC.

openldap 2.4 – Penginstalan on-premise memerlukan OpenLDAP 2.4. Jika server Anda memiliki koneksi Internet, skrip penginstalan Edge akan mendownload dan menginstal OpenLDAP. Jika server tidak memiliki koneksi Internet, Anda harus memastikan bahwa OpenLDAP sudah diinstal sebelum menjalankan skrip penginstalan Edge. Di RHEL/CentOS, Anda dapat menjalankan "yum install openldap-clients openldap-servers" untuk menginstal OpenLDAP.

Untuk penginstalan 13 host, dan penginstalan 12 host dengan dua Data Center, Anda memerlukan replikasi OpenLDAP karena ada beberapa node yang menghosting OpenLDAP.

{i>Firewall<i} dan {i>Host Virtual<i}

Istilah “virtual” biasanya disalahgunakan di dunia IT, begitu juga dengan deployment Apigee Edge untuk Private Cloud dan host virtual. Untuk memperjelas, ada dua penggunaan utama istilah “virtual”:

• Virtual machine (VM): Tidak diperlukan, tetapi beberapa deployment menggunakan teknologi VM untuk membuat server terisolasi bagi komponen Apigee mereka. Host VM, seperti host fisik, dapat memiliki antarmuka jaringan dan firewall. Petunjuk penginstalan ini tidak secara khusus mendukung penginstalan VM.
• Host virtual: Endpoint web, yang analog dengan host virtual Apache.

Router di VM dapat mengekspos beberapa host virtual (asalkan berbeda satu sama lain dalam alias host atau port antarmuka).

Sama seperti contoh penamaan, satu server fisik “A” mungkin menjalankan dua VM, bernama “VM1” dan “VM2”. Mari kita asumsikan VM1 mengekspos antarmuka Ethernet virtual, yang diberi nama eth0 di dalam VM, dan diberi alamat IP 111.111.111.111 oleh mesin virtualisasi atau server DHCP jaringan; lalu asumsikan VM2 mengekspos antarmuka Ethernet virtual yang juga bernama eth0 dan diberi alamat IP 111.111.111.222.

Kita mungkin memiliki router Apigee yang berjalan di setiap dua VM. Router mengekspos endpoint host virtual seperti dalam contoh hipotetis ini:

Router Apigee di VM1 mengekspos tiga host virtual di antarmuka eth0-nya (yang memiliki beberapa alamat IP tertentu), api.mycompany.com:80, api.mycompany.com:443, dan test.mycompany.com:80.

Router di VM2 mengekspos api.mycompany.com:80 (nama dan port yang sama seperti yang diekspos oleh VM1).

Sistem operasi host fisik mungkin memiliki firewall jaringan; jika demikian, firewall tersebut harus dikonfigurasi untuk meneruskan traffic TCP yang terikat untuk port yang ditampilkan di antarmuka virtual (111.111.111.111:{80, 443} dan 111.111.111.222:80). Selain itu, setiap sistem operasi VM dapat menyediakan firewall-nya sendiri di antarmuka eth0 dan firewall ini juga harus mengizinkan traffic port 80 dan 443 untuk terhubung.

Jalur dasar adalah komponen ketiga yang terlibat dalam merutekan panggilan API ke berbagai proxy API yang mungkin telah Anda deploy. Paket proxy API dapat berbagi endpoint jika memiliki jalur dasar yang berbeda. Misalnya, satu jalur dasar dapat ditentukan sebagai http://api.perusahaansaya.com:80/ dan yang lain ditentukan sebagai http://api.perusahaansaya.com:80/salesdemo.

Dalam hal ini, Anda memerlukan load balancer atau traffic director yang memisahkan traffic http://api.mycompany.com:80/ antara dua alamat IP (111.111.111.111 di VM1 dan 111.111.111.222 di VM2). Fungsi ini khusus untuk penginstalan tertentu, dan dikonfigurasi oleh grup jaringan lokal Anda.

Jalur dasar ditetapkan saat Anda men-deploy API. Dari contoh di atas, Anda dapat men-deploy dua API, perusahaansaya dan testperusahaansaya, untuk organisasi perusahaansaya-org dengan host virtual yang memiliki alias host api.perusahaansaya.com dan port yang ditetapkan ke 80. Jika Anda tidak mendeklarasikan jalur dasar dalam deployment, router tidak akan mengetahui API mana yang akan menerima permintaan masuk.

Namun, jika Anda men-deploy API testmycompany dengan URL dasar /salesdemo, pengguna akan mengakses API tersebut menggunakan http://api.mycompany.com:80/salesdemo. Jika Anda men-deploy API mycompany dengan URL dasar /, pengguna akan mengakses API melalui URL http://api.mycompany.com:80/.

Persyaratan port Edge

Kebutuhan untuk mengelola firewall tidak hanya terbatas pada host virtual; firewall VM dan host fisik harus mengizinkan traffic untuk port yang diperlukan oleh komponen untuk berkomunikasi satu sama lain.

Gambar berikut menunjukkan persyaratan port untuk setiap komponen Edge:

Catatan tentang diagram ini:

• *Port 8082 di Message Processor hanya harus terbuka untuk diakses oleh Router saat Anda mengonfigurasi TLS/SSL antara Router dan Message Processor. Jika Anda tidak mengonfigurasi TLS/SSL antara Router dan Pemroses Pesan, konfigurasi default, port 8082 tetap harus terbuka di Pemroses Pesan untuk mengelola komponen, tetapi Router tidak memerlukan akses ke Pemroses Pesan tersebut.
• Port yang diawali dengan "M" adalah port yang digunakan untuk mengelola komponen dan harus terbuka di komponen untuk diakses oleh Server Pengelolaan.
• Komponen berikut memerlukan akses ke port 8080 di Server Pengelolaan: Router, Message Processor, UI, Postgres, dan Qpid.
• Pemroses Pesan harus membuka port 4528 sebagai port pengelolaannya. Jika Anda memiliki beberapa Message Processor, semua Message Processor tersebut harus dapat saling mengakses melalui port 4528 (ditunjukkan dengan panah loop dalam diagram di atas untuk port 4528 di Message Processor). Jika Anda memiliki beberapa Pusat Data, port harus dapat diakses dari semua Pemroses Pesan di semua Pusat Data.
• Meskipun tidak diperlukan, Anda dapat membuka port 4527 di Router untuk diakses oleh Message Processor mana pun. Jika tidak, Anda mungkin melihat pesan error dalam file log Message Processor.
• Router harus membuka port 4527 sebagai port pengelolaannya. Jika Anda memiliki beberapa Router, semua Router tersebut harus dapat saling mengakses melalui port 4527 (ditunjukkan dengan panah loop dalam diagram di atas untuk port 4527 di Router).
• UI Edge memerlukan akses ke Router, pada port yang diekspos oleh proxy API, untuk mendukung tombol Kirim di alat rekaman aktivitas.
• Server Pengelolaan memerlukan akses ke port JMX di node Cassandra.
• Akses ke port JMX dapat dikonfigurasi agar mewajibkan nama pengguna/sandi. Lihat Cara Memantau untuk mengetahui informasi selengkapnya.
• Anda dapat mengonfigurasi akses TLS/SSL secara opsional untuk koneksi tertentu, yang dapat menggunakan port yang berbeda. Lihat TLS/SSL untuk mengetahui informasi selengkapnya.
• Jika mengonfigurasi dua node Postgres agar menggunakan replikasi master-standby, Anda harus membuka port 22 pada setiap node untuk akses SSH. Anda memiliki opsi untuk membuka port pada setiap node untuk mengizinkan akses SSH.
• Anda dapat mengonfigurasi Server Pengelolaan dan UI Edge untuk mengirim email melalui server SMTP eksternal. Jika ya, Anda harus memastikan bahwa Server Pengelolaan dan UI dapat mengakses port yang diperlukan di server SMTP. Untuk SMTP non-TLS, nomor port biasanya 25. Untuk SMTP yang mendukung TLS, biasanya yang dipilih adalah 465, tetapi hubungi penyedia SMTP Anda.

Tabel di bawah menunjukkan port yang perlu dibuka di firewall, oleh komponen Edge:

> curl -v http://<routerIP>:15999/v1/servers/self/reachable

Tabel berikutnya menampilkan port yang sama, yang tercantum secara numerik, dengan komponen sumber dan tujuan:

Pemroses pesan membuat kumpulan koneksi khusus tetap terbuka untuk Cassandra, yang dikonfigurasi ke tidak pernah waktu tunggu. Saat firewall berada di antara pemroses pesan dan server Cassandra, firewall dapat kehabisan waktu koneksi. Namun, pemroses pesan tidak dirancang untuk membuat ulang koneksi ke Cassandra.

Untuk mencegah situasi ini, Apigee merekomendasikan agar server Cassandra, pemroses pesan, dan router berada di subnet yang sama sehingga firewall tidak terlibat dalam deployment komponen ini.

Jika firewall berada di antara router dan pemroses pesan, serta memiliki waktu tunggu TCP nonaktif yang disetel, rekomendasi kami adalah:

1. Tetapkan net.ipv4.tcp_keepalive_time = 1800 di setelan sysctl pada OS Linux, dengan 1800 harus lebih rendah dari waktu tunggu TCP idle firewall. Setelan ini akan mempertahankan koneksi dalam status yang ditetapkan sehingga firewall tidak memutuskan koneksi.
2. Di semua Message Processor, edit /<inst_root>/apigee/customer/application/message-processor.properties untuk menambahkan properti berikut. Jika file tidak ada, buat file tersebut.
   conf_system_casssandra.maxconnecttimeinmillis=-1
3. Mulai ulang Message Processor:
   > /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
4. Di semua Router, edit /<inst_root>/apigee/customer/application/router.properties untuk menambahkan properti berikut. Jika file tidak ada, buat file tersebut.
   conf_system_casssandra.maxconnecttimeinmillis=-1
5. Mulai ulang Router:
   > /opt/apigee/apigee-service/bin/apigee-service edge-router restart

Jika Anda menginstal konfigurasi cluster 12 host dengan dua Data Center, pastikan node di kedua Data Center dapat berkomunikasi melalui port yang ditampilkan di bawah:

Persyaratan port BaaS API

Jika memilih untuk menginstal API BaaS, Anda harus menambahkan komponen API BaaS Stack dan API BaaS Portal. Komponen ini menggunakan port yang ditampilkan pada gambar di bawah:

Catatan tentang diagram ini:

• Node Cassandra dapat didedikasikan untuk API BaaS, atau dapat dibagikan dengan Edge.
• Penginstalan produksi API BaaS menggunakan load balancer antara node Portal API BaaS dan node Stack API BaaS. Saat mengonfigurasi Portal, dan saat melakukan panggilan BaaS API, Anda menentukan alamat IP atau nama DNS load balancer, bukan node Stack.
• Anda harus mengonfigurasi semua node Baas Stack untuk mengirim email melalui server SMTP eksternal. Untuk SMTP non-TLS, nomor port biasanya 25. Untuk SMTP yang mengaktifkan TLS, portnya sering kali 465, tetapi periksa dengan penyedia SMTP Anda.

Tabel di bawah menunjukkan port default yang perlu dibuka di firewall, berdasarkan komponen:

Pemberian Lisensi

Setiap penginstalan Edge memerlukan file lisensi unik yang Anda dapatkan dari Apigee. Anda harus memberikan jalur ke file lisensi saat menginstal server pengelolaan, misalnya /tmp/license.txt.

Penginstal menyalin file lisensi ke /<inst_root>/apigee/customer/conf/license.txt.

Jika file lisensi valid, server pengelolaan akan memvalidasi masa berlaku dan jumlah Message Processor (MP) yang diizinkan. Jika salah satu setelan lisensi telah berakhir masa berlakunya, Anda dapat menemukan log di lokasi berikut: /<inst_root>/apigee/var/log/edge-management-server/logs. Dalam hal ini, Anda dapat menghubungi Dukungan Apigee untuk mengetahui detail migrasi.