REST Resource: projects.locations.fleetPackages

משאב: FleetPackage

משאב FleetPackage ב-Config Delivery API.

FleetPackage מגדיר חבילה שדרכה פורסים את ההגדרות של Kubernetes בצי של אשכולות Kubernetes.

ייצוג ב-JSON
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "resourceBundleSelector": {
    object (ResourceBundleSelector)
  },
  "target": {
    object (Target)
  },
  "rolloutStrategy": {
    object (RolloutStrategy)
  },
  "variantSelector": {
    object (VariantSelector)
  },
  "info": {
    object (FleetPackageInfo)
  },
  "deletionPropagationPolicy": enum (DeletionPropagationPolicy),
  "state": enum (State)
}
שדות
name

string

מזהה. שם הFleetPackage. הפורמט הוא projects/{project}/locations/{location}/fleetPackages/{fleetPackage}. הרכיב fleetPackage חייב להתאים ל-[a-z][a-z0-9\-]{0,62}

createTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצר ה-FleetPackage.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

פלט בלבד. המועד האחרון שבו FleetPackage עודכן.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

זה שינוי אופציונלי. תוויות הן מאפיינים שאפשר להגדיר ולהשתמש בהם גם על ידי המשתמש וגם על ידי Config Delivery. התוויות צריכות לעמוד במגבלות הבאות:

  • המפתחות והערכים יכולים להכיל רק אותיות קטנות, ספרות, קווים תחתונים ומקפים.
  • כל התווים צריכים להיות בקידוד UTF-8, ואפשר להשתמש בתווים בינלאומיים.
  • המפתחות צריכים להתחיל באות קטנה או בתו בינלאומי.
  • כל משאב מוגבל ל-64 תוויות לכל היותר.

גם המפתחות וגם הערכים מוגבלים ל-‎ <= 128 בייטים.

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resourceBundleSelector

object (ResourceBundleSelector)

חובה. מידע שמציין את המקור של הגדרת Kubernetes לפריסה.

target

object (Target)

זה שינוי אופציונלי. הגדרה לבחירת אשכולות יעד לפריסת הגדרת Kubernetes.

rolloutStrategy

object (RolloutStrategy)

זה שינוי אופציונלי. השיטה לפריסת הגדרות Kubernetes באשכולות.

variantSelector

object (VariantSelector)

חובה. מידע שמציין איך למפות וריאנט של ResourceBundle לאשכול יעד.

info

object (FleetPackageInfo)

פלט בלבד. מידע על סטטוס ההשקה של FleetPackage בכל אשכולות היעד.

deletionPropagationPolicy

enum (DeletionPropagationPolicy)

זה שינוי אופציונלי. מידע על הטיפול במשאבים ב-Kubernetes באשכולות היעד כשמוחקים את FleetPackage.

state

enum (State)

זה שינוי אופציונלי. המצב הרצוי של חבילת ה-Fleet.

ResourceBundleSelector

מידע שמציין את המקור של הגדרת Kubernetes לפריסה.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "resourceBundle": {
    object (ResourceBundleTag)
  },
  "cloudBuildRepository": {
    object (CloudBuildRepository)
  }
  // End of mutually exclusive fields.
}
שדות
המקור יכול להיות ResourceBundle או CloudBuildRepository שנדחפו ישירות ומכילים את ההגדרות של Kubernetes. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
resourceBundle

object (ResourceBundleTag)

מידע שמציין את ResourceBundle.

cloudBuildRepository

object (CloudBuildRepository)

מידע שמציין את CloudBuildRepository.

סוף השדות שמוציאים זה את זה.

ResourceBundleTag

התג ResourceBundleTag מכיל את המידע שמתייחס לפריט תוכן של ResourceBundle.

ייצוג ב-JSON
{
  "name": string,
  "tag": string
}
שדות
name

string

חובה. שם הResourceBundle. הפורמט הוא projects/{p}/locations/{l}/resourceBundles/{r}.

tag

string

חובה. תג Git לגרסה של פריט התוכן ב-ResourceBundle. התג חייב להיות בפורמט הסמנטי לניהול גרסאות vX.Y.Z.

CloudBuildRepository

‫CloudBuildRepository מכיל מידע על אחזור הגדרות של Kubernetes מ-CloudBuildRepository.

ייצוג ב-JSON
{
  "name": string,
  "path": string,
  "tag": string,
  "serviceAccount": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "variantsPattern": string
  // End of mutually exclusive fields.
}
שדות
name

string

חובה. שם המאגר של Cloud Build. הפורמט הוא projects/{p}/locations/{l}/connections/{c}/repositories/{r}.

path

string

זה שינוי אופציונלי. הנתיב לספרייה או לקובץ במאגר שמכיל את ההגדרות של Kubernetes. אם לא מציינים נתיב, המערכת מניחה שהנתיב הוא תיקיית השורש ברמה העליונה של המאגר.

tag

string

חובה. תג Git של מאגר ה-Git הבסיסי. תג ה-Git חייב להיות בפורמט של גרסה סמנטית vX.Y.Z.

serviceAccount

string

