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