نصب پورتال خدمات توسعه دهنده

Edge for Private Cloud نسخه 4.18.01

قبل از نصب، اطمینان حاصل کنید که:

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

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

نمای کلی نصب

پس از نصب ابزار Edge the 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 مراجعه کنید.

منسوخ شدن ویژگی SMTPSSL

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

اکنون به جای ویژگی SMTP_PROTOCOL از ویژگی SMTPSSL برای تنظیم پروتکل مورد استفاده توسط سرور SMTP متصل به پورتال استفاده می کنید. مقادیر معتبر عبارتند از: "استاندارد"، "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=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. اتصال خود به 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

بسته های PHP را با استفاده از دستور زیر حذف کنید:

yum remove package-name

3. Postgres را نصب کنید

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

• اگر به Postgres که به‌عنوان بخشی از Edge نصب شده است وصل می‌شوید و Postgres در حالت master/standby پیکربندی شده است، آدرس 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. در خط فرمان، اسکریپت setup را برای نصب Postgres اجرا کنید:

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

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

4. پورتال را نصب کنید

برای نصب پورتال:

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

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

   گزینه -p dp نصب پورتال را مشخص می کند.

   فایل پیکربندی باید توسط کاربر "apigee" قابل دسترسی یا خواندن باشد.

4. به صفحه اصلی پورتال در http://localhost:8079 یا به نام DNS پورتال خود بروید.
5. با استفاده از اطلاعات کاربری مدیری که در فایل پیکربندی تنظیم کرده اید، وارد پورتال شوید تا مطمئن شوید که پورتال به درستی اجرا می شود.
6. گزارش ها > گزارش وضعیت را در منوی دروپال انتخاب کنید تا مطمئن شوید که می توانید وضعیت فعلی پورتال را ببینید.

5. مطمئن شوید که ماژول مدیر به روز رسانی فعال است

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

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

drush pm-info update

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

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

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

به طور پیش فرض، ماژول های دروپال که به موتور جستجوی Apache Solr متصل می شوند، هنگام نصب پورتال غیرفعال می شوند. اکثر پورتال ها از موتور جستجوی داخلی دروپال استفاده می کنند و بنابراین نیازی به ماژول های دروپال 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 توضیح داده شده پیکربندی کنید.

7. SmartDocs (اختیاری) را نصب کنید

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

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

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

8. ماژول JQuery Update را برای نصب های غیر اینترنتی پیکربندی کنید (اختیاری)

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

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

1. به عنوان یک کاربر با امتیازات مدیریت یا ایجاد محتوا وارد پورتال خود شوید.
2. Configuration > Development > JQuery Update را در منوی Drupal انتخاب کنید.
3. روی عملکرد در ناوبری سمت چپ کلیک کنید.
4. در منوی کشویی JQuery و JQuery UI CDN هیچکدام را انتخاب کنید.
5. روی Save configuration کلیک کنید.

9. بعد چی؟

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

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