Geliştirici Hizmetleri portalı kurulumu

Edge for Private Cloud sürüm 4.17.05

Yüklemeden önce şunlardan emin olun:

  • Portalı yüklemeden önce Postgres'i yüklemeniz gerekir. Postgres'i Edge'i yükleme işleminin bir parçası olarak yükleyebilir veya portal tarafından kullanılmak üzere bağımsız olarak yükleyebilirsiniz.
    • Postgres'i bağımsız olarak yüklerseniz portal ile aynı düğümde olabilir.
    • Edge'in bir parçası olarak yüklenen Postgres'e bağlanıyorsanız ve Postgres, ana/bekleme modunda yapılandırılmışsa ana Postgres sunucusunun IP adresini belirtin.
  • Yükleme işlemini Red Hat Enterprise Linux, CentOS veya Oracle'ın desteklenen bir sürümünün 64 bit sürümünde gerçekleştiriyorsanız. Desteklenen sürümlerin listesini Desteklenen yazılımlar ve desteklenen sürümler bölümünde bulabilirsiniz.
  • Yum yüklü olmalıdır.

Yüklemeye genel bakış

Edge'i bir düğüme yükledikten sonra apigee-setup yardımcı programını kullanarak portalı düğüme yükleyin. apigee-setup yardımcı programı şu biçimdedir:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Yüklemeyle ilgili bilgileri içeren apigee-setup yardımcı programına bir yapılandırma dosyası iletin. Yapılandırma dosyasında gerekli bilgiler eksikse apigee-setup yardımcı programı, bu bilgileri komut satırına girmenizi ister.

Tek şart, yapılandırma dosyasının "apigee" kullanıcısı tarafından erişilebilir veya okunabilir olmasıdır.

Örneğin, portalı yüklemek için aşağıdaki komutu kullanın:

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

Daha fazla bilgi için Edge apigee-setup yardımcı programını yükleme başlıklı makaleyi inceleyin.

Yapılandırma dosyası oluşturma

Aşağıda, portal kurulumu için örnek bir sessiz yapılandırma dosyası gösterilmektedir. Bu dosyayı yapılandırmanız için gerektiği şekilde düzenleyin. Bu dosyayı dahil etmek için setup.sh komutunda -f seçeneğini kullanın.

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. Apigee Edge bağlantınızı test etme

Portal sunucusundaki bir komut isteminden aşağıdaki cURL komutunu çalıştırarak Edge yönetim sunucusuyla bağlantınızı test edin:

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

veya:

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

EMAIL ve PASSWORD, ORGNAME yöneticisinin e-posta adresi ve şifresidir.

Edge kurulumunuza özel ana makine adını ve bağlantı noktası numarasını belirttiğinizden emin olun. 8080 numaralı bağlantı noktası, Edge tarafından kullanılan varsayılan bağlantı noktasıdır. Buluttaki bir kuruluşa bağlanıyorsanız istek URL'si https://api.enterprise.apigee.com/v1/organizations/{ORGNAME} olur.

Başarılı olursa bu komut aşağıdakine benzer bir yanıt döndürür:

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

2. PHP'nin 7.0'dan önceki sürümlerini kaldırma

Yükleme komut dosyası, yüklemeyi başlatmadan önce sistemde PHP'nin 7.0 öncesi sürümlerinin olup olmadığını kontrol eder. PHP'nin 7.0'dan önceki sürümleri mevcutsa aşağıdaki uyarı mesajı gösterilir:

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

Aşağıdaki komutu kullanarak PHP paketlerini kaldırın:

yum remove <package-name>

3. Postgres'i yükleme

Portalın yüklenebilmesi için önce Postgres'in yüklenmesi gerekir. Postgres'i Edge'i yükleme işleminin bir parçası olarak yükleyebilir veya portal tarafından kullanılmak üzere bağımsız olarak yükleyebilirsiniz.

  • Edge'in bir parçası olarak yüklenen Postgres'e bağlanıyorsanız ve Postgres, ana/bekleme modunda yapılandırılmışsa ana Postgres sunucusunun IP adresini belirtin.
  • Postgres'i bağımsız olarak yüklerseniz portal ile aynı düğümde olabilir.

Edge'i yükleme kapsamında Postgres'i yükleme hakkında bilgi edinmek için Edge bileşenlerini bir düğüme yükleme başlıklı makaleyi inceleyin.

Postgres'i bağımsız olarak yüklemek için:

  1. İnternet veya internet dışı prosedürü kullanarak düğüme Edge apigee-setup yardımcı programını yükleyin. Daha fazla bilgi için Edge apigee-setup yardımcı programını yükleme başlıklı makaleyi inceleyin.
  2. Postgres için aşağıda gösterildiği gibi bir yapılandırma dosyası oluşturun:

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

    # Postgres'in pod'u ve bölgesi. Aşağıda gösterilen varsayılan değerleri kullanın.
    MP_POD=gateway
    REGION=dc-1

    # Set the Postgres password. Varsayılan değer "postgres"tir.
    PG_PWD=postgres
  3. Komut isteminde, Postgres'i yüklemek için kurulum komut dosyasını çalıştırın:
    > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    "-p pdb" seçeneği, Postgre'nin yükleneceğini belirtir.

    Yapılandırma dosyası, "apigee" kullanıcısı tarafından erişilebilir veya okunabilir olmalıdır.

