Penginstalan portal Layanan Developer

Edge for Private Cloud v4.18.01

Sebelum menginstal, pastikan bahwa:

  • Anda menginstal Postgres sebelum menginstal portal. Anda dapat menginstal Postgres sebagai bagian menginstal 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 menjalankan penginstalan pada versi 64-bit dari versi Red Hat yang didukung Enterprise Linux, CentOS, atau Oracle. Lihat daftar versi yang didukung di Software yang didukung dan versi yang didukung.
  • Yum sudah diinstal.

Penginstal hanya menyertakan modul yang dikontribusikan Drupal yang diwajibkan oleh Portal Layanan Developer Apigee (atau singkatnya, portal). Untuk informasi tentang cara menginstal modul kontribusi lainnya, lihat Memperluas Drupal 7.

Ringkasan penginstalan

Setelah Anda menginstal utilitas apigee-setup Edge pada node, gunakan utilitas tersebut utilitas untuk menginstal portal pada 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 hilang, diperlukan ini, apigee-setup utilitas meminta Anda untuk memasukkannya pada baris perintah.

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

Misalnya, gunakan perintah berikut untuk menginstal portal:

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

Lihat Menginstal utilitas Edge apigee-setup untuk lebih banyak.

Penghentian properti SMTPSSL

Dalam rilis sebelumnya, Anda menggunakan properti SMTPSSL untuk mengatur protokol yang digunakan oleh server SMTP yang terhubung ke portal. Properti itu telah tidak digunakan lagi.

Anda sekarang menggunakan properti SMTP_PROTOCOL, alih-alih 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

Di bawah ini adalah contoh file konfigurasi senyap untuk penginstalan portal. Edit file ini sesuai kebutuhan untuk konfigurasi Anda. Gunakan opsi -f untuk setup.sh agar dapat menyertakannya .

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. 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 email alamat dan sandi administrator untuk ORGNAME.

Pastikan untuk menentukan nama {i>host<i} dan nomor porta khusus untuk pemasangan Edge Anda. Porta 8080 adalah port default yang digunakan oleh Edge. Jika Anda terhubung ke organisasi di {i>cloud<i}, maka 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 pra-7.0

Skrip penginstalan akan memeriksa apakah ada versi PHP di bawah 7.0 pada sistem sebelum memulai penginstalan. Jika PHP versi sebelum 7.0 tersedia, 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. Instal Postgres

Portal ini mengharuskan Postgres diinstal sebelum Anda dapat menginstalnya. Anda bisa instal Postgres sebagai bagian dari penginstalan Edge, atau instal Postgres secara mandiri untuk digunakan oleh portal.

  • Jika Anda terhubung ke Postgres yang diinstal sebagai bagian dari Edge, dan Postgres dikonfigurasi di 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 Instal komponen Edge pada node.

Untuk menginstal Postgres secara mandiri:

  1. Instal utilitas apigee-setup Edge pada node menggunakan prosedur internet atau non-internet. Lihat Instal utilitas penyiapan Edge apigee untuk mengetahui informasi selengkapnya.
  2. Buat file konfigurasi untuk Postgres, seperti yang ditunjukkan di bawah ini:
    # 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 "apigee" .

4. Instal portal

Untuk menginstal portal:

  1. Instal utilitas apigee-setup Edge di {i>node <i}menggunakan prosedur internet atau non-internet. Lihat Instal utilitas apigee-setup Edge untuk banyak lagi.
  2. Pastikan Anda telah menginstal Postgres, baik Postgres mandiri atau sebagai bagian dari menginstal 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 "apigee" .

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

5. Pastikan modul Update manager telah aktif

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

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

drush pm-info update

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

Gunakan Laporan > Update yang Tersedia > Item menu Settings yang akan dikonfigurasi modul untuk mengirimkan email kepada Anda saat pembaruan tersedia dan menyetel frekuensi pemeriksaan pembaruan.

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 aktifkan dan konfigurasikan 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 Apache Solr Penelusuran.
  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 memudahkan Dokumentasi API yang sepenuhnya interaktif. Namun, untuk menggunakan SmartDocs dengan portal, Anda harus terlebih dahulu menginstal SmartDocs di Edge.

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

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

8. Konfigurasikan Modul Update JQuery untuk penginstalan non-internet (Opsional)

Jika Anda menginstal dan menggunakan modul Pembaruan JQuery di instalasi non-internet, Anda harus mengkonfigurasi modul untuk menggunakan JQuery versi lokal. Jika Anda mengonfigurasi modul untuk menggunakan CDN untuk penginstalan yang bukan melalui internet, layanan ini akan mencoba mengakses CDN dan menyebabkan penundaan di halaman memuat. Untuk informasi selengkapnya tentang modul Update JQuery, lihat https://www.drupal.org/project/jquery_update.

Untuk mengonfigurasi modul Update JQuery agar dapat menggunakan JQuery versi lokal:

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

9. Apa selanjutnya?

Langkah selanjutnya setelah Anda menginstal portal Layanan Developer adalah mengonfigurasi dan menyesuaikan untuk kebutuhan spesifik 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 instalasi, serta menyertakan link ke dokumentasi Apigee tempat Anda dapat menemukan informasi lebih lanjut:

Tugas Deskripsi

Menyesuaikan tema

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

Sesuaikan tampilan

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

Tambahkan 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 portal administrator akan diberi tahu ketika akun baru dibuat.

Mengonfigurasi email

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

Tambahkan dan mengelola akun pengguna

Tambahkan Persyaratan & Halaman ketentuan yang harus disetujui developer sebelum diizinkan mengakses portal.

Tambahkan dan mengelola akun pengguna

Portal tersebut menerapkan model otorisasi berbasis peran. Sebelum mengizinkan pengembang untuk daftar, tentukan izin dan peran yang digunakan oleh portal.

Tambahkan blog dan postingan forum

Portal ini memiliki dukungan bawaan untuk blog dan forum berangkai. Menentukan izin 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 berbeda, terserah Anda untuk menentukan cara terbaik mencadangkan di skrip untuk menyiapkan database.

Catatan: Modul Pencadangan dan Migrasi tidak kompatibel dengan Postgres {i>database<i}.

Lihat juga Cara Melakukan Pencadangan.

Siapkan nama host

Jika Anda tidak menyiapkan nama {i>host<i} di server DNS, Anda selalu dapat mengakses situs itu melalui menggunakan alamat IP server. Jika Anda ingin menggunakan nama {i>host<i}, Anda dapat mengkonfigurasi DNS untuk server, yang seharusnya berfungsi dengan baik tanpa perlu konfigurasi lain pada pengaturan dasar.

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

  1. Membuat 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 memasukkan setelan lain dari /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php di file ini.

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

Pengembangan kustom Sebaiknya Anda juga memperluas kemampuan portal dengan kode kustom di luar tema. Untuk melakukannya, buat modul Drupal Anda sendiri seperti yang dijelaskan dalam aplikasi Drupal modul pengembangan, dan tempatkan modul di /sites/all/modules saat ini.