חובה. חשבון שירות של Google לשימוש בטריגרים של CloudBuild כדי לאחזר ולאחסן הגדרות של Kubernetes.

מציינת את ההגדרות למציאת וריאציות במאגר. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
variantsPattern

string

זה שינוי אופציונלי. תבנית Glob שתשמש למציאת וריאנטים במאגר. דוגמאות: variants/*.yaml, us-*

סוף השדות שמוציאים זה את זה.

יעד

היעד מגדיר דרכים שונות לטרגט קבוצה של אשכולות Kubernetes.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fleet": {
    object (Fleet)
  }
  // End of mutually exclusive fields.
}
שדות
היעד של חבילת הצי. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
fleet

object (Fleet)

פרטי הצי ב-GKE כדי לטרגט את ההשקה של FleetPackage.

סוף השדות שמוציאים זה את זה.

Fleet

הצי שבו צריך לפרוס את FleetPackage.

ייצוג ב-JSON
{
  "project": string,
  "selector": {
    object (LabelSelector)
  }
}
שדות
project

string

חובה. הפרויקט המארח של ה-fleet ב-GKE. הפורמט הוא projects/{project}.

selector

object (LabelSelector)

זה שינוי אופציונלי. הבורר מאפשר לטרגט קבוצת משנה של חברים בצי באמצעות התוויות שלהם.

LabelSelector

בורר תוויות הוא שאילתת תוויות על קבוצת משאבים. בורר תוויות ריק תואם לכל האובייקטים.

ייצוג ב-JSON
{
  "matchLabels": {
    string: string,
    ...
  }
}
שדות
matchLabels

map (key: string, value: string)

זה שינוי אופציונלי. מפה של צמדי {מפתח,ערך}. כל צמד {key,value} חייב להתאים בדיוק למפתח ולערך של תווית קיימת כדי שההתאמה תתקיים.

אובייקט שמכיל רשימה של צמדי "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

VariantSelector

‫VariantSelector מכיל מידע לבחירת וריאנט ב-ResourceBundle לפריסה באשכול יעד.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "variantNameTemplate": string
  // End of mutually exclusive fields.
}
שדות
אסטרטגיה לבחירת וריאנט. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
variantNameTemplate

string

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

המשתנים הזמינים הם ${membership.name},‏ ${membership.location},‏ ${membership.project} ו-${membership.labels['label_name']}.

אם רוצים לפרוס וריאנט ספציפי, למשל "default" לכל האשכולות, אפשר להשתמש ב-"default" (מחרוזת ללא משתנים) בתור variantNameTemplate.

סוף השדות שמוציאים זה את זה.

FleetPackageInfo

‫FleetPackageInfo מייצג את הסטטוס של FleetPackage בכל אשכולות היעד.

ייצוג ב-JSON
{
  "activeRollout": string,
  "lastCompletedRollout": string,
  "state": enum (State),
  "errors": [
    {
      object (FleetPackageError)
    }
  ]
}
שדות
activeRollout

string

זה שינוי אופציונלי. ההשקה הפעילה, אם יש כזו. הפורמט הוא projects/{project}/locations/{location}/fleetPackages/{fleetPackage}/rollouts/{rollout}.

lastCompletedRollout

string

זה שינוי אופציונלי. ההשקה האחרונה שהושלמה, אם יש כזו. הפורמט הוא projects/{project}/locations/{location}/fleetPackages/{fleetPackage}/rollouts/{rollout}.

state

enum (State)

זה שינוי אופציונלי. פלט בלבד. המצב הנוכחי של FleetPackage.

errors[]

object (FleetPackageError)

זה שינוי אופציונלי. פלט בלבד. שגיאות שנתקלתם בהן במהלך פריסת ההגדרות (אם יש כאלה).

מדינה

ערכים אפשריים למצב FleetPackage.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב לא מוגדר.
ACTIVE ‫FleetPackage פעיל.
SUSPENDED המינוי ל-FleetPackage מושעה.
FAILED ההתאמה של FleetPackage נכשלה.
DELETING מתבצעת מחיקה של FleetPackage.

FleetPackageError

מידע שמייצג שגיאה שקרתה במהלך השקת ההגדרות.

ייצוג ב-JSON
{
  "errorMessage": string
}
שדות
errorMessage

string

זה שינוי אופציונלי. תיאור של השגיאה.

מדינה

השדה State מציין את המצב הרצוי של חבילת הצי. ערך לא מוגדר שווה ערך ל-ACTIVE. אם המצב מוגדר כ-SUSPENDED, ההשקה הפעילה (אם יש כזו) תימשך, אבל לא יתוזמנו השקות חדשות.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב לא מוגדר.
ACTIVE השדה FleetPackage אמור להיות פעיל.
SUSPENDED המינוי ל-FleetPackage מיועד להשעיה.

Methods

create

יצירת FleetPackage חדש בפרויקט ובמיקום נתונים.

delete

מחיקה של FleetPackage יחיד.

get

אחזור פרטים של FleetPackage יחיד.

list

הצגת רשימה של FleetPackages במיקום ובפרויקט נתונים.

patch

עדכון הפרמטרים של FleetPackage יחיד.