درحال نصب سرویس‌های درآمدزایی

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

«خدمات درآمدزایی» افزونه‌ای برای Apigee Edge است، بنابراین به‌عنوان فرایند مستقل اجرا نمی‌شود. در هر تنظیمات موجود Apigee Edge اجرا می‌شود.

الزامات درآمدزایی

  • اگر درحال نصب «درآمدزایی» روی توپولوژی Edge هستید که از چندین گره «سرور مدیریت» استفاده می‌کند، مثل نصب ۱۳ گره‌ای، باید قبل‌از نصب «درآمدزایی»، هر دو گره «سرور مدیریت Edge» را نصب کنید.
  • برای نصب «درآمدزایی» در Edge که نصب Edge دارای چندین گره Postgres است، گره‌های Postgres باید در حالت «اصلی/آماده به‌کار» پیکربندی شوند. اگر چند گره اصلی Postgres داشته باشید، نمی‌توانید «درآمدزایی» را در Edge نصب کنید. برای اطلاعات بیشتر، راه‌اندازی تکثیر «اصلی-آماده به کار» برای Postgres را ببینید.

نمای کلی نصب

مراحل زیر نحوه افزودن «خدمات درآمدزایی» به نصب موجود Apigee Edge را نشان می‌دهد:

  • از ابزار apigee-setup برای به‌روزرسانی گره «سرور مدیریت Apigee» استفاده کنید تا «خدمات درآمدزایی» را فعال کنید، برای مثال، مدیریت کاتالوگ، پیکربندی محدودیت‌ها و اعلان‌ها، صورت‌حساب و گزارش‌دهی.

    اگر چندین گره «سرور مدیریت» دارید، مثلاً نصب ۱۳ گره‌ای، باید قبل‌از نصب «درآمدزایی»، هر دو گره «سرور مدیریت لبه» را نصب کنید.
  • از ابزار apigee-setup برای به‌روزرسانی «پردازشگر پیام Apigee» استفاده کنید تا اجزای زمان اجرای «خدمات درآمدزایی» را فعال کنید، برای مثال، خط‌مشی ضبط تراکنش و اجرای محدودیت. اگر چندین «پردازنده پیام» دارید، «درآمدزایی» را روی همه آن‌ها نصب کنید.
  • فرایند آماده‌سازی «درآمدزایی» را برای سازمان‌های Edge خود انجام دهید.
  • درگاه «خدمات توسعه‌دهنده» را برای پشتیبانی از درآمدزایی پیکربندی کنید. برای اطلاعات بیشتر، به http://apigee.com/docs/monetization/content/configure-monetization-developer-portal مراجعه کنید.

درحال ایجاد فایل پیکربندی بی‌صدا برای «درآمدزایی»

در زیر نمونه‌ای از فایل پیکربندی بی‌صدا برای نصب «درآمدزایی» نشان داده شده است. این فایل را درصورت نیاز برای پیکربندی‌تان ویرایش کنید. برای افزودن این فایل، از گزینه -f در setup.sh استفاده کنید.

توجه: معمولاً این دارایی‌ها را به همان فایل پیکربندی که برای نصب Edge استفاده کرده‌اید اضافه می‌کنید، همان‌طور که در نصب اجزای Edge در گره نشان داده شده است.

# Edge configuration properties
# Specify IP address or DNS name of node.
IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra
IP2=192.168.1.2  # ZooKeeper, Cassandra
IP3=192.168.1.3  # ZooKeeper, Cassandra
IP4=192.168.1.4  # Router, Message Processor
IP5=192.168.1.5  # Router, Message Processor
IP6=192.168.1.6  # Qpid
IP7=192.168.1.7  # Qpid
IP8=192.168.1.8  # Postgres
IP9=192.168.1.9  # Postgres

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

# Edge sys admin credentials
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

# Specify the Management Server port.
APIGEE_PORT_HTTP_MS=8080

#
# Monetization configuration properties.
#
# Postgres credentials from Edge installation.
PG_USER=apigee    # Default from Edge installation
PG_PWD=postgres    # Default from Edge installation

# Specify Postgres server.
MO_PG_HOST="$IP8"    # Only specify one Postgres node.

# Create a Postgres user for Monetization.
# Default username is "postgre". 
# If you specify a different user, that user must already exist.
MO_PG_USER=postgre    
MO_PG_PASSWD=moUserPWord

