نصب درگاه «سرویس‌های توسعه‌دهنده»

Edge for Private Cloud نسخه ۴.۱۷.۰۱

قبل‌از نصب، مطمئن شوید که:

  • ‫Postgres را قبل‌از نصب کردن درگاه نصب می‌کنید. می‌توانید Postgres را به‌عنوان بخشی از نصب Edge نصب کنید یا Postgres را به‌صورت مستقل برای استفاده در درگاه نصب کنید.
    • اگر Postgres را به‌صورت مستقل نصب کنید، می‌تواند در همان گره درگاه باشد.
    • اگر به Postgres متصل می‌شوید که به‌عنوان بخشی از Edge نصب شده است و Postgres در حالت اصلی/آماده به‌کار پیکربندی شده است، نشانی IP سرور اصلی Postgres را مشخص کنید.
  • نصب را روی نسخه ۶۴ بیتی یکی از نسخه‌های پشتیبانی‌شده Red Hat Enterprise Linux،‏ CentOS، یا Oracle انجام می‌دهید. فهرست نسخه‌های پشتیبانی‌شده را در نرم‌افزار پشتیبانی‌شده و نسخه‌های پشتیبانی‌شده ببینید.
  • ‫Yum نصب شده است.

نمای کلی نصب

پس‌از نصب Edge، ابزار 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 apigee-setup را ببینید.

درحال ایجاد فایل پیکربندی

در زیر نمونه‌ای از فایل پیکربندی بی‌صدا برای نصب درگاه نشان داده شده است. این فایل را درصورت نیاز برای پیکربندی‌تان ویرایش کنید. برای افزودن این فایل، از گزینه -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

۱. اتصال خود به Apigee Edge را آزمایش کنید

با اجرای فرمان cURL زیر از پیام‌واره در سرور درگاه، اتصال خود به سرور مدیریت Edge را آزمایش کنید:

> 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 خود را مشخص کنید. درگاه ‫۸۰۸۰ درگاه پیش‌فرضی است که Edge استفاده می‌کند. اگر به سازمانی در فضای ابری متصل می‌شوید، نشانی وب درخواست این است: 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"
}

۲. برداشتن نسخه‌های قبل‌از ۷.۰ PHP

پیش‌از شروع نصب، دستور نصب نسخه‌های قبل‌از ۷.۰ PHP را در سیستم بررسی می‌کند. اگر نسخه‌های قبل‌از ۷.۰ 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 و RedHat Enterprise Linux (RHEL)، بسته‌های PHP را بااستفاده از فرمان زیر بردارید: فرمان:

yum remove <package-name>

۳. نصب Postgres

برای نصب کردن درگاه، باید Postgres را نصب کنید. می‌توانید Postgres را هم‌زمان با نصب Edge نصب کنید، یا Postgres را به‌صورت مستقل برای استفاده در درگاه نصب کنید.

  • اگر به Postgres متصل می‌شوید که به‌عنوان بخشی از Edge نصب شده است و Postgres در حالت اصلی/آماده به‌کار پیکربندی شده است، نشانی IP سرور اصلی Postgres را مشخص کنید.
  • اگر Postgres را به‌صورت مستقل نصب کنید، می‌تواند در همان گره درگاه باشد.

برای اطلاعات درباره نصب Postgres به‌عنوان بخشی از نصب Edge، به نصب اجزای Edge در گره مراجعه کنید.

برای نصب Postgres خوداتکا:

  1. برنامه کمکی Edge apigee-setup را در گره بااستفاده از روش اینترنتی یا غیر اینترنتی نصب کنید. برای اطلاعات بیشتر، نصب ابزار کمکی apigee-setup در Edge را ببینید.
  2. فایل پیکربندی برای Postgres ایجاد کنید، همان‌طور که در زیر نشان داده شده است:

    # غلاف و منطقه Postgres. از مقادیر پیش‌فرض نشان‌داده‌شده در زیر استفاده کنید.
    MP_POD=gateway
    REGION=dc-1

    # گذرواژه Postgres را تنظیم کنید. مقدار پیش‌فرض «postgres» است.
    PG_PWD=postgres
  3. در پیام‌واره فرمان، برای نصب Postgres، نوشتار راه‌اندازی را اجرا کنید:
    > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    گزینه «-p pdb» نصب Postgres را مشخص می‌کند.

    کاربر «apigee» باید به فایل پیکربندی دسترسی داشته باشد یا آن را بخواند.

۴. نصب درگاه

