Menginstal portal

Sebelum menginstal portal Layanan Developer Apigee (atau cukup, portal), pastikan bahwa:

  1. Anda menginstal Postgres sebelum menginstal portal. Anda dapat menginstal Postgres sebagai bagian dari penginstalan Edge, atau menginstal Postgres secara mandiri untuk digunakan oleh portal.
    • Jika Anda menginstal Postgres secara 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.
  2. Anda menginstal 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.
  3. Yum sudah diinstal.

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

Ringkasan penginstalan

Untuk menginstal portal, lakukan langkah-langkah berikut. Setiap langkah ini dijelaskan secara lebih mendetail di bagian berikut.

  1. Menguji koneksi Anda
  2. Menghapus PHP sebelum versi 7.0
  3. Menginstal Postgres
  4. Menginstal portal
  5. Pastikan Update manager diaktifkan
  6. (Opsional) Mengonfigurasi Apache Solr
  7. (Opsional) Menginstal SmartDocs
  8. (Opsional) Mengonfigurasi JQuery

Penghentian properti SMTPSSL

Pada 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 menyetel protokol yang digunakan oleh server SMTP yang terhubung ke portal. Nilai yang valid adalah: "standard", "ssl", atau "tls".

Membuat file konfigurasi portal

Berikut adalah contoh file konfigurasi senyap untuk penginstalan portal. Edit file ini seperlunya untuk konfigurasi Anda. Gunakan opsi -f untuk setup.sh guna 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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

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

1. Uji koneksi Anda ke Apigee Edge

Uji koneksi Anda antara server tempat Anda akan menginstal portal dan server pengelolaan Edge dengan menjalankan perintah curl berikut 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, curl 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 versi PHP 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

Jika Anda tidak yakin apakah PHP telah diinstal di server Anda, gunakan perintah berikut:

rpm -qa | grep -i php

Perhatikan bahwa portal menggunakan PHP versi 4.18.01-0.0.49. Ini tidak dimaksudkan agar cocok dengan nomor versi Apigee Edge untuk Private Cloud.

3. Menginstal Postgres

Portal ini mengharuskan Postgres diinstal sebelum Anda dapat menginstal portal. Anda dapat menginstal Postgres sebagai bagian dari penginstalan Edge, atau menginstal Postgres secara 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 secara mandiri, postgres dapat berada di node yang sama dengan portal.

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

Untuk menginstal Postgres secara mandiri:

  1. Instal utilitas Edge apigee-setup pada node menggunakan prosedur internet atau selain internet. Lihat Menginstal utilitas apigee-setup Edge untuk mengetahui informasi selengkapnya.
  2. Buat file konfigurasi Postgres, seperti yang ditunjukkan contoh berikut:
    # 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. Pada command prompt, jalankan skrip penyiapan untuk menginstal Postgres:
    /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

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

4. Instal portal

Sebelum dapat menginstal portal, pastikan Anda telah melakukan hal berikut seperti yang dijelaskan dalam 3. Instal Postgres:

  1. Instal utilitas Edge apigee-setup pada node portal
  2. Menginstal Postgres, baik Postgres secara mandiri atau sebagai bagian dari penginstalan Edge

Untuk menginstal portal:

  1. Pada command prompt, jalankan skrip setup:
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Dengan keterangan:

    • configFile adalah file konfigurasi portal seperti yang dijelaskan dalam Membuat file konfigurasi portal.
    • -p dp akan memerintahkan skrip setup untuk menginstal portal.