# Specify one ZooKeeper host.
# Ensure this is a ZooKeeper leader node in a multi-datacenter environment.
ZK_HOSTS="$IP2"

# Specify Cassandra information.
# Ensure CASS_HOSTS is set to the same value as when you installed Edge.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"

# Default is "Apigee", unless it was changed during Edge install.  
CASS_CLUSTERNAME=Apigee

# Cassandra uname/pword required only if you enabled Cassandra authentication. 
# CASS_USERNAME= 
# CASS_PASSWORD= 

# Specify the region. 
# Default is dc-1 unless you are in a multi-datacenter environment. 
REGION=dc-1 

# If your Edge config file did not specify SMTP information, add it. 
# Monetization requires an SMTP server. 
SMTPHOST=smtp.gmail.com 
SMTPPORT=465 
SMTPUSER=your@email.com 
SMTPPASSWORD=yourEmailPassword 
SMTPSSL=y
نکته‌ها:
  • اگر فایل پیکربندی Edge شما اطلاعات SMTP را مشخص نکرده است، آن را اضافه کنید. درآمدزایی به سرور SMTP نیاز دارد.
  • در نصب مرکز داده تکی، همه گره‌های ZooKeeper به‌طور پیش‌فرض به‌عنوان رهبر پیکربندی می‌شوند. وقتی Edge را در چندین مرکز داده نصب می‌کنید، برخی‌از گره‌های ZooKeeper به‌عنوان ناظر پیکربندی می‌شوند. مطمئن شوید که دارایی ZK_HOSTS در بالا یک گره رهبر را در نصب چند مرکز داده مشخص می‌کند.
  • اگر اصالت‌سنجی Cassandra را فعال کنید، می‌توانید نام کاربری و گذرواژه Cassandra را بااستفاده از ویژگی‌های زیر ارسال کنید:
    CASS_USERNAME
    CASS_PASSWORD

ادغام خدمات درآمدزایی با همه سرورهای مدیریت

از روش زیر برای ادغام درآمدزایی در گره‌های «سرور مدیریت» استفاده کنید.

  1. اگر درحال نصب «درآمدزایی» روی توپولوژی Edge هستید که از چندین گره «سرور مدیریت» استفاده می‌کند، مثل نصب ۱۳ گره‌ای، مطمئن شوید که قبل‌از نصب «درآمدزایی»، هر دو گره «سرور مدیریت» را نصب کرده باشید.
  2. در گره «سرور مدیریت»، دستورگان راه‌اندازی را اجرا کنید:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

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

    کاربر «apigee» باید به فایل پیکربندی دسترسی داشته باشد یا آن را بخواند. برای مثال، فایل را در دایرکتوری /tmp در گره قرار دهید.
  3. اگر «درآمدزایی» را روی چندین گره «سرور مدیریت» نصب می‌کنید، مرحله ۲ را روی گره دوم «سرور مدیریت» تکرار کنید.

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

ادغام کردن «خدمات درآمدزایی» با همه «پردازشگرهای پیام»

از روش زیر برای ادغام درآمدزایی در همه گره‌های «پردازشگر پیام» استفاده کنید.

  1. در اولین گره «پردازشگر پیام»، در پیام‌واره فرمان، نوشتار راه‌اندازی را اجرا کنید:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

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

    کاربر «apigee» باید به فایل پیکربندی دسترسی داشته باشد یا آن را بخواند. برای مثال، فایل را در دایرکتوری /tmp در گره قرار دهید.
  2. این رویه را در همه گره‌های «پردازشگر پیام» تکرار کنید.

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

آماده‌سازی درآمدزایی

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

آماده‌سازی اضافی برای فعال کردن درآمدزایی برای یک سازمان

برای تکمیل فرایند آماده‌سازی درآمدزایی یک سازمان، باید:

  1. گروه درآمدزایی را ایجاد کنید: mxgroup.
  2. ‫Qpid را به گروه اضافه کنید.
  3. درآمدزایی را برای سازمان فعال کنید.
  4. تنظیمات اعلان را برای سازمان فعال کنید.
  5. این فرایند را برای همه سازمان‌هایی که می‌خواهید «درآمدزایی» را در آن‌ها فعال کنید تکرار کنید.

