تثبيت بوابة "خدمات مطوِّري البرامج"

Edge for Private Cloud - الإصدار 4.17.01

قبل التثبيت، تأكَّد مما يلي:

  • يمكنك تثبيت Postgres قبل تثبيت البوابة. يمكنك إما تثبيت Postgres كجزء من تثبيت Edge أو تثبيت Postgres المستقل لاستخدامه من خلال البوابة.
    • في حال تثبيت Postgres المستقل، يمكن أن يكون على نفس عقدة البوابة.
    • إذا كنت تتصل بتطبيق Postgres المُثبَّت كجزء من Edge، وتم ضبط Postgres في وضع "الرئيسية"/"وضع الاستعداد"، حدِّد عنوان IP لخادم Postgres الرئيسي.
  • أنك تجري التثبيت على إصدار 64 بت من إصدار متوافق من Red Hat Enterprise Linux أو CentOS أو Oracle. يمكنك الاطّلاع على قائمة بالإصدارات المتوافقة ضمن البرامج المتوافقة والإصدارات المتوافقة.
  • تم تثبيت Yum.

نظرة عامة على التثبيت

بعد تثبيت الأداة المساعدة apigee-setup على عقدة، استخدم هذه الأداة لتثبيت البوابة على العقدة. تكون الأداة المساعدة apigee-setup على النحو التالي:

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

مرِّر ملف الإعداد إلى الأداة المساعدة apigee-setup التي تحتوي على المعلومات حول عملية التثبيت. إذا كان ملف الإعداد ينقصه أي معلومات مطلوبة، تطلب منك أداة apigee-setup إدخاله في سطر الأوامر.

الشرط الوحيد هو أن يتمكن مستخدم "apigee" من الوصول إلى ملف الإعداد أو قراءته.

على سبيل المثال، يمكنك استخدام الأمر التالي لتثبيت البوابة:

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

راجِع تثبيت الأداة المساعدة لإعداد واجهة برمجة التطبيقات Edge لمعرفة المزيد.

إنشاء ملف إعداد

في ما يلي مثال على ملف إعداد صامت لعملية تثبيت بوابة. عدِّل هذا الملف حسب الضرورة لعملية الضبط. استخدِم الخيار -f من أجل setup.sh لتضمين هذا الملف.

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

اختبر الاتصال بخادم إدارة Edge من خلال تنفيذ أمر cURL التالي من موجه الأوامر على خادم البوابة:

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

أو:

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

حيث يكون EMAIL وpassword هما عنوان البريد الإلكتروني وكلمة المرور لمشرف ORGNAME.

احرص على تحديد اسم المضيف ورقم المنفذ الخاصَّين بتثبيت Edge. المنفذ 8080 هو المنفذ التلقائي الذي يستخدمه Edge. إذا كنت تتصل بمؤسسة على السحابة الإلكترونية، يكون عنوان URL للطلب هو: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

في حال نجاح هذا الأمر، يعرض هذا الأمر استجابة مشابهة لما يلي:

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

2. إزالة الإصدارات التي تسبق الإصدار 7.0 من لغة PHP

يتحقق النص البرمجي للتثبيت من توفُّر إصدارات سابقة للإصدار 7.0 من لغة PHP على النظام قبل البدء في التثبيت. في حالة وجود إصدارات ما قبل 7.0 من PHP، يتم عرض رسالة التحذير التالية:

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

بالنسبة إلى CentOS وRHat Enterprise Linux (RHEL)، عليك إزالة حزم PHP باستخدام الأمر التالي:

yum remove <package-name>

3. تثبيت Postgres

تتطلّب البوابة تثبيت Postgres قبل أن تتمكّن من تثبيتها. يمكنك إما تثبيت Postgres كجزء من تثبيت Edge، أو تثبيت Postgres المستقل لاستخدامه من خلال البوابة.

  • إذا كنت تتصل بخدمة Postgres المثبَّتة كجزء من Edge، وتم ضبط Postgres في وضع المشرف/وضع الاستعداد، حدِّد عنوان IP لخادم Postgres الرئيسي.
  • في حال تثبيت Postgres المستقل، يمكن أن يكون على نفس عقدة البوابة.

للحصول على معلومات حول تثبيت Postgres كجزء من تثبيت Edge، يُرجى الاطّلاع على تثبيت مكونات Edge على عقدة.