برای نصب درگاه:

  1. برنامه کمکی Edge apigee-setup را روی گره بااستفاده از روش اینترنتی یا غیر اینترنتی نصب کنید. برای اطلاعات بیشتر، نصب ابزار کمکی apigee-setup در Edge را ببینید.
  2. مطمئن شوید که Postgres را نصب کرده‌اید، چه Postgres خوداتکا چه به‌عنوان بخشی از نصب Edge.
  3. در پیام‌واره فرمان، دستورگان راه‌اندازی را اجرا کنید:
    > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    گزینه «-p dp» مشخص می‌کند که درگاه نصب شود.

    کاربر «apigee» باید به فایل پیکربندی دسترسی داشته باشد یا آن را بخواند.
  4. به صفحه اصلی درگاه در http://localhost:8079 یا به نام DNS درگاهتان بروید.
  5. بااستفاده از اطلاعات اعتباری سرپرستی که در فایل پیکربندی تنظیم کرده‌اید، به سیستم درگاه وارد شوید.

۵. مطمئن شوید که واحد «مدیر به‌روزرسانی» فعال باشد

برای دریافت اعلان‌های به‌روزرسانی Drupal، مطمئن شوید که واحد «مدیر به‌روزرسانی Drupal» فعال باشد. از منو Drupal، واحدها را انتخاب کنید و به پایین پیمایش کنید تا به واحد مدیر به‌روزرسانی برسید. اگر فعال نیست، آن را فعال کنید.

پس‌از فعال شدن، می‌توانید به‌روزرسانی‌های دردسترس را بااستفاده از مورد منو گزارش‌ها > به‌روزرسانی‌های دردسترس مشاهده کنید. همچنین می‌توانید از فرمان Drush زیر استفاده کنید:

> drush pm-info update

باید این فرمان را از فهرست راهنمای ریشه سایت اجرا کنید. به‌طور پیش‌فرض، «درگاه توسعه‌دهندگان» در /opt/apigee/apigee-drupal نصب می‌شود. بنابراین، قبل‌از اجرای فرمان، ابتدا باید دایرکتوری را به /opt/apigee/apigee-drupal تغییر دهید. اگر در دایرکتوری پیش‌فرض درگاه را نصب نکرده‌اید، به دایرکتوری نصب خود بروید.

از عنصر منو گزارش‌ها > به‌روزرسانی‌های دردسترس > تنظیمات برای پیکربندی واحد استفاده کنید تا وقتی به‌روزرسانی دردسترس است به شما ایمیل کند و دفعات بررسی به‌روزرسانی‌ها را تنظیم کنید.

‫۶. پیکربندی موتور جستجوی Apache Solr (اختیاری)

به‌طور پیش‌فرض، واحدهای Drupal که به موتور جستجوی Apache Solr متصل می‌شوند هنگام نصب درگاه غیرفعال می‌شوند. اکثر درگاه‌ها از موتور جستجوی داخلی Drupal استفاده می‌کنند و بنابراین به واحد Drupal Solr نیاز ندارند.

اگر تصمیم گرفتید از Solr به‌عنوان موتور جستجو استفاده کنید، باید Solr را به‌صورت محلی در سرورتان نصب کنید و سپس واحدهای Drupal Solr را در درگاه فعال و پیکربندی کنید.

برای فعال کردن واحدهای Drupal Solr:

  1. به‌عنوان کاربری با امتیازات سرپرست یا تولید محتوا، به سیستم درگاهتان وارد شوید.
  2. واحدها را در منو Drupal انتخاب کنید.
  3. واحد چارچوب Apache Solr و واحد جستجوی Apache Solr را فعال کنید.
  4. تغییرات را ذخیره کنید.
  5. ‫Solr را همان‌طور که در https://drupal.org/node/1999280 توضیح داده شده است پیکربندی کنید.

‫۷. نصب SmartDocs (اختیاری)

‫SmartDocs به شما امکان می‌دهد میاناهای برنامه‌سازی کاربردی خود را در پورتال «خدمات توسعه‌دهندگان» به‌گونه‌ای مستند کنید که مستندات میانای برنامه‌سازی کاربردی کاملاً تعاملی باشد. بااین‌حال، برای استفاده از «اسناد هوشمند» با درگاه، ابتدا باید «اسناد هوشمند» را در Edge نصب کنید.

  • اگر درحال متصل کردن درگاه به نصب Edge Cloud هستید، SmartDocs ازقبل نصب شده است و پیکربندی دیگری لازم نیست.
  • اگر درحال متصل کردن درگاه به نصب Edge for Private Cloud هستید، باید مطمئن شوید که SmartDocs روی Edge نصب شده باشد. برای اطلاعات بیشتر درباره نصب Edge و SmartDocs، به نصب SmartDocs مراجعه کنید.

همچنین باید «سندهای هوشمند» را در درگاه فعال کنید. برای کسب اطلاعات بیشتر درباره SmartDocs، به استفاده از SmartDocs برای مستندسازی میاناهای برنامه‌سازی کاربردی مراجعه کنید.

‫۸. گام بعدی چیست؟

