Penginstalan portal Layanan Developer

Edge for Private Cloud v4.18.01

Sebelum menginstal, pastikan:

• Anda menginstal Postgres sebelum menginstal portal. Anda dapat menginstal Postgres sebagai bagian dari penginstalan Edge, atau menginstal Postgres mandiri untuk digunakan oleh portal.
  • Jika Anda menginstal Postgres mandiri, Postgres dapat berada di node yang sama dengan portal.
  • Jika Anda terhubung ke Postgres yang diinstal sebagai bagian dari Edge, dan Postgres dikonfigurasi dalam mode master/standby, tentukan alamat IP server Postgres master.
• Anda melakukan penginstalan pada versi 64-bit dari versi Red Hat Enterprise Linux, CentOS, atau Oracle yang didukung. Lihat daftar versi yang didukung di Software yang didukung dan versi yang didukung.
• Yum sudah diinstal.

Penginstal hanya menyertakan modul kontribusi Drupal yang diperlukan oleh portal Layanan Developer Apigee (atau cukup, portal). Untuk mengetahui informasi tentang cara menginstal modul kontribusi lainnya, lihat Memperluas Drupal 7.

Ringkasan penginstalan

Setelah Anda menginstal utilitas apigee-setup Edge di node, gunakan utilitas tersebut untuk menginstal portal di node. Utilitas apigee-setup memiliki format:

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 di command line.

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

Misalnya, gunakan perintah berikut untuk menginstal portal:

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

Lihat Menginstal utilitas apigee-setup Edge untuk mengetahui informasi selengkapnya.

Penghentian penggunaan properti SMTPSSL

Dalam rilis sebelumnya, Anda menggunakan properti SMTPSSL untuk menetapkan protokol yang digunakan oleh server SMTP yang terhubung ke portal. Properti tersebut sudah tidak digunakan lagi.

Sekarang Anda menggunakan properti SMTP_PROTOCOL, bukan properti SMTPSSL, untuk menetapkan protokol yang digunakan oleh server SMTP yang terhubung ke portal. Nilai yang valid adalah: "standard", "ssl", atau "tls".

Membuat file konfigurasi

Berikut adalah contoh file konfigurasi otomatis untuk penginstalan portal. Edit file ini sesuai kebutuhan untuk konfigurasi Anda. Gunakan opsi -f ke setup.sh untuk menyertakan file ini.

IP1=IPorDNSnameOfNode

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

# Specify the name of the portal database in Postgres.
PG_NAME=devportal 

# Specify the Postgres admin credentials.
# The portal connects to Postgres by using the 'apigee' user.
# If you changed the Postgres password from the default of 'postgres'
# then set PG_PWD accordingly.
# If connecting to a Postgres node installed with Edge,
# contact the Edge sys admin to get these credentials.
PG_USER=apigee
PG_PWD=postgres

# The IP address of the Postgres server.
# If it is installed on the same node as the portal, specify that IP.
# If connecting to a remote Postgres server,specify its IP address.
PG_HOST=$IP1

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# Optionally configure the SMTP server used by the portal. 
# If you do, the properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the 
# SMTPSSL property. That property has been deprecated. 
SMTP_PROTOCOL="standard" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

1. Menguji koneksi Anda ke Apigee Edge

Uji koneksi Anda ke server pengelolaan Edge dengan menjalankan perintah cURL berikut dari command prompt di server portal:

curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

atau:

curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/v1/organizations/{ORGNAME}

Dengan EMAIL dan PASSWORD adalah alamat email dan sandi administrator untuk ORGNAME.

Pastikan untuk menentukan nama host dan nomor port khusus untuk penginstalan Edge Anda. Port 8080 adalah port default yang digunakan oleh Edge. Jika Anda terhubung ke organisasi di cloud, URL permintaannya adalah: https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

Jika berhasil, perintah ini akan menampilkan respons yang mirip dengan berikut ini:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. Menghapus PHP versi sebelum 7.0

Skrip penginstalan memeriksa PHP versi sebelum 7.0 di sistem sebelum memulai penginstalan. Jika ada PHP versi sebelum 7.0, pesan peringatan berikut akan ditampilkan:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

Hapus paket PHP menggunakan perintah berikut:

yum remove package-name

3. Menginstal Postgres

Portal mengharuskan Postgres diinstal sebelum Anda dapat menginstal portal. Anda dapat menginstal Postgres sebagai bagian dari penginstalan Edge, atau menginstal Postgres mandiri untuk digunakan oleh portal.

• Jika Anda terhubung ke Postgres yang diinstal sebagai bagian dari Edge, dan Postgres dikonfigurasi dalam mode master/standby, tentukan alamat IP server Postgres master.
• Jika Anda menginstal Postgres mandiri, Postgres dapat berada di node yang sama dengan portal.

Untuk mengetahui informasi tentang cara menginstal Postgres sebagai bagian dari penginstalan Edge, lihat Menginstal komponen Edge pada node.

Untuk menginstal Postgres mandiri:

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. Buat file konfigurasi untuk Postgres, seperti yang ditunjukkan di bawah:

   # Must resolve to IP address or DNS
       name of host - not to 127.0.0.1 or localhost.
       HOSTIP=$(hostname -i)
   
       # The pod and region of Postgres. Use the default values shown below.
       MP_POD=gateway
       REGION=dc-1
   
       # Set the Postgres password. The default value is 'postgres'.
       PG_PWD=postgres

3. Di command prompt, jalankan skrip penyiapan untuk menginstal Postgres:

   /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

   Opsi -p pdb menentukan untuk menginstal Postgre. File konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".