4. Portalı yükleme

Portalı yüklemek için:

  1. İnternet veya internet dışı prosedürü kullanarak düğüme Edge apigee-setup yardımcı programını yükleyin. Daha fazla bilgi için Edge apigee-setup yardımcı programını yükleme başlıklı makaleyi inceleyin.
  2. Postgres'i bağımsız olarak veya Edge'i yükleme kapsamında yüklediğinizden emin olun.
  3. Komut isteminde kurulum komut dosyasını çalıştırın:
    > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    "-p dp" seçeneği, portalın yükleneceğini belirtir.

    Yapılandırma dosyası, "apigee" kullanıcısı tarafından erişilebilir veya okunabilir olmalıdır.
  4. http://localhost:8079 adresinden portal ana sayfasına veya portalınızın DNS adına gidin.
  5. Yapılandırma dosyasında ayarladığınız yönetici kimlik bilgilerini kullanarak portalda oturum açın.

5. Güncelleme yöneticisi modülünün etkinleştirildiğinden emin olun.

Drupal güncellemeleriyle ilgili bildirim almak için Drupal Update Manager modülünün etkinleştirildiğinden emin olun. Drupal menüsünden Modules'ı (Modüller) seçin ve aşağı kaydırarak Update manager (Güncelleme yöneticisi) modülüne gidin. Etkinleştirilmemişse etkinleştirin.

Etkinleştirildikten sonra, Raporlar > Mevcut Güncellemeler menü öğesini kullanarak mevcut güncellemeleri görebilirsiniz. Aşağıdaki Drush komutunu da kullanabilirsiniz:

> drush pm-info update

Bu komutu sitenin kök dizininden çalıştırmanız gerekir. Geliştirici Portalı varsayılan olarak /opt/apigee/apigee-drupal/wwwroot dizinine yüklenir. Bu nedenle, komutu çalıştırmadan önce dizini /opt/apigee/apigee-drupal/wwwroot olarak değiştirmeniz gerekir. Portalı varsayılan dizine yüklemediyseniz yükleme dizininize geçin.

Modülü, güncellemeler kullanıma sunulduğunda size e-posta gönderecek ve güncellemeleri kontrol etme sıklığını ayarlayacak şekilde yapılandırmak için Raporlar > Mevcut Güncellemeler > Ayarlar menü öğesini kullanın.

6. Apache Solr arama motorunu yapılandırma (İsteğe bağlı)

Varsayılan olarak, portalı yüklediğinizde Apache Solr arama motoruna bağlanan Drupal modülleri devre dışı bırakılır. Çoğu portal, dahili Drupal arama motorunu kullandığından Drupal Solr modüllerine ihtiyaç duymaz.

Arama motorunuz olarak Solr'ı kullanmaya karar verirseniz Solr'ı sunucunuza yerel olarak yüklemeniz ve ardından portalda Drupal Solr modüllerini etkinleştirip yapılandırmanız gerekir.

Drupal Solr modüllerini etkinleştirmek için:

  1. Yönetici veya içerik üretme ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal menüsünde Modules'u (Modüller) seçin.
  3. Apache Solr Framework modülünü ve Apache Solr Search modülünü etkinleştirin.
  4. Değişikliklerinizi kaydedin.
  5. Solr'ı https://drupal.org/node/1999280 adresinde açıklandığı şekilde yapılandırın.

7. SmartDocs'u yükleme (isteğe bağlı)

SmartDocs, API belgelerini tamamen etkileşimli hale getirecek şekilde API'lerinizi Geliştirici Hizmetleri portalında belgelemenize olanak tanır. Ancak SmartDocs'u portalda kullanmak için öncelikle Edge'e SmartDocs'u yüklemeniz gerekir.

  • Portalı bir Edge Cloud kurulumuna bağlıyorsanız SmartDocs zaten yüklüdür ve başka bir yapılandırma gerekmez.
  • Portalı bir Edge for Private Cloud kurulumuna bağlıyorsanız SmartDocs'un Edge'de yüklü olduğundan emin olmanız gerekir. Edge ve SmartDocs'u yükleme hakkında daha fazla bilgi için SmartDocs'u yükleme başlıklı makaleyi inceleyin.

Ayrıca portalda SmartDocs'u da etkinleştirmeniz gerekir. SmartDocs hakkında daha fazla bilgi için API'leri belgelemek için SmartDocs'u kullanma başlıklı makaleyi inceleyin.

8. İnternet dışı yüklemeler için JQuery Update modülünü yapılandırma (İsteğe bağlı)