مراحل بعدی شما پس‌از نصب کردن درگاه «خدمات توسعه‌دهنده» این است که آن را برای الزامات خاص خود پیکربندی و سفارشی‌سازی کنید. مستندات موجود در وب‌سایت Apigee حاوی همه اطلاعات مربوط به پیکربندی، سبک‌بندی، و مدیریت درگاه است. در http://apigee.com/docs/developer-services/content/what-developer-portal به اسناد دسترسی پیدا کنید.

جدول زیر برخی‌از رایج‌ترین تکالیفی را که پس‌از نصب انجام می‌دهید فهرست می‌کند، و شامل پیوندهایی به مستندات Apigee است که در آن می‌توانید اطلاعات بیشتری پیدا کنید:

تکلیف

شرح

سفارشی‌سازی زمینه

زمینه ظاهر درگاه را تعریف می‌کند، ازجمله رنگ‌ها، سبک، و دیگر جنبه‌های دیداری.

سفارشی‌سازی کردن ظاهر

صفحه اصلی شامل منو اصلی، پیام خوشامدگویی، سرصفحه، پاصفحه، و عنوان است.

افزودن و مدیریت حساب‌های کاربری

فرایند ثبت‌نام کنترل می‌کند که توسعه‌دهندگان جدید چگونه در درگاه حساب ثبت کنند. برای مثال، آیا توسعه‌دهندگان جدید بلافاصله به درگاه دسترسی پیدا می‌کنند یا باید توسط سرپرست درستی‌سنجی شوند. این فرایند همچنین کنترل می‌کند که وقتی حساب جدیدی ایجاد می‌شود، چگونه به سرپرست درگاه اطلاع داده شود.

درحال پیکربندی ایمیل

درگاه در پاسخ به رویدادهای خاصی ایمیل ارسال می‌کند. برای مثال، وقتی توسعه‌دهنده جدیدی در درگاه ثبت‌نام می‌کند و وقتی توسعه‌دهنده‌ای گذرواژه‌اش را ازدست می‌دهد.

افزودن و مدیریت حساب‌های کاربری

صفحه «شرایط خدمات» اضافه کنید که توسعه‌دهندگان باید قبل‌از اینکه اجازه دسترسی به درگاه را پیدا کنند آن را بپذیرند.

افزودن و مدیریت حساب‌های کاربری

درگاه مدل مجوز مبتنی بر نقش را پیاده‌سازی می‌کند. قبل‌از اینکه به توسعه‌دهندگان اجازه دهید ثبت‌نام کنند، اجازه‌ها و نقش‌های مورد استفاده در درگاه را تعریف کنید.

افزودن پست‌های وبلاگ و تالار گفتمان

این درگاه از وبلاگ‌ها و تالارهای گفتمان رشته‌ای پشتیبانی داخلی دارد. اجازه‌های موردنیاز برای مشاهده، افزودن، ویرایش، و حذف پست‌های وبلاگ و تالار گفتمان را تعریف کنید.

مطمئن شوید که از پایگاه داده پشتیبان‌گیری می‌کنید

مطمئن شوید که از پایگاه داده Drupal پشتیبان‌گیری می‌کنید. توجه داشته باشید که چون هر نصب متفاوت است، این شما هستید که باید بهترین روش پشتیبان‌گیری از پایگاه داده را تعیین کنید.

توجه: واحد «پشتیبان‌گیری و انتقال» با پایگاه‌های داده Postgres سازگار نیست.

همچنین نحوه انجام پشتیبان‌گیری را ببینید.

راه‌اندازی نام میزبان

اگر نام میزبان را در سرور ساناد خود راه‌اندازی نکنید، همیشه می‌توانید ازطریق نشانی IP سرور به سایت دسترسی پیدا کنید. اگر می‌خواهید از نام میزبان استفاده کنید، می‌توانید ساناد را برای سرور پیکربندی کنید، که باید بدون هیچ پیکربندی دیگری در تنظیمات اولیه به‌درستی کار کند.

اگر ترازکننده بار راه‌اندازی کرده‌اید یا به دلایل دیگر نشانی‌های وب نادرست در سایتتان دریافت می‌کنید، می‌توانید $base_url را در فایل settings.php در «درگاه توسعه‌دهندگان» تنظیم کنید، که به‌طور پیش‌فرض در /opt/apigee/apigee-drupal/sites/default قرار دارد.

توسعه سفارشی همچنین ممکن است بخواهید قابلیت‌های درگاهتان را با کد سفارشی خارج از موضوعتان گسترش دهید. برای انجام این کار، واحد Drupal خودتان را همان‌طور که در مباحث توسعه واحد Drupal توضیح داده شده است ایجاد کنید و واحد را در دایرکتوری /sites/all/modules قرار دهید.