از فرمان enable-monetization برای انجام همه این کارها استفاده کنید. این دستورگان فایل پیکربندی حاوی ویژگی‌های زیر را می‌گیرد:

MSIP=IPorDNSofManagementServer
APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
# Space-separated list IP/DNS names of all Qpid nodes in the data center being configured.
QPID_HOST="$IP6 $IP7"    
QPID_PORT=8083     # Default is 8083.
REGION=dc-1
ORG_NAME=myorg    # The Edge org where you want to enable monetization. 
MX_GROUP=mxgroup    # Default Monetization group.

نکته‌ها:

  • CASS_HOSTS و REGION را روی همان مقادیری تنظیم کنید که هنگام نصب «درآمدزایی» استفاده کردید.
  • اگر در پیکربندی چند مرکز داده «درآمدزایی» را فعال می‌کنید:
    • باید فرایند آماده‌سازی را در «سرور مدیریت» در هر مرکز داده تکرار کنید.
    • فایل پیکرببندی باید فقط گره‌های Qpid را در مرکز داده‌ای که پیکربندی می‌شود فهرست کند.

برای اجرای متن:

  1. فراخوانی کردن دستورگان:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

    کاربر «apigee» باید بتواند به فایل پیکربندی دسترسی داشته باشد یا آن را بخواند. برای مثال، فایل را در دایرکتوری /tmp در گره قرار دهید.

    اگر چندین «سرور مدیریت» دارید، فقط باید این دستورگان را در یکی از آن‌ها اجرا کنید.

    این دستورگان سازمان، محصولات، توسعه‌دهندگان، و برنامه‌ها را از پایگاه داده Cassandra به پایگاه داده Monetization PostgreSQL تکثیر می‌کند. پس‌از نصب موفقیت‌آمیز «خدمات درآمدزایی»، داده‌ها به‌طور خودکار همگام‌سازی می‌شوند.
  2. این روش را برای هر سازمانی که می‌خواهید «درآمدزایی» را در آن فعال کنید تکرار کنید.
  3. اگر در محیط چند مرکز داده هستید، این فرایند را در «سرور مدیریت» در مرکز داده دیگر تکرار کنید. مطمئن شوید که فایل پیکربندی فقط گره‌های Qpid را در مرکز داده‌ای که پیکربندی می‌شود فهرست کند.

وقتی دفعه بعد به «میانای کاربری Edge» وارد می‌شوید، ورودی «درآمدزایی» را در منو سطح بالای سازمان می‌بینید:

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

برای پیکربندی درگاه «خدمات توسعه‌دهندگان» به‌منظور پشتیبانی از درآمدزایی، به http://apigee.com/docs/monetization/content/configure-monetization-developer-portal مراجعه کنید.

افزودن گره «سرور مدیریت» به «نصب درآمدزایی»

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

برای افزودن «سرور مدیریت»:

  1. جدید «سرور مدیریت» را نصب کنید.
  2. «درآمدزایی» را در «سرور مدیریت» جدید نصب کنید.
  3. در «سرور مدیریت» اصلی، موارد زیر را فراخوانی کنید:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. بازراه‌اندازی اصلی «سرور مدیریت»:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. در «سرور مدیریت» جدید، موارد زیر را فراخوانی کنید:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. بازراه‌اندازی جدید «سرور مدیریت»:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

پیکربندی اضافی

ارائه «اسناد صورت‌حساب» به‌صورت فایل‌های PDF

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

پیکربندی تنظیمات سازمان

تنظیمات زیرینه: جدول زیر ویژگی‌های سطح سازمان را که برای پیکربندی سازمان ضرب دردسترس هستند فهرست می‌کند. می‌توانید از تماس PUT برای افزودن/به‌روزرسانی این مشخصه‌ها همان‌گونه که در زیر نشان داده شده است استفاده کنید:

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

برای مثال، برونداد فرمان CURL بالا چیزی شبیه این خواهد بود:

{
...
    "displayName": "Orgnization name",
    "name": "org4",
    "properties": {
        "property": [
...
            {
                "name": "MINT_CURRENCY",
                "value": "USD"
            },
            {
                "name": "MINT_COUNTRY",
                "value": "US"
            },
            {
                "name": "MINT_TIMEZONE",
                "value": "GMT"
            }
        ]
    }
}

