יצירת ארגון, סביבה ומארח וירטואלי

Edge for Private Cloud גרסה 4.16.05

יצירת ארגון, סביבה ומארח וירטואלי בו-זמנית

לפני שיוצרים שרת proxy ל-API ב-Apigee Edge, צריך ליצור לפחות ארגון אחד, ובכל ארגון, לפחות סביבה אחת ומארח וירטואלי אחד.

בדרך כלל, ארגונים וסביבות נוצרים יחד. כדי לפשט את התהליך, אפשר להשתמש בכלי העזר apigee-provision. מפעילים אותו משורת הפקודה בשרת Edge Management Server:

> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile

קובץ התצורה מכיל:

APIGEE_ADMINPW=adminPword     # If omitted, you are prompted for it.
NEW_USER="y"
USER_NAME=orgAdmin@myCo.com
FIRST_NAME=foo
LAST_NAME=bar
USER_PWD="userPwrod"
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod
VHOST_PORT=9001
VHOST_NAME=default
VHOST_ALIAS="$IP1:9001"
# Optionally configure TLS/SSL for virtual host.
# VHOST_SSL=y     # Set to "y" to enable TLS/SSL on the virtual host.
# KEYSTORE_JAR=   # JAR file containing the cert and private key.
# KEYSTORE_NAME=  # Name of the keystore. 
# KEYSTORE_ALIAS= # The key alias.
# KEY_PASSWORD=   # The key password, if it has one. 
# AXGROUP=axgroup-001 # Default value is axgroup-001 

הפקודה:

• יצירת הארגון
  הערה: לא ניתן לשנות את שם הארגון אחרי שיוצרים אותו.
• שיוך הארגון ל-pod, כברירת מחדל משייך אותו ל-pod "gateway".
• להוסיף את המשתמש שצוין כאדמין הארגון. אם המשתמש לא קיים, אפשר ליצור חשבון.
• יצירה של סביבה אחת או יותר
• יצירת מארח וירטואלי אחד או יותר לכל סביבה
• שיוך הסביבה לכל מעבדי ההודעות
• הפעלת ניתוח נתונים

במאמר הצטרפות לארגון תוכלו לקרוא את כל קובץ התצורה השקט.

כברירת מחדל, האורך המקסימלי של שם הארגון ושם הסביבה הוא 20 תווים כשמשתמשים בכלי apigee-provision. המגבלה הזו לא רלוונטית אם משתמשים ב-Edge API ישירות כדי ליצור את הארגון או את הסביבה.

יצירת ארגון

כדי ליצור ארגון, משתמשים בפקודה create-org:

> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision create-org -f configFile

הסקריפט יוצר את הארגון, אבל לא מוסיף או מגדיר את הסביבות והמארחים הווירטואליים שנדרשים על ידי הארגון כדי לטפל בקריאות ל-API.

קובץ התצורה מכיל את שם הארגון ואת כתובת האימייל של מנהל המערכת בארגון. התווים שאפשר להשתמש בהם במאפיין השם מוגבלים ל: a-z0-9\-$%. אין לכלול רווחים, נקודות או אותיות רישיות בשם:

APIGEE_ADMINPW=adminPword    # If omitted, you are prompted for it.
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ORG_ADMIN=orgAdmin@myCo.com

הפקודה:

• יצירת הארגון
• משייך את הארגון ל-pod, וכברירת מחדל הוא משייך אותו ל-pod "gateway".
• הוספת המשתמש שצוין כאדמין הארגון. המשתמש חייב כבר קיים, אחרת הסקריפט יוצר שגיאה.

<Error>
    <Code>organizations.OrganizationAlreadyExists</Code>
    <Message>Organization : test already exists</Message>
    <Contexts/>
</Error>

יצירת ארגון באמצעות קריאות ל-API

לחלופין, אפשר להשתמש בקריאות הבאות ל-API כדי ליצור ארגון. הקריאה הראשונה יוצרת את הארגון:

curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \
-X POST http://<ms-ip>:8080/v1/organizations \
-d '<Organization name="<org-name>" type="paid"/>'

הקריאה הבאה משייכת את הארגון ל-pod:

curl -H "Content-Type:application/x-www-form-urlencoded" \
-u <sysAdminEmail>:<adminPasswd> -X POST \
http://<ms-ip>:8080/v1/organizations/<org-name>/pods \
-d "region=default&pod=gateway" 

אפשר לבצע את השיחה הזו כמה פעמים כדי לשייך את הארגון לכמה רצפי מודעות.

בקריאה האחרונה יתווסף משתמש קיים שישמש כמנהל הארגון של הארגון:

curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \
-X POST \
http://<ms-ip>:8080/v1/organizations/<org-name>/users/<user-email>/userroles/ \
-d '<Roles><Role name="orgadmin"/></Roles>'

