Edge สำหรับ Private Cloud เวอร์ชัน 4.16.05
บริการสร้างรายได้เป็นส่วนเสริมของ Apigee Edge จึงไม่ได้ทำงานเป็นกระบวนการแบบสแตนด์อโลน ซึ่งจะทำงานภายในการตั้งค่า Apigee Edge ใดก็ได้ที่มีอยู่
ข้อกำหนดการสร้างรายได้
- หากจะติดตั้งการสร้างรายได้บนโทโพโลยี Edge ที่ใช้โหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด คุณต้องติดตั้งโหนด Edge Management Server ทั้งสองโหนดก่อนติดตั้งการสร้างรายได้
- หากต้องการติดตั้งการสร้างรายได้บน Edge ซึ่งการติดตั้ง Edge มีโหนด Postgres หลายโหนด คุณต้องกำหนดค่าโหนด Postgres ในโหมดหลัก/สแตนด์บาย คุณจะติดตั้งการสร้างรายได้บน Edge ไม่ได้หากมีโหนดหลักของ Postgres หลายโหนด ดูข้อมูลเพิ่มเติมได้ที่ตั้งค่าการจำลองในโหมด Master-Standby สำหรับ Postgres
ภาพรวมการติดตั้ง
ขั้นตอนต่อไปนี้จะแสดงวิธีเพิ่มบริการสร้างรายได้ในการติดตั้ง Apigee Edge ที่มีอยู่
- ใช้ยูทิลิตี apigee-setup เพื่ออัปเดตโหนด Apigee Management Server เพื่อเปิดใช้บริการสร้างรายได้ เช่น การจัดการแคตตาล็อก ขีดจำกัดและการกำหนดค่าการแจ้งเตือน การเรียกเก็บเงินและการรายงาน
หากมีโหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด คุณต้องติดตั้งโหนด Edge Management Server ทั้ง 2 โหนดก่อนติดตั้งการสร้างรายได้ - ใช้ยูทิลิตี apigee-setup เพื่ออัปเดตเครื่องมือประมวลผลข้อความ Apigee เพื่อเปิดใช้คอมโพเนนต์รันไทม์ของบริการสร้างรายได้ เช่น นโยบายการบันทึกธุรกรรมและการบังคับใช้ขีดจำกัด หากคุณมีเครื่องมือประมวลผลข้อความหลายเครื่อง ให้ติดตั้งการสร้างรายได้ในอุปกรณ์ทั้งหมด
- ทําตามขั้นตอนการเริ่มต้นใช้งานการสร้างรายได้สําหรับองค์กร Edge
- กำหนดค่าพอร์ทัลบริการสำหรับนักพัฒนาแอปเพื่อรองรับการสร้างรายได้ ดูข้อมูลเพิ่มเติมได้ที่ http://apigee.com/docs/monetization/content/configure-monetization-developer-portal
การสร้างไฟล์การกำหนดค่าแบบไม่มีเสียงสำหรับการสร้างรายได้
ด้านล่างนี้เป็นตัวอย่างไฟล์การกำหนดค่าแบบไม่มีเสียงสำหรับการติดตั้งการสร้างรายได้ แก้ไขไฟล์นี้ตามที่จำเป็นสำหรับการกำหนดค่า ใช้ตัวเลือก -f เพื่อตั้งค่า.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
ผสานรวมบริการสร้างรายได้กับเซิร์ฟเวอร์การจัดการทั้งหมด
ใช้ขั้นตอนต่อไปนี้เพื่อผสานรวมการสร้างรายได้บนโหนดเซิร์ฟเวอร์การจัดการ
- หากคุณติดตั้งการสร้างรายได้บนโทโพโลยี Edge ที่ใช้โหนดเซิร์ฟเวอร์การจัดการหลายโหนด เช่น การติดตั้ง 13 โหนด ให้ตรวจสอบว่าคุณได้ติดตั้งโหนดเซิร์ฟเวอร์การจัดการทั้ง 2 โหนดก่อนติดตั้งการสร้างรายได้
- ในโหนดเซิร์ฟเวอร์การจัดการ ให้เรียกใช้สคริปต์การตั้งค่าดังนี้
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
ตัวเลือก “-p mo” จะระบุการผสานรวมการสร้างรายได้
ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้ ตัวอย่างเช่น นำไฟล์ไปวางไว้ในไดเรกทอรี /tmp ในโหนด - หากคุณกำลังติดตั้งการสร้างรายได้บนโหนดเซิร์ฟเวอร์การจัดการหลายโหนด ให้ทำตามขั้นตอนที่ 2 ซ้ำในโหนดที่ 2 ของเซิร์ฟเวอร์การจัดการ
เมื่อมีการกำหนดค่าที่ประสบความสำเร็จ ระบบจะสร้างสคีมา RDBMS สำหรับบริการสร้างรายได้ในฐานข้อมูล PostgreSQL การดำเนินการนี้เป็นการผสานรวมบริการสร้างรายได้และองค์ประกอบที่เชื่อมโยงกับเซิร์ฟเวอร์ Postgres อย่างสมบูรณ์
ผสานรวมบริการสร้างรายได้กับผู้ประมวลผลข้อมูลข้อความทั้งหมด
ใช้ขั้นตอนต่อไปนี้เพื่อผสานรวมการสร้างรายได้บนโหนดของผู้ประมวลผลข้อมูลข้อความทั้งหมด
- ในโหนดตัวประมวลผลข้อมูลข้อความแรก เรียกใช้สคริปต์การตั้งค่าที่พรอมต์คำสั่งดังนี้
> /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
ตัวเลือก “-p mo” ระบุให้รวมการสร้างรายได้
ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านไฟล์การกำหนดค่าได้ ตัวอย่างเช่น นำไฟล์ไปวางไว้ในไดเรกทอรี /tmp ในโหนด - ทำขั้นตอนนี้ซ้ำในโหนด Message Processor ทั้งหมด
เมื่อกำหนดค่าสำเร็จ ผู้ประมวลผลข้อความจะได้รับการอัปเดตด้วยบริการสร้างรายได้ การดำเนินการนี้มีการผสานรวมบริการสร้างรายได้และองค์ประกอบที่เชื่อมโยงกับผู้ประมวลผลข้อความจนเสร็จสมบูรณ์
การเริ่มต้นใช้งานการสร้างรายได้
หากต้องการสร้างองค์กรใหม่ที่เปิดใช้การสร้างรายได้ ก่อนอื่นให้สร้างองค์กรเช่นเดียวกับที่สร้างสำหรับองค์กรใหม่ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเริ่มร่วมงานกับองค์กร
การเริ่มต้นใช้งานเพิ่มเติมเพื่อเปิดใช้การสร้างรายได้สำหรับองค์กร
หากต้องการเริ่มต้นใช้งานการสร้างรายได้ในองค์กรให้เสร็จสมบูรณ์ คุณต้องทำดังนี้
- สร้างกลุ่มการสร้างรายได้: mxgroup
- เพิ่ม Qpid ลงในกลุ่ม
- เปิดใช้การสร้างรายได้สำหรับองค์กร
- เปิดใช้การตั้งค่าการแจ้งเตือนสำหรับองค์กร
- ทำขั้นตอนนี้ซ้ำสำหรับทุกองค์กรที่คุณต้องการเปิดใช้การสร้างรายได้
ใช้คำสั่ง 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.
Notes:
- ตั้งค่า CASS_HOSTS และ REGION เป็นค่าเดียวกันกับที่ใช้ตอนติดตั้งการสร้างรายได้
- หากคุณเปิดใช้การสร้างรายได้ในการกำหนดค่าศูนย์ข้อมูลหลายแห่ง ให้ทำดังนี้
- คุณต้องทำตามขั้นตอนการเริ่มต้นใช้งานซ้ำในเซิร์ฟเวอร์การจัดการในศูนย์ข้อมูลแต่ละแห่ง
- ไฟล์การกำหนดค่าควรแสดงเฉพาะโหนด Qpid ในศูนย์ข้อมูลที่กำหนดค่าเท่านั้น
หากต้องการเรียกใช้สคริปต์ ให้ทำดังนี้
- เรียกใช้สคริปต์ดังนี้
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision ให้เปิดใช้-monetization -f configFile
ผู้ใช้ "apigee" ต้องเข้าถึงหรืออ่านได้ ตัวอย่างเช่น นำไฟล์ไปวางไว้ในไดเรกทอรี /tmp ในโหนด
หากมีเซิร์ฟเวอร์การจัดการหลายเซิร์ฟเวอร์ คุณจะต้องเรียกใช้สคริปต์นี้ในเซิร์ฟเวอร์เพียงแห่งเดียวเท่านั้น
สคริปต์นี้จะจำลององค์กร ผลิตภัณฑ์ นักพัฒนาซอฟต์แวร์ และแอปพลิเคชันจากฐานข้อมูล Cassandra ไปยังฐานข้อมูล Monetization PostgreSQL หลังจากติดตั้งบริการสร้างรายได้เรียบร้อยแล้ว ระบบจะซิงค์ข้อมูลโดยอัตโนมัติ - ทำขั้นตอนนี้ซ้ำสำหรับทุกองค์กรที่คุณต้องการเปิดใช้การสร้างรายได้
- หากคุณอยู่ในสภาพแวดล้อมศูนย์ข้อมูลหลายแห่ง ให้ทำกระบวนการนี้ซ้ำในเซิร์ฟเวอร์การจัดการในศูนย์ข้อมูลอื่น ตรวจสอบว่ารายการไฟล์การกำหนดค่ามีเฉพาะโหนด Qpid ในศูนย์ข้อมูลที่กำหนดค่าเท่านั้น
เมื่อคุณเข้าสู่ระบบ Edge UI ในครั้งถัดไป คุณจะเห็นรายการการสร้างรายได้ในเมนูระดับบนสุดขององค์กร
กำหนดค่าพอร์ทัลบริการสำหรับนักพัฒนาแอป
หากต้องการกำหนดค่าพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์เพื่อรองรับการสร้างรายได้ โปรดดูที่ http://apigee.com/docs/monetization/content/configure-monetization-developer-portal
การเพิ่มโหนดเซิร์ฟเวอร์การจัดการลงในการติดตั้งการสร้างรายได้
หากเพิ่มเซิร์ฟเวอร์การจัดการลงในการติดตั้ง Edge ที่มีอยู่ คุณต้องเพิ่มบริการสร้างรายได้ไปยังเซิร์ฟเวอร์การจัดการใหม่และกำหนดค่าเซิร์ฟเวอร์การจัดการทั้งหมดเพื่อให้สื่อสารกันได้
วิธีเพิ่มเซิร์ฟเวอร์การจัดการ
- ติดตั้งเซิร์ฟเวอร์การจัดการใหม่
- ติดตั้งการสร้างรายได้ในเซิร์ฟเวอร์การจัดการใหม่
- ในเซิร์ฟเวอร์การจัดการเดิม ให้เรียกใช้คำสั่งต่อไปนี้
> /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster - รีสตาร์ทเซิร์ฟเวอร์การจัดการเดิม โดยทำดังนี้
> /opt/apigee/apigee-service/bin/apigee-service edge-management-serverบ้างไหม - ในเซิร์ฟเวอร์การจัดการใหม่ ให้เรียกใช้คำสั่งต่อไปนี้
> /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster - รีสตาร์ทเซิร์ฟเวอร์การจัดการใหม่ โดยทำดังนี้
> /opt/apigee/apigee-service/bin/apigee-service edge-management-serverบ้างไหม
การกำหนดค่าเพิ่มเติม
ส่งเอกสารการเรียกเก็บเงินเป็นไฟล์ PDF
การสร้างรายได้จะแสดงเอกสารการเรียกเก็บเงินต่อผู้ใช้ปลายทางในรูปแบบ HTML หากต้องการจัดเตรียมเอกสารการเรียกเก็บเงินเป็นไฟล์ PDF คุณก็ผสานรวมการสร้างรายได้กับระบบการเรียกเก็บเงินที่มีการสร้าง PDF หรือออกใบอนุญาตไลบรารี PDF ของบุคคลที่สามที่รองรับได้
กำหนดการตั้งค่าองค์กร
การตั้งค่าแบ็กเอนด์: ตารางต่อไปนี้แสดงแอตทริบิวต์ระดับองค์กรที่พร้อมสำหรับการกำหนดค่าองค์กร (Mint) คุณใช้การเรียก 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 ไม่ได้เปิดเผย, ไฮบริด (ค่าเริ่มต้นคือ Null) |
MINT_CURRENCY |
รหัสสกุลเงิน ISO (ค่าเริ่มต้นคือ Null) |
MINT_TAX_NEXUS |
หลักความสัมพันธ์ในการเสียภาษี (ค่าเริ่มต้นคือไม่มีข้อมูล) |
MINT_DEFAULT_PROD_TAX_CATEGORY |
หมวดหมู่ภาษีผลิตภัณฑ์เริ่มต้น (ค่าเริ่มต้นคือไม่มีข้อมูล) |
MINT_IS_GROUP_ORG |
การจัดระเบียบกลุ่ม IS (ค่าเริ่มต้นคือ false) |
MINT_HAS_BROKER |
มีความเสียหาย (ค่าเริ่มต้นคือ false) |
MINT_TIMEZONE |
เขตเวลา (ค่าเริ่มต้นคือ Null) |
MINT_TAX_ENGINE_EXTERNAL_ID |
รหัสเครื่องมือภาษี (ค่าเริ่มต้นคือไม่มีข้อมูล) |
MINT_COUNTRY |
ประเทศขององค์กร (ค่าเริ่มต้นคือ Null) |
MINT_REG_NO |
หมายเลขจดทะเบียนขององค์กรและสหราชอาณาจักรให้หมายเลขที่แตกต่างจากหมายเลขประจำตัวผู้เสียภาษี (ค่าเริ่มต้นคือ null) |
MINT_BILLING_CYCLE_TYPE |
PRORATED, CALENDAR_MONTH (ค่าเริ่มต้นคือ CALENDAR_MONTH) |
MINT_SUPPORTED_BILLING_TYPE |
ชำระเงินล่วงหน้า/ชำระภายหลัง/ทั้งคู่ (ค่าเริ่มต้นคือ "ชำระเงินล่วงหน้า") |
MINT_IS_SEPARATE_INV_FOR_FEES |
ระบุว่าควรสร้างใบแจ้งหนี้ค่าธรรมเนียมแยกต่างหากหรือไม่ (ค่าเริ่มต้นคือ false) |
MINT_ISSUE_NETTING_STMT |
ระบุว่าควรออกคำสั่งสุทธิหรือไม่ (ค่าเริ่มต้นคือ false) |
MINT_NETTING_STMT_PER_CURRENCY |
ระบุว่าควรสร้างใบแจ้งยอดสุทธิต่อสกุลเงินหรือไม่ (ค่าเริ่มต้นคือ false) |
MINT_HAS_SELF_BILLING |
ระบุว่าองค์กรมีการเรียกเก็บเงินด้วยตนเองหรือไม่ (ค่าเริ่มต้นคือ false) |
MINT_SELF_BILLING_FOR_ALL_DEV |
ระบุว่าองค์กรมีการเรียกเก็บเงินด้วยตนเองสำหรับนักพัฒนาแอปทุกรายหรือไม่(ค่าเริ่มต้นคือ false) |
MINT_HAS_SEPARATE_INV_FOR_PROD |
ระบุว่าองค์กรมีใบแจ้งหนี้แยกสำหรับแต่ละผลิตภัณฑ์หรือไม่ (ค่าเริ่มต้นคือ false) |
MINT_HAS_BILLING_ADJUSTMENT |
ระบุว่าองค์กรรองรับการแก้ไขการเรียกเก็บเงินหรือไม่ (ค่าเริ่มต้นคือ false) |
features.isMonetizationEnabled |
ใช้โดย UI การจัดการเพื่อแสดงเมนูการสร้างรายได้โดยเฉพาะ (ค่าเริ่มต้นคือ false) |
ui.config.isOperator |
ใช้โดย UI การจัดการเพื่อแสดงผู้ให้บริการเป็นโอเปอเรเตอร์ต่อองค์กร (ค่าเริ่มต้นคือจริง) |
หากต้องการกำหนดการตั้งค่าองค์กรธุรกิจโดยใช้ UI การจัดการ โปรดดู http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services
หมายเหตุ: หากคุณกำลังใช้ฟีเจอร์ขีดจำกัดของบริการสร้างรายได้และการแจ้งเตือน โปรดแนะนำให้นักพัฒนาแอปแนบนโยบายขีดจำกัดในขั้นตอนพร็อกซีหลังนโยบายการตรวจสอบโทเค็นเพื่อการเข้าถึง
นโยบายขีดจำกัดคือนโยบายที่ชัดเจนซึ่งออกแบบมาให้บล็อกการเรียก API หากมีการใช้งานถึงขีดจำกัดที่กำหนด นโยบายจะตรวจสอบขีดจำกัดทางธุรกิจและจะเพิ่มข้อผิดพลาดหากมีขีดจำกัดที่เกินจากค่าที่กำหนดไว้ นี่เป็นส่วนขยายของนโยบายการเพิ่มข้อผิดพลาด แต่เงื่อนไขได้มาจากตัวแปรธุรกิจ
เทมเพลต UI จะอยู่ใน UI การจัดการสำหรับนักพัฒนาพร็อกซี นักพัฒนาซอฟต์แวร์พร็อกซีควรแนบนโยบาย Mint ในข้อความ เมื่อมีการบังคับใช้นโยบายนี้ ข้อผิดพลาดจะเพิ่มขึ้นโดยมีการตอบสนองของข้อผิดพลาดตามนโยบาย หากตั้งค่า ContinueOnError เป็น "จริง" จะไม่มีการเพิ่มข้อผิดพลาดและตัวแปรโฟลว์ "mint.limitsViolated", "mint.isDevelopersuspended" และ "mint.limitsPolicyError" จะได้รับการตั้งค่าซึ่งสามารถใช้สำหรับการจัดการข้อยกเว้นเพิ่มเติมได้ หากจำเป็น