4. Menginstal portal

Untuk menginstal portal:

1. Instal utilitas apigee-setup Edge di node menggunakan prosedur internet atau non-internet. Lihat Menginstal utilitas apigee-setup Edge untuk mengetahui informasi selengkapnya.
2. Pastikan Anda telah menginstal Postgres, baik Postgres mandiri maupun sebagai bagian dari penginstalan Edge.
3. Di command prompt, jalankan skrip penyiapan:

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   Opsi -p dp menentukan untuk menginstal portal.

   File konfigurasi harus dapat diakses atau dibaca oleh pengguna "apigee".

4. Buka halaman beranda portal di http://localhost:8079 atau ke nama DNS portal Anda.
5. Login ke portal menggunakan kredensial administrator yang Anda tetapkan di file konfigurasi untuk memastikan portal berjalan dengan benar.
6. Pilih Reports > Status Report di menu Drupal untuk memastikan bahwa Anda dapat melihat status portal saat ini.

5. Pastikan modul Update manager diaktifkan

Untuk menerima notifikasi update Drupal, pastikan modul Drupal Update manager diaktifkan. Dari menu Drupal, pilih Modules dan scroll ke bawah ke modul Update manager. Jika belum diaktifkan, aktifkan.

Setelah diaktifkan, Anda dapat melihat update yang tersedia menggunakan item menu Reports > Available Updates. Anda juga dapat menggunakan perintah Drush berikut:

drush pm-info update

Anda harus menjalankan perintah ini dari direktori root situs. Secara default, Portal Developer diinstal di /opt/apigee/apigee-drupal/wwwroot. Oleh karena itu, Anda harus mengubah direktori ke /opt/apigee/apigee-drupal/wwwroot terlebih dahulu sebelum menjalankan perintah. Jika Anda tidak menginstal portal di direktori default, ubah ke direktori penginstalan Anda.

Gunakan item menu Reports > Available Updates > Settings untuk mengonfigurasi modul agar mengirim email kepada Anda saat update tersedia dan untuk menetapkan frekuensi pemeriksaan update.

6. Mengonfigurasi mesin telusur Apache Solr (Opsional)

Secara default, modul Drupal yang terhubung ke mesin telusur Apache Solr dinonaktifkan saat Anda menginstal portal. Sebagian besar portal menggunakan mesin telusur Drupal internal, sehingga tidak memerlukan modul Solr Drupal.

Jika Anda memutuskan untuk menggunakan Solr sebagai mesin telusur, Anda harus menginstal Solr secara lokal di server Anda, lalu mengaktifkan dan mengonfigurasi modul Drupal Solr di portal.

Untuk mengaktifkan modul Drupal Solr:

1. Login ke portal Anda sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
2. Pilih Modules di menu Drupal.
3. Aktifkan modul Apache Solr Framework dan modul Apache Solr Search.
4. Simpan perubahan.
5. Konfigurasikan Solr seperti yang dijelaskan di https://drupal.org/node/1999280.

7. Menginstal SmartDocs (Opsional)

SmartDocs memungkinkan Anda mendokumentasikan API di portal Layanan Developer dengan cara yang membuat dokumentasi API sepenuhnya interaktif. Namun, untuk menggunakan SmartDocs dengan portal, Anda harus menginstal SmartDocs di Edge terlebih dahulu.

• Jika Anda menghubungkan portal ke penginstalan Edge Cloud, SmartDocs sudah diinstal dan tidak diperlukan konfigurasi lebih lanjut.
• Jika Anda menghubungkan portal ke penginstalan Edge for Private Cloud, Anda harus memastikan bahwa SmartDocs diinstal di Edge. Untuk mengetahui informasi selengkapnya tentang cara menginstal Edge dan SmartDocs, lihat Menginstal SmartDocs.

Anda juga harus mengaktifkan SmartDocs di portal. Untuk mengetahui informasi selengkapnya tentang SmartDocs, lihat Menggunakan SmartDocs untuk mendokumentasikan API.

8. Mengonfigurasi modul JQuery Update untuk penginstalan non-internet (Opsional)

Jika Anda menginstal dan menggunakan modul JQuery Update dalam penginstalan non-internet, Anda harus mengonfigurasi modul untuk menggunakan JQuery versi lokal. Jika Anda mengonfigurasi modul untuk menggunakan CDN untuk penginstalan non-internet, modul akan mencoba mengakses CDN dan menyebabkan penundaan pemuatan halaman. Untuk mengetahui informasi selengkapnya tentang modul JQuery Update, lihat https://www.drupal.org/project/jquery_update.

Untuk mengonfigurasi modul JQuery Update agar menggunakan JQuery versi lokal:

1. Login ke portal Anda sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
2. Pilih Configuration > Development > JQuery Update di menu Drupal.
3. Klik Performa di navigasi kiri.
4. Di drop-down JQuery and JQuery UI CDN, pilih None.
5. Klik Simpan konfigurasi.

9. Apa langkah berikutnya?

Langkah berikutnya setelah menginstal portal Layanan Developer adalah mengonfigurasi dan menyesuaikannya untuk kebutuhan spesifik Anda. Dokumentasi di situs Apigee berisi semua informasi tentang cara mengonfigurasi, menata gaya, dan mengelola portal. Akses dokumentasi di http://apigee.com/docs/developer-services/content/what-developer-portal.

Tabel berikut mencantumkan beberapa tugas paling umum yang Anda lakukan setelah penginstalan, dan menyertakan link ke dokumentasi Apigee tempat Anda dapat menemukan informasi selengkapnya: