نصب درگاه

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

پیش‌از نصب درگاه Apigee Developer Services (یا به‌طور خلاصه، درگاه)، مطمئن شوید که:

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

نصب‌کننده فقط شامل ماژول‌های مشارکت‌شده Drupal است که توسط درگاه «سرویس‌های توسعه‌دهنده Apigee» (یا به‌طور خلاصه، درگاه) موردنیاز است. برای کسب اطلاعات درباره نصب سایر ماژول‌های مشارکت‌شده، به گسترش Drupal 7 مراجعه کنید.

نمای کلی نصب

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

1. آزمایش اتصال
2. برداشتن نسخه‌های PHP قدیمی‌تر از ۷.۰
3. نصب Postgres
4. نصب درگاه
5. مطمئن شوید «مدیر به‌روزرسانی» فعال باشد
6. (اختیاری) پیکربندی Apache Solr
7. (اختیاری) نصب SmartDocs
8. (اختیاری) پیکربندی JQuery

منسوخ شدن خصوصیت SMTPSSL

در نسخه‌های قبلی، از ویژگی SMTPSSL برای تنظیم پروتکل مورداستفاده سرور SMTP متصل به درگاه استفاده می‌کردید. آن ویژگی منسوخ شده است.

اکنون برای تنظیم پروتکل مورداستفاده سرور SMTP متصل به پورتال، به‌جای ویژگی SMTPSSL از ویژگی SMTP_PROTOCOL استفاده می‌کنید. مقادیر معتبر عبارت‌اند از: «standard»، «ssl»، یا «tls».

ایجاد فایل پیکربندی درگاه

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

# 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=YOUR_EMAIL_PASSWORD

۱. اتصال به 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 استفاده می‌کند. اگر به سازمانی در فضای ابری متصل می‌شوید، نشانی وب درخواست این است: https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

اگر موفقیت‌آمیز باشد، curl پاسخی مشابه پاسخ زیر برمی‌گرداند:

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

بسته‌های PHP را بااستفاده از فرمان زیر بردارید:

yum remove package_name

اگر مطمئن نیستید PHP در سرورتان نصب شده است یا نه، از فرمان زیر استفاده کنید:

rpm -qa | grep -i php

توجه داشته باشید که این پورتال از PHP نسخه 4.18.01-0.0.49 استفاده می‌کند. این شماره برای مطابقت با شماره نسخه Apigee Edge برای Private Cloud درنظر گرفته نشده است.

۳. نصب Postgres

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

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

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

برای نصب Postgres مستقل:

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

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

   /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

   گزینه -p pdb برای نصب Postgre مشخص شده است. فایل پیکربندی باید برای کاربر «apigee» قابل‌دسترسی یا خواندن باشد.

۴. نصب درگاه

قبل‌از اینکه بتوانید درگاه را نصب کنید، مطمئن شوید که موارد زیر را همان‌طور که در 3 شرح داده شده است انجام داده‌اید. نصب Postgres:

1. نصب ابزار Edge apigee-setup در گره پورتال
2. Postgres را به‌صورت مستقل یا به‌عنوان بخشی از نصب Edge نصب کنید

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

1. در پیام‌واره فرمان، اسکریپت setup را اجرا کنید:

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   مکان:

   • configFile فایل پیکربندی درگاه است که در ایجاد فایل پیکربندی درگاه شرح داده شده است.
   • -p dp به دستورگان setup دستور می‌دهد درگاه را نصب کند.

برای تأیید اینکه نصب پورتال موفقیت‌آمیز بوده است:

1. به صفحه اصلی درگاه در http://localhost:8079 یا به نام ساناد درگاهتان بروید.
2. بااستفاده از اطلاعات اعتباری سرپرست که در فایل پیکربندی درگاه تنظیم کرده‌اید، به درگاه وارد شوید.
3. گزارش‌ها > گزارش وضعیت را در منو Drupal انتخاب کنید تا مطمئن شوید که می‌توانید وضعیت فعلی درگاه را ببینید.
4. مطمئن شوید که اتصال «سرور مدیریت» موفقیت‌آمیز بوده است. اگر این‌طور نبود:
   1. به صفحه «پیکربندی اتصال» در پورتال بروید (برای مثال، http://portal_IP:8079/admin/config/devconnect).
   2. روی دکمه آزمایش کردن اتصال کلیک کنید. اگر اتصال موفقیت‌آمیز باشد، کار تمام است. اگر اتصال برقرار نشد، ادامه دهید.
   3. تنظیمات نقطه پایانی و اصالت‌سنجی را بررسی کنید:
      • نشانی وب نقطه پایان Management API: بررسی کنید که پروتکل (HTTP یا HTTPS)، نشانی IP یا نام ساناد، و شماره درگاه درست باشد؛ برای مثال:

        http://10.10.10.10:8080/v1

      • کاربر اصالت‌سنجی‌شده نقطه پایانی: نام کاربری سرپرست سازمان.
      • گذرواژه کاربر اصالت‌سنجی‌شده: گذرواژه سرپرست سازمان.

      مقادیر پیش‌فرض نشان‌دهنده تنظیمات موجود در فایل پیکربندی درگاه شما است که درطول فرایند نصب ایجاد کرده‌اید.

      این مقادیر باید با مقادیر ms_IP_or_DNS، email، و password که در مرحله ۱: آزمایش اتصال به Apigee Edge استفاده کردید مطابقت داشته باشد. نام کاربری و گذرواژه باید با مقادیر ویژگی‌های USER_NAME و USER_PWD در فایل پیکربندی آماده‌سازی یا اطلاعات اعتباری هر کاربری که نقش او «سرپرست سازمان» است مطابقت داشته باشد.

   4. پس‌از اتصال موفقیت‌آمیز به «سرور مدیریت»، روی دکمه ذخیره پیکربندی در پایین صفحه کلیک کنید تا تغییراتتان ذخیره شود.

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

برای دریافت اعلان‌های به‌روزرسانی‌های Drupal، مطمئن شوید که ماژول Drupal Update manager فعال است. از منو Drupal، Modules (واحدها) را انتخاب کنید و به پایین پیمایش کنید تا به واحد Update manager (مدیر به‌روزرسانی) برسید. اگر فعال نیست، آن را فعال کنید.

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

drush pm-info update

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

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

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

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

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

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

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

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

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

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

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

‫۸. پیکربندی واحد JQuery Update برای نصب‌های غیر اینترنتی (اختیاری)

اگر ماژول JQuery Update را در نصب غیر اینترنتی نصب و استفاده می‌کنید، باید ماژول را برای استفاده از نسخه محلی JQuery پیکربندی کنید. اگر ماژول را برای استفاده از CDN برای نصب غیر اینترنتی پیکربندی کنید، تلاش می‌کند به CDN دسترسی پیدا کند و باعث تأخیر در بارگیری صفحه می‌شود. برای اطلاعات بیشتر درباره ماژول JQuery Update، به https://www.drupal.org/project/jquery_update مراجعه کنید.

برای پیکربندی کردن واحد JQuery Update برای استفاده از نسخه محلی JQuery:

1. به‌عنوان کاربری با امتیازات سرپرست یا ایجاد محتوا به سیستم درگاهتان وارد شوید.
2. پیکربندی > توسعه > به‌روزرسانی JQuery را در منو Drupal انتخاب کنید.
3. در پیمایش سمت راست، روی عملکرد کلیک کنید.
4. در منو کرکره‌ای JQuery و JQuery UI CDN، هیچ‌کدام را انتخاب کنید.
5. روی ذخیره پیکربندی کلیک کنید.

‫۹. مراحل بعدی

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