JQuery Update modülünü internet bağlantısı olmayan bir yüklemede yükleyip kullanırsanız modülü JQuery'nin yerel sürümünü kullanacak şekilde yapılandırmanız gerekir. Modülü, internet dışı bir yükleme için CDN kullanacak şekilde yapılandırırsanız CDN'ye erişmeye çalışır ve sayfa yüklemede gecikmelere neden olur. JQuery Update modülü hakkında daha fazla bilgi için https://www.drupal.org/project/jquery_update adresini ziyaret edin.

JQuery Update modülünü JQuery'nin yerel sürümünü kullanacak şekilde yapılandırmak için:

  1. Yönetici veya içerik üretme ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal menüsünde Configuration > Development > JQuery Update'i (Yapılandırma > Geliştirme > JQuery Güncellemesi) seçin.
  3. Soldaki gezinme menüsünde Performans'ı tıklayın.
  4. JQuery ve JQuery UI CDN açılır menüsünde Yok'u seçin.
  5. Save configuration'ı (Yapılandırmayı kaydet) tıklayın.

9. Sırada ne var?

Geliştirici Hizmetleri portalını yükledikten sonraki adımlarınız, portalı özel gereksinimlerinize göre yapılandırmak ve özelleştirmektir. Apigee web sitesindeki dokümanlar, portal yapılandırma, stil oluşturma ve yönetme ile ilgili tüm bilgileri içerir. Belgelere http://apigee.com/docs/developer-services/content/what-developer-portal adresinden erişebilirsiniz.

Aşağıdaki tabloda, yükleme işleminden sonra gerçekleştirdiğiniz en yaygın görevlerden bazıları listelenmiştir ve daha fazla bilgi bulabileceğiniz Apigee belgelerinin bağlantıları yer almaktadır:

Görev

Açıklama

Temayı özelleştirme

Tema; renkler, stil ve diğer görsel özellikler dahil olmak üzere portalın görünümünü tanımlar.

Görünümü özelleştirme

Ana sayfada ana menü, karşılama mesajı, üstbilgi, altbilgi ve başlık bulunur.

Kullanıcı hesapları ekleme ve yönetme

Kayıt işlemi, yeni geliştiricilerin portalda nasıl hesap kaydı yapacağını kontrol eder. Örneğin, yeni geliştiriciler portala hemen erişebilir mi yoksa bir yönetici tarafından doğrulanmaları gerekir mi? Bu işlem, yeni bir hesap oluşturulduğunda portal yöneticisinin nasıl bilgilendirileceğini de kontrol eder.

E-postayı yapılandırma

Portal, belirli etkinliklere yanıt olarak e-posta gönderir. Örneğin, portala yeni bir geliştirici kaydolduğunda ve bir geliştirici şifresini kaybettiğinde.

Kullanıcı hesapları ekleme ve yönetme

Geliştiricilerin portala erişmesine izin verilmeden önce kabul etmeleri gereken bir Hükümler ve Koşullar sayfası ekleyin.

Kullanıcı hesapları ekleme ve yönetme

Portalda role dayalı bir yetkilendirme modeli uygulanır. Geliştiricilerin kaydolmasına izin vermeden önce portal tarafından kullanılan izinleri ve rolleri tanımlayın.

Blog ve forum yayınları ekleme

Portalda bloglar ve mesaj dizili forumlar için yerleşik destek bulunur. Blog ve forum yayınlarını görüntülemek, eklemek, düzenlemek ve silmek için gereken izinleri tanımlayın.

Veritabanı yedeklemeleri yaptığınızdan emin olun.

Drupal veritabanını yedeklediğinizden emin olun. Her kurulum farklı olduğundan, veritabanını yedeklemenin en iyi yolunu belirlemek size kalmıştır.

Not: Yedekleme ve Taşıma modülü, Postgres veritabanlarıyla uyumlu değildir.

Yedekleme işlemi nasıl yapılır? başlıklı makaleyi de inceleyin.

Ana makine adı oluşturma

DNS sunucunuzda bir ana makine adı ayarlamazsanız siteye her zaman sunucunun IP adresi üzerinden erişebilirsiniz. Ana makine adı kullanmak istiyorsanız sunucu için DNS yapılandırabilirsiniz. Bu, temel bir kurulumda başka bir yapılandırma olmadan doğru şekilde çalışır.

Yük dengeleyici ayarladıysanız veya başka bir nedenle sitenizde yanlış URL'ler alıyorsanız Geliştirici Portalı'nın settings.php dosyasında $base_url değerini ayarlayabilirsiniz. Bu dosya varsayılan olarak /opt/apigee/apigee-drupal/wwwroot/sites/default dizininde bulunur.

Özel geliştirme Ayrıca, temanızın dışındaki özel kodlarla portalınızın özelliklerini genişletmek de isteyebilirsiniz. Bunu yapmak için Drupal'ın modül geliştirme konularında açıklandığı şekilde kendi Drupal modülünüzü oluşturun ve modülü /sites/all/modules dizinine yerleştirin.