אם המשתמש לא קיים, ניתן להשתמש בקריאה הבאה כדי ליצור את המשתמש, כפי שמתואר בדף 'הוספת משתמש'.

יוצרים סביבה

משתמשים בפקודה add-env כדי ליצור סביבה בארגון קיים:

> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision add-env -f configFile

קובץ התצורה הזה מכיל את המידע הנדרש ליצירת הסביבה והמארח הווירטואלי:

APIGEE_ADMINPW=adminPword    # If omitted, you are prompted for it.
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod
VHOST_PORT=9001
VHOST_NAME=default
VHOST_ALIAS="$IP1:9001"
# Optionally configure TLS/SSL for virtual host.
# VHOST_SSL=y     # Set to "y" to enable TLS/SSL on the virtual host.
# KEYSTORE_JAR=   # JAR file containing the cert and private key.
# KEYSTORE_NAME=  # Name of the keystore. 
# KEYSTORE_ALIAS= # The key alias.
# KEY_PASSWORD=   # The key password, if it has one. 
# AXGROUP=axgroup-001 # Default value is axgroup-001

הפקודה:

• יוצר את הסביבה
• יוצר מארח וירטואלי יחיד עבור הסביבה
• משייכת את הסביבה לכל מעבדי ההודעות ב-pod שמשויך לארגון שמכיל את הסביבה.
• הפעלת ניתוח נתונים
  הערה: אם מפעילים את ניתוח הנתונים בסביבה אחת בארגון, צריך להפעיל את ניתוח הנתונים בכל הסביבות בארגון.

יצירת סביבה באמצעות קריאות ל-API

לחלופין, אפשר להשתמש בקריאות הבאות ל-API כדי ליצור סביבה. הקריאה הראשונה יוצרת את הסביבה:

curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \
-X POST http://<ms-ip>:8080/v1/organizations/<org-name>/environments \
-d  '<Environment name="<env-name>"/>' 

הקריאה הבאה משייכת את הסביבה למעבד הודעות. מבצעים את הקריאה הזו לכל מעבד הודעות שרוצים לשייך לסביבה:

curl -H "Content-Type:application/x-www-form-urlencoded" \
-u <sysAdminEmail>:<adminPasswd> -X POST \
http://<ms-ip>:8080/v1/organizations/<org-name>/environments/<env-name>/servers \
-d "action=add&uuid=<uuid>"

כאשר "<uuid>" הוא מזהה ה-UUID של מעבד ההודעות. כדי למצוא את ה-UUID, משתמשים בפקודה:

> curl http://<mp-ip>:8082/v1/servers/self

כאשר "<mp-ip>" הוא כתובת ה-IP של מעבד ההודעות.

הקריאה הבאה ל-API מפעילה את Analytics בסביבה נתונה. האימות מאמת את הקיום של שרתי Qpid ו-Postgres ב-POD של כל מרכזי הנתונים. לאחר מכן הוא מתחיל את תהליך ההצטרפות של Analytics לארגון ולסביבה שצוינו.

> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision enable-ax -f configFile

קובץ התצורה הזה מכיל:

ORG_NAME=orgName  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=envName

curl -H "Content-Type:application/json" -u <sysAdminEmail>:<adminPasswd> 
-X POST http://<ms-ip>:8080/v1/organizations/<org-name>/environments/<env-name>/analytics/admin -d "@sample.json"

כאשר sample.json מכיל רשומות לתחילת העבודה ב-Analytics. כדי לקבל את קובץ ה-JSON, יש לפנות לתמיכה של Apigee.

יצירת מארח וירטואלי

אפשר ליצור מארח וירטואלי בסביבה קיימת בארגון. לעיתים קרובות סביבה תומכת במספר מארחים וירטואליים. לדוגמה, יכול להיות שמארח וירטואלי אחד יתמוך בפרוטוקול HTTP, ומארח וירטואלי אחר שנמצא באותה סביבה תומך בפרוטוקול HTTPS מוצפן.

אפשר להשתמש בקריאה הבאה ל-API כדי ליצור מארחים וירטואליים נוספים או כדי ליצור מארח וירטואלי לסביבה ללא מארח וירטואלי:

curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \
-X POST \
http://<ms-ip>:8080/v1/organizations/<org-name>/environments/<env-name>/virtualhosts \
-d '<VirtualHost name="default"> \
    <HostAliases> \
      <HostAlias>myorg-test.apigee.net</HostAlias> \ 
    </HostAliases> \
    <Interfaces/> \
    <Port>443</Port> \
  </VirtualHost>' 

http://apigee.com/docs/api-services/content/creating-virtual-host אפשר לקרוא תיאור מלא של יצירת מארח וירטואלי, כולל יצירת מארח וירטואלי מאובטח שמשתמש ב-TLS/SSL ב-HTTPS.