لتثبيت Postgres المستقلّة:

  1. ثبِّت أداة Edge apigee-setup على العقدة باستخدام أي إجراء متصل بالإنترنت أو غير متصل بالإنترنت. راجِع تثبيت أداة إعداد واجهة برمجة التطبيقات Edge لمعرفة المزيد.
  2. أنشِئ ملف إعداد لأداة Postgres، كما هو موضَّح أدناه:

    # مجموعة الإعلانات المتسلسلة ومنطقة Postgres. استخدِم القيم التلقائية الموضّحة أدناه.
    MP_POD=gateway
    ISSUE=dc-1

    # اضبط كلمة مرور Postgres. القيمة التلقائية هي "postgres".
    PG_PWD=postgres
  3. في موجّه الأوامر، شغِّل النص البرمجي للإعداد لتثبيت Postgres:
    > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    يحدد الخيار " -p pdb" لتثبيت Postgres.

    يجب أن يتمكّن مستخدم "واجهة برمجة التطبيقات" من الوصول إلى ملف الإعداد أو قراءته.

4. تثبيت البوابة

لتثبيت البوابة، يُرجى اتّباع الخطوات التالية:

  1. ثبِّت أداة Edge apigee-setup على العقدة باستخدام الإنترنت أو الإجراء غير المتعلق بالإنترنت. راجِع تثبيت أداة إعداد واجهة برمجة التطبيقات Edge لمعرفة المزيد.
  2. تأكَّد من تثبيت Postgres، سواء كانت أداة Postgres مستقلة أو كجزء من تثبيت Edge.
  3. في موجّه الأوامر، شغِّل النص البرمجي للإعداد:
    > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    يحدد الخيار " -p dp" تثبيت البوابة.

    يجب أن يتمكّن مستخدم "واجهة برمجة التطبيقات" من الوصول إلى ملف الإعداد أو قراءته.
  4. انتقِل إلى الصفحة الرئيسية للبوابة على http://localhost:8079 أو إلى اسم نظام أسماء النطاقات للبوابة.
  5. سجِّل الدخول إلى البوابة باستخدام بيانات اعتماد المشرف التي حدّدتها في ملف الإعداد.

5. تأكّد من أنّ وحدة مدير التحديثات مفعَّلة.

لتلقّي إشعارات بشأن تحديثات Drupal، تأكَّد من أنّ وحدة إدارة تحديث Drupal مفعَّلة. من قائمة Drupal، اختَر الوحدات وانتقِل للأسفل إلى وحدة مدير التحديثات. إذا لم يكن مفعَّلاً، عليك تفعيله.

وبعد تفعيل الميزة، يمكنك الاطّلاع على التحديثات المتاحة باستخدام عنصر القائمة التقارير > التحديثات المتوفّرة. يمكنك أيضًا استخدام أمر Drush التالي:

> drush pm-info update

عليك تشغيل هذا الأمر من الدليل الجذر للموقع الإلكتروني. يتم تثبيت "بوابة المطوّرين" تلقائيًا على العنوان /opt/apigee/apigee-drupal. لذلك، يجب أولاً تغيير الدليل إلى /opt/apigee/apigee-drupal قبل تشغيل الأمر. إذا لم تثبِّت البوابة في الدليل التلقائي، يمكنك الانتقال إلى دليل التثبيت.

يمكنك استخدام عنصر القائمة التقارير > التحديثات المتاحة > الإعدادات لضبط الوحدة لإرسال رسالة إلكترونية إليك عند توفّر التحديثات وضبط معدل تكرار البحث عن التحديثات.

6. ضبط محرّك البحث Apache Solr (اختياري)

يتم تلقائيًا إيقاف وحدات Drupal التي تتصل بمحرّك البحث Apache Solr عند تثبيت البوابة. تستخدم معظم البوابات محرك بحث Drupal الداخلي، وبالتالي لا تتطلّب وحدات Drupal Solr.

إذا قررت استخدام Solr كمحرّك بحث، عليك تثبيت Solr محليًا على خادمك ثم تفعيل وحدات Drupal Solr وإعدادها على البوابة.

لتفعيل وحدات Drupal Solr:

  1. سجّل الدخول إلى المنصة كمستخدم لديه امتيازات المشرف أو امتيازات إنشاء المحتوى.
  2. اختَر الوحدات في قائمة Drupal.
  3. فعِّل وحدة Apache Solr Framework ووحدة Apache Solr Search.
  4. احفظ التغييرات.
  5. اضبط Solr على النحو الموضّح في https://drupal.org/node/1999280.

7. تثبيت Smart Docs (اختياري)

تتيح لك ميزة "المستندات الذكية" توثيق واجهات برمجة التطبيقات في بوابة "خدمات المطوِّرين" بطريقة تجعل مستندات واجهة برمجة التطبيقات تفاعلية بالكامل. مع ذلك، لاستخدام Smartالمستندات مع البوابة، يجب أولاً تثبيتها على Edge.

  • إذا كنت تربط البوابة بأحد تثبيتات Edge Cloud، يكون تطبيق Smart Docs مثبّتًا ولن تحتاج إلى ضبط أي إعدادات إضافية.
  • إذا كنت تربط البوابة بتطبيق Edge for Private Cloud لتثبيته، يجب أن تتأكّد من تثبيت تطبيق Smartdocs على Edge. لمزيد من المعلومات حول تثبيت Edge وSmart Docs، يُرجى الاطّلاع على تثبيت Smartالمستندات.

