Penginstalan portal Layanan Developer

Edge for Private Cloud v. 4.17.01

Sebelum menginstal, pastikan:

  • 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.
  • 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 telah diinstal.

Ringkasan penginstalan

Setelah Anda menginstal utilitas apigee-setup Edge di node, gunakan utilitas tersebut untuk menginstal portal 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 portal:

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

Lihat Menginstal utilitas penyiapan apigee Edge untuk mengetahui informasi selengkapnya.

Membuat file konfigurasi

Berikut adalah contoh file konfigurasi senyap untuk penginstalan portal. Edit file ini sesuai kebutuhan untuk konfigurasi Anda. Gunakan opsi -f untuk setup.sh agar dapat 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 

# You must configure the SMTP server used by the portal. 
# 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 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

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

{
  "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 pra-7.0

Skrip penginstalan akan memeriksa apakah ada versi PHP pra-7.0 di sistem sebelum memulai penginstalan. Jika ada PHP versi pra-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

Untuk CentOS dan RedHat Enterprise Linux (RHEL), hapus paket PHP menggunakan perintah berikut:

yum remove <package-name>

3. Instal Postgres

Portal memerlukan penginstalan Postgres 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 informasi tentang cara menginstal Postgres sebagai bagian dari penginstalan Edge, lihat Menginstal komponen Edge di node.

Untuk menginstal Postgres mandiri:

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

    # Pod dan region Postgres. Gunakan nilai default yang ditampilkan di bawah.
    MP_POD=gateway
    REGION=dc-1

    # Tetapkan sandi Postgres. Nilai defaultnya adalah '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 Postgres.

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

4. Instal portal

Untuk menginstal portal:

  1. Instal utilitas apigee-setup Edge di node menggunakan internet atau prosedur non-internet. Lihat Menginstal utilitas penyiapan apigee 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 dalam file konfigurasi.

5. Pastikan modul Pengelola update diaktifkan

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

Setelah diaktifkan, Anda dapat melihat update 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 utama situs. Secara default, Portal Developer diinstal di /opt/apigee/apigee-drupal. Oleh karena itu, Anda harus mengubah direktori terlebih dahulu ke /opt/apigee/apigee-drupal sebelum menjalankan perintah. Jika Anda tidak menginstal portal di direktori default, ubah ke direktori penginstalan.

Gunakan item menu Reports > Available Updates > Settings untuk mengonfigurasi modul agar mengirimi Anda email saat update tersedia dan 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 Drupal Solr.

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

Untuk mengaktifkan modul Solr Drupal:

  1. Login ke portal Anda sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Modul 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 terinstal dan tidak diperlukan konfigurasi lebih lanjut.
  • Jika 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 informasi selengkapnya tentang SmartDocs, lihat Menggunakan SmartDocs untuk mendokumentasikan API.

8. Apa selanjutnya?

Langkah berikutnya setelah Anda menginstal portal Layanan Developer adalah mengonfigurasi dan menyesuaikannya untuk kebutuhan khusus Anda. Dokumentasi di situs web 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:

Tugas

Deskripsi

Menyesuaikan tema

Tema menentukan tampilan portal, termasuk warna, gaya visual, 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 langsung mendapatkan akses 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 mengirimkan email sebagai respons terhadap peristiwa tertentu. Misalnya, saat developer baru mendaftar di portal dan saat developer kehilangan sandinya.

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 mendaftar, tentukan izin dan peran yang digunakan oleh portal.

Menambahkan postingan blog dan forum

Portal ini memiliki dukungan bawaan untuk blog dan forum dengan rangkaian pesan. 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, Anda dapat menentukan cara terbaik untuk mencadangkan database.

Catatan: Modul Pencadangan dan Migrasi tidak kompatibel dengan database Postgres.

Lihat juga Cara Melakukan Pencadangan.

Siapkan 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 perlu konfigurasi lain pada penyiapan dasar.

Jika Anda menyiapkan load balancer atau mendapatkan URL yang salah di situs Anda karena beberapa alasan lain, Anda dapat menetapkan $base_url di file settings.php Dev Portal, yang secara default terletak di direktori /opt/apigee/apigee-drupal/sites/default.

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 di direktori /sites/all/modules.