Untuk memastikan bahwa penginstalan portal berhasil:

  1. Buka halaman beranda portal di http://localhost:8079 atau ke nama DNS portal Anda.
  2. Login ke portal menggunakan kredensial administrator yang Anda tetapkan di file konfigurasi portal.
  3. Pilih Reports > Status Report di menu Drupal untuk memastikan Anda dapat melihat status portal saat ini.
  4. Pastikan koneksi Server Pengelolaan berhasil. Jika bukan:
    1. Buka halaman Konfigurasi Koneksi portal (misalnya, http://portal_IP:8079/admin/config/devconnect).
    2. Klik tombol Uji Koneksi. Jika koneksi berhasil, berarti Anda sudah selesai. Jika koneksi gagal, lanjutkan.
    3. Periksa setelan endpoint dan autentikasi:
      • URL endpoint Management API: Pastikan protokol (HTTP atau HTTPS), nama IP atau DNS, dan nomor port sudah benar; misalnya:
        http://10.10.10.10:8080/v1
      • Pengguna yang diautentikasi endpoint: Nama pengguna admin organisasi.
      • Sandi pengguna yang diautentikasi: Sandi admin organisasi.

      Nilai default mencerminkan setelan dalam file konfigurasi portal yang Anda buat selama proses penginstalan.

      Nilai ini harus cocok dengan nilai ms_IP_or_DNS, email, dan password yang Anda gunakan pada langkah 1: Uji koneksi Anda ke Apigee Edge. Nama pengguna dan sandi juga harus cocok dengan nilai properti USER_NAME dan USER_PWD dalam file konfigurasi aktivasi, atau kredensial pengguna mana pun yang perannya adalah Administrator Organisasi.

    4. Setelah Anda berhasil terhubung ke Server Pengelolaan, klik tombol Save configuration di bagian bawah halaman untuk menyimpan perubahan.

5. Pastikan modul Update manager diaktifkan

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

Setelah diaktifkan, Anda dapat melihat pembaruan yang tersedia menggunakan item menu Laporan > Update yang Tersedia. Anda juga dapat menggunakan perintah Drush berikut:

drush pm-info update

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

Gunakan item menu Laporan > Update yang Tersedia > Setelan untuk mengonfigurasi modul agar dapat mengirimkan email kepada Anda jika update tersedia dan menetapkan frekuensi pemeriksaan update.

6. Konfigurasi mesin telusur Apache Solr (Opsional)

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

Jika 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 tersebut.

Untuk mengaktifkan modul Drupal Solr:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  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. Instal SmartDocs (Opsional)

SmartDocs memungkinkan Anda mendokumentasikan API di portal dengan cara yang membuat dokumentasi API menjadi 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 terinstal dan tidak diperlukan konfigurasi lebih lanjut.
  • Jika menghubungkan portal ke Edge untuk penginstalan 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 Update JQuery untuk penginstalan selain internet (Opsional)

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

Untuk mengonfigurasi modul Pembaruan JQuery agar menggunakan versi lokal JQuery:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Configuration > Development > JQuery Update di menu Drupal.
  3. Klik Performa di navigasi sebelah kiri.
  4. Di drop-down CDN UI JQuery dan JQuery UI, pilih Tidak ada.
  5. Klik Save configuration.

9. Langkah berikutnya

Tabel berikut mencantumkan beberapa tugas paling umum yang Anda lakukan setelah penginstalan, dan menyertakan link ke dokumentasi Apigee yang dapat Anda gunakan untuk menemukan informasi lebih lanjut:

Tugas Deskripsi

Menyesuaikan tema

Tema menentukan tampilan portal, termasuk warna, gaya, dan aspek visual lainnya.

Menyesuaikan tampilan

Halaman beranda mencakup menu utama, pesan selamat datang, header, footer, dan judul.

Menambahkan dan mengelola akun pengguna

Proses pendaftaran mengontrol cara developer baru mendaftarkan akun di portal. Misalnya, apakah developer baru mendapatkan akses langsung ke portal, atau apakah mereka harus diverifikasi oleh administrator. Proses ini juga mengontrol cara administrator portal diberi tahu saat akun baru dibuat.

Mengonfigurasi email

Portal tersebut mengirim email sebagai tanggapan terhadap peristiwa tertentu. Misalnya, saat developer baru mendaftar di portal dan saat developer kehilangan sandi.

Menambahkan dan mengelola akun pengguna

Tambahkan halaman Persyaratan & Ketentuan yang harus disetujui developer sebelum diizinkan untuk mengakses portal.

Menambahkan dan mengelola akun pengguna

Portal ini menerapkan model otorisasi berbasis peran. Sebelum mengizinkan developer untuk mendaftar, tentukan izin dan peran yang digunakan oleh portal.

Menambahkan postingan blog dan forum

Portal ini memiliki dukungan bawaan untuk blog dan forum berangkai. Tentukan izin yang diperlukan untuk melihat, menambahkan, mengedit, dan menghapus postingan blog dan forum.

Pastikan Anda melakukan pencadangan database

Pastikan Anda mencadangkan database Drupal. Perhatikan bahwa karena setiap penginstalan berbeda-beda, Anda bebas menentukan cara terbaik untuk mencadangkan database.

Lihat juga Cara Melakukan Pencadangan.

Menyiapkan nama host

Jika tidak menyiapkan nama host di server DNS, Anda selalu dapat mengakses situs melalui alamat IP server. Jika ingin menggunakan nama host, Anda dapat mengonfigurasi DNS untuk server, yang akan berfungsi dengan benar tanpa konfigurasi lain pada penyiapan dasar.

Jika Anda menyiapkan load balancer atau mendapatkan URL yang salah di situs karena beberapa alasan lain, Anda dapat menetapkan $base_url untuk Drupal dengan mengikuti langkah-langkah berikut:

  1. Buat direktori /opt/apigee/data/apigee-drupal-devportal/sites/default/includes jika tidak ada.
  2. Buat file bernama settings.php di direktori tersebut.
  3. Tambahkan kode berikut ke file settings.php:
    /**
    * Base URL (optional).
    *
    * If Drupal is generating incorrect URLs on your site, which could
    * be in HTML headers (links to CSS and JS files) or visible links
    * on pages (such as in menus), uncomment the Base URL statement
    * below (remove the leading hash sign) and fill in the absolute URL
    * to your Drupal installation.
    *
    * You might also want to force users to use a given domain.
    * See the .htaccess file for more information.
    *
    * Examples:
    *   $base_url = 'http://www.example.com';
    *   $base_url = 'http://www.example.com:8888';
    *   $base_url = 'http://www.example.com/drupal';
    *   $base_url = 'https://www.example.com:8888/drupal';
    *
    * It is not allowed to have a trailing slash; Drupal will add it
    * for you.
    */
    # $base_url = 'http://www.example.com/';  // NO trailing slash!
    $base_url = ‘http://www.example.com’;
    
  4. Ubah baris $base_url terakhir menjadi nama host situs Anda.
  5. Simpan file.

Perhatikan bahwa Anda dapat menempatkan setelan lain dari /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php dalam file ini.

Untuk informasi selengkapnya tentang properti $base_url, lihat referensi berikut:

Pengembangan kustom Anda juga dapat memperluas kemampuan portal dengan kode kustom di luar tema. Untuk melakukannya, buat modul Drupal Anda sendiri seperti yang dijelaskan dalam topik pengembangan modul Drupal, dan tempatkan modul tersebut dalam direktori /sites/all/modules.