وعليك أيضًا تفعيل Smart Docs على البوابة. لمزيد من المعلومات حول المستندات الذكية، يُرجى الاطّلاع على استخدام Smart Docs في المستندات لواجهات برمجة التطبيقات.

8. ما الخطوات التالية؟

الخطوات التالية بعد تثبيت بوابة خدمات المطوّرين هي إعداد بوابة الويب وتخصيصها وفقًا لمتطلباتك المحددة. تحتوي المستندات على موقع Apigee الإلكتروني على جميع المعلومات حول إعداد بوابة وتصميمها وإدارتها. يمكنك الوصول إلى المستندات على http://apigee.com/docs/developer-services/content/what-developer-portal.

يدرج الجدول التالي بعض المهام الأكثر شيوعًا التي تنفّذها بعد التثبيت، ويتضمن روابط إلى مستندات Apigee التي يمكنك من خلالها العثور على مزيد من المعلومات:

المهمة

الوصف

تخصيص المظهر

ويحدّد المظهر مظهر البوابة، بما في ذلك الألوان والنمط والجوانب المرئية الأخرى.

تخصيص المظهر

تتضمن الصفحة الرئيسية القائمة الرئيسية ورسالة الترحيب والرأس والتذييل والعنوان.

إضافة حسابات مستخدمين وإدارتها

تتحكّم عملية التسجيل في كيفية تسجيل المطوّرين الجدد لحساب على البوابة. على سبيل المثال، هل يحصل المطوّرون الجدد على إمكانية وصول فوري إلى المنصة أم يجب إثبات هويتهم من قِبل أحد المشرفين. تتحكّم هذه العملية أيضًا في كيفية إشعار مشرف البوابة عند إنشاء حساب جديد.

ضبط البريد الإلكتروني

ترسل البوابة رسائل إلكترونية استجابةً لأحداث معيّنة. على سبيل المثال، عندما يسجّل مطوّر برامج جديد على المنصة وعندما يفقد مطوّر برامج كلمة المرور الخاصة به.

إضافة حسابات مستخدمين وإدارتها

أضِف صفحة "الأحكام والشروط" التي يجب أن يقبلها المطوّرون قبل السماح لهم بالوصول إلى المنصة.

إضافة حسابات مستخدمين وإدارتها

تنفّذ البوابة نموذج تفويض يستند إلى الدور. قبل السماح للمطوّرين بالتسجيل، يُرجى تحديد الأذونات والأدوار التي تستخدمها البوابة.

إضافة مشاركات المدوّنات والمنتدى

وتحتوي البوابة على دعم مضمَّن للمدونات والمنتديات التي تتضمّن سلاسل محادثات. حدِّد الأذونات المطلوبة لعرض المشاركات في المدوّنة والمنتدى وإضافتها وتعديلها وحذفها.

التأكد من عمل نسخ احتياطية لقاعدة البيانات

تأكد من أنك تقوم بالنسخ الاحتياطي لقاعدة بيانات Drupal. ونظرًا لاختلاف كل عملية تثبيت، يعود إليك تحديد أفضل طريقة للاحتفاظ بنسخة احتياطية من قاعدة البيانات.

ملاحظة: لا تتوافق وحدة "الاحتفاظ بنسخة احتياطية والنقل" مع قواعد بيانات Postgres.

راجِع أيضًا كيفية الاحتفاظ بنسخة احتياطية.

إعداد اسم مضيف

في حال عدم إعداد اسم مضيف في خادم نظام أسماء النطاقات، يمكنك في أي وقت الوصول إلى الموقع الإلكتروني من خلال عنوان IP الخاص بالخادم. إذا كنت تريد استخدام اسم مضيف، يمكنك ضبط نظام أسماء النطاقات للخادم، والذي يُفترض أن يعمل بشكل صحيح بدون أي إعدادات أخرى في الإعداد الأساسي.

في حال إعداد جهاز لموازنة الحمل أو ظهور عناوين URL غير صحيحة على موقعك الإلكتروني لسبب آخر، يمكنك ضبط $base_url في ملف settings.php الخاص ببوابة Dev، والذي يتوفّر تلقائيًا في الدليل /opt/apigee/apigee-drupal/sites/default.

التطوير المخصّص ويمكنك أيضًا توسيع نطاق إمكانات البوابة باستخدام رموز مخصّصة خارج المظهر. ولإجراء ذلك، أنشئ وحدة Drupal الخاصة بك كما هو موضّح في مواضيع تطوير الوحدات في Drupal، وضَع الوحدة في دليل /sites/all/modules.