مشخصه‌ها

شرح

MINT_TAX_MODEL

مقادیر پذیرفته‌شده این‌ها هستند: DISCLOSED،

فاش‌نشده، ترکیبی (پیش‌فرض تهی است)

MINT_CURRENCY

کد ارز ISO (پیش‌فرض تهی است)

MINT_TAX_NEXUS

محل مالیات (پیش‌فرض تهی است)

MINT_DEFAULT_PROD_TAX_CATEGORY

دسته مالیاتی محصول پیش‌فرض (پیش‌فرض تهی است)

MINT_IS_GROUP_ORG

سازمان گروه IS (پیش‌فرض نادرست است)

MINT_HAS_BROKER

خراب است (پیش‌فرض نادرست است)

MINT_TIMEZONE

منطقه زمانی (پیش‌فرض خالی است)

MINT_TAX_ENGINE_EXTERNAL_ID

شناسه موتور مالیات (پیش‌فرض تهی است)

MINT_COUNTRY

کشور سازمان (پیش‌فرض تهی است)

MINT_REG_NO

شماره ثبت سازمان، پادشاهی متحد شماره‌ای متفاوت از شناسه مالیاتی ارائه می‌دهد (پیش‌فرض تهی است)

MINT_BILLING_CYCLE_TYPE

سرشکن‌شده، CALENDAR_MONTH (پیش‌فرض CALENDAR_MONTH است)

MINT_SUPPORTED_BILLING_TYPE

پیش‌پرداخت/پس‌پرداخت/هر دو (پیش‌فرض پیش‌پرداخت است)

MINT_IS_SEPARATE_INV_FOR_FEES

نشان می‌دهد که آیا صورت‌حساب کارمزد جداگانه‌ای باید تولید شود یا نه (پیش‌فرض: خیر)

MINT_ISSUE_NETTING_STMT

نشان می‌دهد که آیا بیانیه خالص‌سازی باید صادر شود یا نه (پیش‌فرض نادرست است)

MINT_NETTING_STMT_PER_CURRENCY

نشان می‌دهد که آیا بیانیه خالص‌سازی باید به‌ازای هر ارز تولید شود (پیش‌فرض نادرست است)

MINT_HAS_SELF_BILLING

نشان می‌دهد که سازمان صورت‌حساب خودکار دارد یا نه (پیش‌فرض نادرست است)

MINT_SELF_BILLING_FOR_ALL_DEV

نشان می‌دهد که آیا سازمان برای همه توسعه‌دهندگان صورت‌حساب خودکار دارد یا نه(پیش‌فرض «نه» است)

MINT_HAS_SEPARATE_INV_FOR_PROD

نشان می‌دهد که آیا سازمان برای هر محصول صورت‌حساب جداگانه دارد یا نه (پیش‌فرض نادرست است)

MINT_HAS_BILLING_ADJUSTMENT

نشان می‌دهد که آیا سازمان از اصلاحات صورت‌حساب پشتیبانی می‌کند یا نه (پیش‌فرض «نادرست» است)

features.isMonetizationEnabled

مورد استفاده میانای کاربر مدیریت برای نمایش منو ویژه درآمدزایی (پیش‌فرض نادرست است)

ui.config.isOperator

مورداستفاده میانای کاربر مدیریت برای نمایش ارائه‌دهنده به‌عنوان «اپراتور» دربرابر «سازمان»

(پیش‌فرض درست است)

برای پیکربندی تنظیمات سازمان کسب‌وکار بااستفاده از واسط کاربر مدیریت، به http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services مراجعه کنید.

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

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

الگوی واسط کاربر در واسط کاربر مدیریت برای توسعه‌دهندگان پراکسی دردسترس است. توسعه‌دهنده پراکسی باید خط‌مشی ضرب را در جریان پیام پیوست کند. پس‌از اجرای این خط‌مشی، خطا مطابق با خط‌مشی در پاسخ خطا ایجاد خواهد شد. اگر ContinueOnError روی درست تنظیم شده باشد، خطا ایجاد نمی‌شود و متغیرهای جاری‌سازی «mint.limitsViolated»، «mint.isDeveloperSuspended»، و «mint.limitsPolicyError» تنظیم می‌شوند که درصورت نیاز می‌توانند برای مدیریت استثناهای بیشتر استفاده شوند.