apiVersion: apiextensions.k8s.io/v1
import "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
CustomResourceDefinition представляє ресурс, який повинен бути доступний на API-сервері. Його імʼя МАЄ бути у форматі <.spec.name>.<.spec.group>.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | metadata визначає стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
spec *CustomResourceDefinitionSpec | spec describes how the user wants the resources to appear |
statusCustomResourceDefinitionStatus | status визначає фактичний стан CustomResourceDefinition |
CustomResourceDefinitionSpec описує, як користувач хоче, щоб його ресурс виглядав
| Поле | Опис |
|---|---|
conversionCustomResourceConversion | conversion визначає налаштування конверсії для CRD. |
group *string | group є API групою визначеного власного ресурсу. Власні ресурси обслуговуються як /apis/\. Повинно відповідати імені CustomResourceDefinition (у формі \). |
names *CustomResourceDefinitionNames | names визначає імена ресурсу та типи для власного ресурсу. |
preserveUnknownFieldsboolean | preserveUnknownFields показує як поля обʼєкта, які не вказані в схемі OpenAPI, повинні зберігатися при збереженні в сховище. apiVersion, kind, metadata та відомі поля всередині metadata завжди зберігаються. Це поле визнане застарілим на користь встановлення x-preserve-unknown-fields в true в spec.versions[*].schema.openAPIV3Schema. Деталі див. на https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning. |
scope *string | scope показує, чи визначений власний ресурс є кластерним або просторово обмеженим. Дозволені значення: Cluster та Namespaced. |
versions *CustomResourceDefinitionVersion array | versions є списком усіх версій API визначеного власного ресурсу. Імена версій використовуються для обчислення порядку, у якому обслуговувані версії відображаються в API discovery. Якщо рядок версії є "kube-подібний", він буде сортуватися вище за не "kube-подібні" рядки версій, які впорядковуються лексикографічно. "Kube-подібні" версії починаються з "v", потім слідує число (основна версія), потім необовʼязково рядок "alpha" або "beta" і ще одне число (додаткова версія). Вони сортуються спочатку за GA > beta > alpha (де GA — це версія без суфікса, такого як beta або alpha), а потім за порівнянням основної версії, потім додаткової версії. Приклад відсортованого списку версій: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
CustomResourceDefinitionStatus показує стан CustomResourceDefinition
| Поле | Опис |
|---|---|
acceptedNamesCustomResourceDefinitionNames | acceptedNames є іменами, які фактично використовуються для обслуговування discovery. Вони можуть відрізнятися від імен у spec. |
conditionsCustomResourceDefinitionCondition array | conditions показують стан для конкретних аспектів CustomResourceDefinition |
observedGenerationinteger | observedGeneration показує покоління, яке спостерігає контролер CRD. |
storedVersionsstring array | storedVersions містить усі версії CustomResources, які коли-небудь зберігалися. Відстеження цих версій дозволяє створити шлях міграції для збережених версій у etcd. Поле є змінним, щоб контролер міграції міг завершити міграцію на іншу версію (забезпечуючи, що старі обʼєкти не залишаються в сховищі), а потім видалити решту версій із цього списку. Версії не можуть бути видалені з spec.versions, поки вони існують у цьому списку. |
CustomResourceDefinitionList є списком CustomResourceDefinition objects.
| Поле | Опис |
|---|---|
apiVersionstring | APIVersion визначає версію схеми цього представлення обʼєкта. Сервери повинні конвертувати розпізнані схеми до останнього внутрішнього значення і можуть відхиляти нерозпізнані значення. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
items *CustomResourceDefinition array | items містить окремі обʼєкти CustomResourceDefinition |
kindstring | Kind визначає тип REST-ресурсу, який представляє цей обʼєкт. Сервери можуть визначати це з точки доступу, до якої клієнт надсилає запити. Не може бути оновлено. У CamelCase. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | metadata визначає стандартні метадані обʼєкта. Детальніше: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
CustomResourceColumnDefinition specifies a column for server side printing.
| Поле | Опис |
|---|---|
descriptionstring | description є зрозумілим для людини описом цього стовпця. |
formatstring | format є необовʼязковим визначенням типу OpenAPI для цього стовпця. Формат 'name' застосовується до основного стовпця ідентифікатора, щоб допомогти клієнтам визначити, що стовпець є імʼям ресурсу. Детальніше: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types. |
jsonPath *string | jsonPath є простим шляхом JSON (тобто з нотацією масиву), який оцінюється для кожного користувацького ресурсу, щоб отримати значення для цього стовпця. |
name *string | name є зрозумілим для людини імʼям цього стовпця. |
priorityinteger | priority є цілим числом, що визначає відносну важливість цього стовпця порівняно з іншими. Менші числа вважаються більш пріоритетними. Стовпці, які можуть бути опущені в умовах обмеженого простору, повинні мати пріоритет більше 0. |
type *string | type є визначенням типу OpenAPI для цього стовпця. Детальніше: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types. |
CustomResourceConversion описує, як конвертувати різні версії CR.
| Поле | Опис |
|---|---|
strategy *string | strategy визначає, як конвертувати власні ресурси між версіями. Дозволені значення:
|
webhookWebhookConversion | webhook описує, як викликати вебхук для конвертації. Потрібно, коли strategy встановлено на "Webhook". |
CustomResourceDefinitionCondition містить деталі поточного стану цього пода.
| Поле | Опис |
|---|---|
lastTransitionTimeTime | lastTransitionTime — це останній час, коли стан перейшов з одного стану в інший. |
messagestring | message — це повідомлення, зрозуміле людині, яке вказує деталі щодо переходу. Це може бути порожній рядок. |
observedGenerationinteger | observedGeneration представляє .metadata.generation, на основі якого була встановлено стан. Наприклад, якщо .metadata.generation наразі 12, але .status.conditions[x].observedGeneration дорівнює 9, стан застарів щодо поточного стану екземпляра. |
reasonstring | reason є унікальним, однослівним описом у форматі CamelCase, що пояснює причину останнього переходу стану |
status *string | status є станом статусу. Може бути True, False, Unknown. |
type *string | type є типом стану. Типи включають Established, NamesAccepted та Terminating. |
CustomResourceDefinitionNames вказує імена для обслуговування цього CustomResourceDefinition
| Поле | Опис |
|---|---|
categoriesstring array | categories є списком згрупованих ресурсів, до яких належить цей власний ресурс (наприклад, 'all'). Публікується в документах відкриття API і використовується клієнтами для підтримки викликів, таких як kubectl get all. |
kind *string | kind є серіалізованим типом ресурсу. Зазвичай він у форматі CamelCase і в однині. Екземпляри власного ресурсу використовуватимуть це значення як атрибут kind у викликах API. |
listKindstring | listKind є серіалізованим типом списку для цього ресурсу. Зазвичай "kindList". |
plural *string | plural є назвою ресурсу у множині для обслуговування. Власні ресурси обслуговуються за адресою /apis/\. Має відповідати назві CustomResourceDefinition (у формі \). Все має бути літерами нижнього регістру. |
shortNamesstring array | shortNames є короткими іменами для ресурсу, які публікуються в документах відкриття API і використовуються клієнтами для підтримки викликів, таких як kubectl get \. Все має бути літерами нижнього регістру. |
singularstring | singular є одниною назви ресурсу. Все має бути літерами нижнього регістру. Стандартно використовується нижній регістр kind. |
CustomResourceDefinitionVersion описує версію для CRD.
| Поле | Опис |
|---|---|
additionalPrinterColumnsCustomResourceColumnDefinition array | additionalPrinterColumns вказує додаткові стовпці, які повертаються у виводі таблиці. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables для деталей. Якщо стовпці не вказані, використовується один стовпець, що відображає вік власного ресурсу. |
deprecatedboolean | deprecated вказує, що ця версія API власного ресурсу застаріла. Якщо встановлено значення true, запити до цієї версії отримують заголовок попередження у відповіді сервера. Стандартно — false. |
deprecationWarningstring | deprecationWarning перевизначає стандартне попередження, яке повертається клієнтам API. Може бути встановлено лише тоді, коли deprecated дорівнює true. Стандартне попередження вказує, що ця версія застаріла, і рекомендує використовувати найновішу обслуговувану версію з рівною або більшою стабільністю, якщо така існує. |
name *string | name є назвою версії, наприклад “v1”, “v2beta1” тощо. Власні ресурси обслуговуються під цією версією за адресою /apis/\, якщо served дорівнює true. |
schemaCustomResourceValidation | schema описує схему, яка використовується для валідації, обрізання та встановлення стандартних значень для цієї версії власного ресурсу. |
selectableFieldsSelectableField array | selectableFields вказує шляхи до полів, які можуть використовуватися як селектори полів. Дозволяється максимум 8 вибіркових полів. Див. документаціюhttps://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors | .
served *boolean | served є прапорцем, який дозволяє або забороняє обслуговування цієї версії через REST API |
storage *boolean | storage вказує, що ця версія повинна використовуватися при збереженні власних ресурсів у сховищі. Має бути рівно одна версія з storage=true. |
subresourcesCustomResourceSubresources | subresources вказує, які субресурси має ця версія визначеного власного ресурсу. |
CustomResourceSubresourceScale визначає, як обслуговувати субресурс scale для власних ресурсів.
| Поле | Опис |
|---|---|
labelSelectorPathstring | labelSelectorPath визначає шлях JSON всередині власного ресурсу, який відповідає Scale status.selector. Дозволяються лише шляхи JSON без нотації масиву. Має бути шлях JSON під .status або .spec. Має бути встановлено для роботи з HorizontalPodAutoscaler. Поле, на яке вказує цей шлях JSON, має бути рядковим полем (не складною структурою селектора), яке містить серіалізований селектор міток у вигляді рядка. Більше інформації: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource Якщо під заданим шляхом у власному ресурсі немає значення, значення status.selector у субресурсі /scale за замовчуванням буде порожнім рядком. |
specReplicasPath *string | specReplicasPath визначає шлях JSON всередині власного ресурсу, який відповідає Scale spec.replicas. Дозволяються лише шляхи JSON без нотації масиву. Має бути шлях JSON під .spec. Якщо під заданим шляхом у власному ресурсі немає значення, субресурс /scale поверне помилку при GET. |
statusReplicasPath *string | statusReplicasPath визначає шлях JSON всередині власного ресурсу, який відповідає Scale status.replicas. Дозволяються лише шляхи JSON без нотації масиву. Має бути шлях JSON під .status. Якщо під заданим шляхом у власному ресурсі немає значення, значення status.replicas у підресурсі /scale за замовчуванням буде 0. |
CustomResourceSubresourceStatus визначає, як обслуговувати субресурс статусу для власних ресурсів. Статус представлений шляхом JSON .status всередині власного ресурсу. Коли встановлено, * відкриває субресурс /status для власного ресурсу * PUT-запити до субресурсу /status приймають обʼєкт власного ресурсу і ігнорують зміни всього, крім секції статусу * PUT/POST/PATCH-запити до власного ресурсу ігнорують зміни секції статусу
CustomResourceSubresources визначає, як обслуговувати субресурси статусу та масштабу для власних ресурсів.
| Поле | Опис |
|---|---|
scaleCustomResourceSubresourceScale | scale вказує, що власний ресурс повинен обслуговувати субресурс /scale, який повертає обʼєкт autoscaling/v1 Scale. |
statusCustomResourceSubresourceStatus | status вказує, що власний ресурс повинен обслуговувати субресурс /status. Коли увімкнено:
|
CustomResourceValidation є списком методів валідації для власних ресурсів.
| Поле | Опис |
|---|---|
openAPIV3SchemaJSONSchemaProps | openAPIV3Schema є схемою OpenAPI v3, яка використовується для валідації та обрізання. |
ExternalDocumentation дозволяє посилатися на зовнішній ресурс для розширеної документації.
| Поле | Опис |
|---|---|
descriptionstring | |
urlstring |
JSON представляє будь-яке дійсне значення JSON. Підтримуються такі типи: bool, int64, float64, string, []interface{}, map[string]interface{} та nil.
JSONSchemaProps є JSON-схемою, що відповідає Specification Draft 4 (http://json-schema.org/).
| Поле | Опис |
|---|---|
$refstring | |
$schemastring | |
additionalItemsJSONSchemaPropsOrBool | |
additionalPropertiesJSONSchemaPropsOrBool | |
allOfJSONSchemaProps array | |
anyOfJSONSchemaProps array | |
defaultJSON | default є стандартним значенням для невизначених полів обʼєкта. Defaulting є бета-функцією під керуванням функціональної можливості CustomResourceDefaulting. Defaulting вимагає, щоб spec.preserveUnknownFields було false. |
definitionsobject | |
dependenciesobject | |
descriptionstring | |
enumJSON array | |
exampleJSON | |
exclusiveMaximumboolean | |
exclusiveMinimumboolean | |
externalDocsExternalDocumentation | |
formatstring | format є рядком формату OpenAPI v3. Невідомі формати ігноруються. Наступні формати перевіряються:
|
idstring | |
itemsJSONSchemaPropsOrArray | |
maxItemsinteger | |
maxLengthinteger | |
maxPropertiesinteger | |
maximumnumber | |
minItemsinteger | |
minLengthinteger | |
minPropertiesinteger | |
minimumnumber | |
multipleOfnumber | |
notJSONSchemaProps | |
nullableboolean | |
oneOfJSONSchemaProps array | |
patternstring | |
patternPropertiesobject | |
propertiesobject | |
requiredstring array | |
titlestring | |
typestring | |
uniqueItemsboolean | |
x-kubernetes-embedded-resourceboolean | x-kubernetes-embedded-resource визнає, що значення є вбудованим Kubernetes runtime.Object, з TypeMeta та ObjectMeta. Тип повинен бути object. Дозволяється додатково обмежувати вбудований обʼєкт. kind, apiVersion та metadata перевіряються автоматично. x-kubernetes-preserve-unknown-fields дозволяється встановлювати в true, але не обовʼязково, якщо обʼєкт повністю визначений (до kind, apiVersion, metadata). |
x-kubernetes-int-or-stringboolean | x-kubernetes-int-or-string визначає, що це значення є або цілим числом, або рядком. Якщо це true, дозволяється порожній тип, і тип як дочірній елемент anyOf дозволяється, якщо дотримано один із наступних шаблонів:
|
x-kubernetes-list-map-keysstring array | x-kubernetes-list-map-keys додає анотацію до масиву з типом x-kubernetes-list-type map, вказуючи ключі, що використовуються як індекси мапи. Цей тег ПОВИНЕН використовуватися лише для списків, у яких для розширення "x-kubernetes-list-type" встановлено значення "map". Крім того, значення, вказані для цього атрибута, повинні бути полем скалярного типу дочірньої структури (вкладеність не підтримується). Вказані властивості повинні бути обов’язковими або мати стандартне значення, щоб гарантувати їх наявність для всіх елементів списку. |
x-kubernetes-list-typestring | x-kubernetes-list-type додає анотацію до масиву, щоб детальніше описати його топологію. Це розширення повинно використовуватися лише для списків і може мати 3 можливі значення:
|
x-kubernetes-map-typestring | x-kubernetes-map-type додає анотацію до обʼєкта, щоб детальніше описати його топологію. Це розширення повинно використовуватися лише тоді, коли тип обʼєкта є object, і може мати 2 можливі значення:
|
x-kubernetes-preserve-unknown-fieldsboolean | x-kubernetes-preserve-unknown-fields зупиняє крок декодування API-сервера від обрізання полів, які не вказані в схемі валідації. Це впливає на поля рекурсивно, але повертає нормальну поведінку обрізання, якщо в схемі вказані вкладені властивості або additionalProperties. Може бути true або undefined. False заборонено. |
x-kubernetes-validationsValidationRule array patch strategy: злиття за ключем rule | x-kubernetes-validations описує список правил валідації, написаних мовою виразів CEL. |
JSONSchemaPropsOrArray представляє значення, яке може бути або JSONSchemaProps, або масивом JSONSchemaProps. В основному використовується для цілей серіалізації.
JSONSchemaPropsOrBool представляє JSONSchemaProps або булеве значення. За замовчуванням для булевого властивості встановлено true.
SelectableField вказує шлях JSON до поля, яке може використовуватися з селекторами полів.
| Поле | Опис |
|---|---|
jsonPath *string | jsonPath — це простий JSON шлях, який оцінюється для кожного власного ресурсу, щоб отримати значення селектора поля. Дозволені лише JSON шляхи без нотації масиву. Повинен вказувати на поле типу string, boolean або integer. Дозволені типи з enum значеннями та рядки з форматами. Якщо jsonPath посилається на відсутнє поле в ресурсі, jsonPath оцінюється як порожній рядок. Не повинен вказувати на поля метаданих. Обовʼязково. |
ServiceReference містить посилання на Service.legacy.k8s.io
| Поле | Опис |
|---|---|
name *string | name — це імʼя сервісу. Обовʼязково. |
namespace *string | namespace — це простір імен сервісу. Обовʼязково. |
pathstring | path — це необовʼязковий URL шлях, за яким буде звертатися вебхук. |
portinteger | port — це необовʼязковий порт сервісу, за яким буде звертатися вебхук. port повинен бути дійсним номером порту (1-65535, включно). Стандартно використовується 443 для зворотної сумісності. |
ValidationRule описує правило валідації, написане мовою виразів CEL.
| Поле | Опис |
|---|---|
fieldPathstring | fieldPath представляє шлях до поля, який повертається, коли валідація не проходить. Він повинен бути відносним JSON шляхом (тобто з нотацією масиву), обмеженим до місця розташування цього розширення x-kubernetes-validations у схемі, і посилатися на наявне поле. Наприклад, коли валідація перевіряє, чи конкретний атрибут foo присутній у мапі testMap, fieldPath може бути встановлений на .testMap.foo. Якщо перевірка передбачає, що два списки повинні містити унікальні атрибути, для параметра fieldPath можна вказати будь-який із цих списків: наприклад, .testList. Не підтримує числовий індекс списку. Підтримує операцію дочірнього елемента для посилання на наявне поле. Див. Підтримка JSONPath у Kubernetes для отримання додаткової інформації. Числовий індекс масиву не підтримується. Для імен полів, які містять спеціальні символи, використовуйте ['specialName'] для посилання на імʼя поля. Наприклад, для атрибута foo.34$, який зʼявляється у списку testList, fieldPath може бути встановлений на .testList['foo.34$'] |
messagestring | Message представляє повідомлення, яке показується, коли валідація не проходить. Повідомлення є обовʼязковим, якщо правило містить розриви рядків. Повідомлення не повинно містити розриви рядків. Якщо не встановлено, повідомлення буде "failed rule: {Rule}". Наприклад: "must be a URL with the host matching spec.host" |
messageExpressionstring | MessageExpression оголошує вираз CEL, який оцінюється як повідомлення про помилку валідації, що повертається, коли це правило не проходить. Оскільки messageExpression використовується як повідомлення про помилку, воно повинно оцінюватися як рядок. Якщо обидва поля message і messageExpression присутні в правилі, то messageExpression буде використано у разі невдачі валідації. Якщо messageExpression призводить до помилки виконання, помилка виконання реєструється, а повідомлення про помилку валідації генерується так, ніби поле messageExpression не встановлено. Якщо messageExpression оцінюється як порожній рядок, рядок, що містить лише пробіли, або рядок, що містить розриви рядків, то повідомлення про помилку валідації також генерується так, ніби поле messageExpression не встановлено, і факт, що messageExpression призвело до порожнього рядка/рядка з лише пробілами/рядка з розривами рядків, буде зареєстровано. messageExpression має доступ до всіх тих самих змінних, що й правило; єдина різниця — тип, що повертається. Приклад: "x must be less than max ("+string(self.max)+")" |
optionalOldSelfboolean | optionalOldSelf використовується для включення правила переходу в обчислення навіть під час першого створення об’єкта або якщо старий об’єкт не містить значення. Якщо ця опція увімкнена, oldSelf буде опціональним елементом CEL, значення якого дорівнюватиме None, якщо старе значення відсутнє або якщо об’єкт створюється вперше. Ви можете перевірити наявність oldSelf за допомогою oldSelf.hasValue() і розпакувати його після перевірки за допомогою oldSelf.value(). Докладнішу інформацію дивіться в документації CEL щодо типів Optional: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypes Не може бути встановлено, якщо oldSelf не використовується в rule. |
reasonstring | reason надає придатну для машинного зчитування причину помилки перевірки, яка повертається абоненту, коли запит не відповідає цьому правилу перевірки. Код статусу HTTP, що повертається абоненту, відповідатиме причині першого правила перевірки, яке не пройшло перевірку. Наразі підтримуються такі причини: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". Якщо цей параметр не вказано, за замовчуванням використовується "FieldValueInvalid". Усі причини, додані в майбутньому, повинні бути прийняті клієнтами під час зчитування цього значення, а невідомі причини слід розглядати як FieldValueInvalid. Можливі значення enum:
|
rule *string | Rule представляє вираз, який буде оцінюватися за допомогою CEL. Ref: https://github.com/google/cel-spec. Rule поширюється на місце розташування розширення x-kubernetes-validations у схемі. Змінна self у виразі CEL привʼязана до значення, визначеного в цій області.Наприклад правило, яке поширюється на корінь ресурсу з субресурсом статусу: {"rule": "self.status.actual \<= self.spec.maxDesired"}Якщо правило поширюється на обʼєкт з властивостями, доступні властивості обʼєкта можна вибирати за допомогою self.field, а наявність поля можна перевірити за допомогою has(self.field). Поля зі значенням null вважаються відсутніми в виразах CEL.Якщо правило поширюється на обʼєкт з додатковими властивостями (тобто на мапу), значення мапи доступні через self[mapKey], наявність ключа в мапі можна перевірити через mapKey in self, а всі записи мапи доступні через макроси та функції CEL, такі як self.all(...).Якщо правило поширюється на масив, елементи масиву доступні через self[i] і також через макроси та функції.Якщо правило поширюється на скалярне значення, self привʼязане до скалярного значення.Приклади:
apiVersion, kind, metadata.name та metadata.generateName завжди доступні з кореня обʼєкта та з будь-яких обʼєктів, анотованих як x-kubernetes-embedded-resource. Жодні інші властивості метаданих недоступні.Невідомі дані, збережені у власних ресурсах через x-kubernetes-preserve-unknown-fields, недоступні у виразах CEL. Це включає:
[a-zA-Z_.-/][a-zA-Z0-9_.-/]* доступні.Доступні імена властивостей екрануються відповідно до наступних правил при доступі у виразі:
"true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return".Приклади:
'set' або 'map' ігнорує порядок елементів, тобто [1, 2] == [2, 1].Конкатенація масивів з x-kubernetes-list-type використовує семантику типу списку:
rule використовує змінну oldSelf, вона неявно є transition rule.Стандартно змінна oldSelf має той самий тип, що й self. Коли optionalOldSelf встановлено в true, змінна oldSelf є CEL optional змінною, значення якої value() має той самий тип, що й self. Див. документацію для поля optionalOldSelf для деталей.Правила переходу стандартно застосовуються лише до запитів UPDATE і пропускаються, якщо старе значення не знайдено. Ви можете зробити правило переходу безумовним, встановивши optionalOldSelf в true. |
WebhookClientConfig містить інформацію для встановлення TLS-зʼєднання з вебхуком.
| Поле | Опис |
|---|---|
caBundlestring | caBundle є PEM закодованим CA-пакунком, який буде використаний для перевірки сертифіката сервера вебхука. Якщо не вказано, використовуються системні кореневі довірчі сертифікати на apiserver. |
serviceServiceReference | service є посиланням на сервіс для цього вебхука. Має бути вказано або service, або url. Якщо вебхук працює всередині кластера, слід використовувати service. |
urlstring | url дає місцезнаходження вебхука у стандартній формі URL (scheme://host:port/path). Має бути вказано лише одне з полів url або service. Поле host не повинно посилатися на сервіс, що працює в кластері; замість цього слід використовувати поле service. Хост може бути визначений через зовнішній DNS в деяких apiserver (наприклад, kube-apiserver не може визначати внутрішній DNS кластера, оскільки це порушило б шарову архітектуру). host також може бути IP-адресою. Зверніть увагу, що використання localhost або 127.0.0.1 як host є ризикованим, якщо ви не забезпечите запуск цього вебхука на всіх хостах, які запускають apiserver і можуть потребувати викликів до цього вебхука. Такі установки, ймовірно, будуть непереносимими, тобто їх буде важко розгорнути в новому кластері. Схема повинна бути "https"; URL повинен починатися з "https://". Шлях є необовʼязковим, і якщо він присутній, може бути будь-яким рядком, допустимим у URL. Ви можете використовувати шлях для передачі довільного рядка вебхуку, наприклад, ідентифікатора кластера. Використання користувача або базової автентифікації, наприклад "user:password@", не дозволяється. Фрагменти ("#...") та параметри запиту ("?...") також не дозволяються. |
WebhookConversion описує, як викликати вебхук для конверсії
| Поле | Опис |
|---|---|
clientConfigWebhookClientConfig | clientConfig містить інструкції щодо виклику вебхука, якщо стратегія встановлена на Webhook. |
conversionReviewVersions *string array | conversionReviewVersions є впорядкованим списком переважних версій ConversionReview, які очікує вебхук. API-сервер використовуватиме першу версію зі списку, яку він підтримує. Якщо жодна з версій, зазначених у цьому списку, не підтримується API-сервером, конверсія для власного ресурсу не вдасться. Якщо збережена конфігурація вебхука вказує дозволені версії і не включає жодної версії, відомої API-серверу, виклики до вебхука не вдасться. |
post CreatePOST /apis/apiextensions.k8s.io/v1/customresourcedefinitions
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
| Назва | Тип | Опис |
|---|---|---|
body | CustomResourceDefinition |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinition |
| 201 | Created | CustomResourceDefinition |
| 202 | Accepted | CustomResourceDefinition |
patch PatchPATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply. |
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinition |
| 201 | Created | CustomResourceDefinition |
put ReplacePUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
| Назва | Тип | Опис |
|---|---|---|
body | CustomResourceDefinition |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinition |
| 201 | Created | CustomResourceDefinition |
delete DeleteDELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
gracePeriodSeconds | integer | Часу у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
| 202 | Accepted | Status |
delete Delete CollectionDELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
gracePeriodSeconds | integer | Часу у секундах перед видаленням обʼєкта. Значення повинно бути невідʼємним цілим числом. Значення нуль вказує на негайне видалення. Якщо це значення відсутнє, буде використано стандартний період очікування для зазначеного типу. Зазвичай використовується значення для конкретного обʼєкта, якщо не вказано. Нуль означає негайне видалення. |
ignoreStoreReadErrorWithClusterBreakingPotential | boolean | Якщо встановлено в true, це призведе до небезпечного видалення ресурсу у випадку, якщо нормальний процес видалення не вдасться через помилку пошкодженого обʼєкта. Ресурс вважається пошкодженим, якщо його не можна успішно отримати з відповідного сховища томущо: a) його дані не можна трансформувати, наприклад, помилка дешифрування, або b) не вдається декодувати в обʼєкт. ПРИМІТКА: небезпечне видалення ігнорує обмеження завершувача, пропускає перевірки передумов і видаляє обʼєкт зі сховища. ПОПЕРЕДЖЕННЯ: це може потенційно порушити роботу кластера, якщо робоче навантаження, повʼязане з ресурсом, що видаляється небезпечно, покладається на нормальний процес видалення. Використовуйте лише якщо ви ДІЙСНО знаєте, що робите. Стандартне значення — false, і користувач повинен явно погодитися на його використання. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
orphanDependents | boolean | Застаріло: будь ласка, використовуйте PropagationPolicy, це поле буде застарілим у версії 1.7. Чи повинні залежні обʼєкти залишатися покинутими. Якщо true/false, завершувач "orphan" буде доданий до/видалений з списку завершувачів обʼєкта. Можна встановити або це поле, або PropagationPolicy, але не обидва. |
propagationPolicy | string | Чи і як буде виконано збір сміття. Можна встановити або це поле, або OrphanDependents, але не обидва. Стандартна політика визначається наявним завершувачем у metadata.finalizers та стандартною політикою для конкретного ресурсу. Допустимі значення: 'Orphan' — залишити залежні обʼєкти покинутими; 'Background' — дозволити збирачу сміття видаляти залежні обʼєкти у фоновому режимі; 'Foreground' — каскадна політика, яка видаляє всі залежні обʼєкти з показом всіх дій. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
| Назва | Тип | Опис |
|---|---|---|
body | DeleteOptions |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | Status |
get ReadGET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinition |
get ListGET /apis/apiextensions.k8s.io/v1/customresourcedefinitions
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinitionList |
get WatchGET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
get Watch ListGET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
| Назва | Тип | Опис |
|---|---|---|
allowWatchBookmarks | boolean | allowWatchBookmarks запитує події спостереження з типом "BOOKMARK". Сервери, які не реалізують закладки, можуть ігнорувати цей прапорець, а закладки надсилаються на розсуд сервера. Клієнти не повинні припускати, що закладки повертаються через певний інтервал, і не можуть припускати, що сервер надішле будь-яку подію BOOKMARK під час сеансу. Якщо це не спостереження, це поле ігнорується. |
continue | string | Опція continue повинна бути встановлена при отриманні додаткових результатів від сервера. Оскільки це значення визначається сервером, клієнти можуть використовувати значення continue лише з попереднього результату запиту з ідентичними параметрами запиту (крім значення continue), і сервер може відхилити значення continue, яке він не розпізнає. Якщо вказане значення continue більше не дійсне через закінчення терміну дії (зазвичай пʼять-пʼятнадцять хвилин) або зміну конфігурації на сервері, сервер відповість помилкою 410 ResourceExpired разом з токеном continue. Якщо клієнту потрібен послідовний список, він повинен перезапустити свій список без поля continue. В іншому випадку клієнт може надіслати ще один запит списку з токеном, отриманим з помилкою 410, сервер відповість списком, починаючи з наступного ключа, але з останнього знімка, що не відповідає попереднім результатам списку — обʼєкти, які були створені, змінені або видалені після першого запиту списку, будуть включені у відповідь, якщо їх ключі йдуть після "наступного ключа". Це поле не підтримується, коли watch встановлено в true. Клієнти можуть почати спостереження з останнього значення resourceVersion, повернутого сервером, і не пропустити жодних змін. |
fieldSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми полями. Зазвичай повертаються всі обʼєкти. |
labelSelector | string | Селектор для обмеження списку обʼєктів, що повертаються, за їхніми мітками. Зазвичай повертаються всі обʼєкти. |
limit | integer | limit є максимальним числом відповідей, які потрібно повернути для виклику списку. Якщо існує більше елементів, сервер встановить поле continue у метаданих списку на значення, яке можна використовувати з тим самим початковим запитом для отримання наступного набору результатів. Встановлення обмеження може повернути менше, ніж запитана кількість елементів (до нуля елементів) у випадку, якщо всі запитані обʼєкти відфільтровані, і клієнти повинні використовувати лише наявність поля continue, щоб визначити, чи доступні додаткові результати. Сервери можуть вирішити не підтримувати аргумент limit і повернуть усі доступні результати. Якщо limit вказано, а поле continue порожнє, клієнти можуть припустити, що результатів більше немає. Це поле не підтримується, якщо watch дорівнює true. Сервер гарантує, що обʼєкти, повернені при використанні continue, будуть ідентичні до виконання одного виклику списку без обмеження — тобто жодні обʼєкти, створені, змінені або видалені після першого запиту, не будуть включені в будь-які наступні продовжені запити. Це іноді називають послідовним знімком, і забезпечує, що клієнт, який використовує limit для отримання менших частин дуже великого результату, може бути впевнений, що він бачить усі можливі обʼєкти. Якщо обʼєкти оновлюються під час отримання часткового списку, повертається версія обʼєкта, яка була присутня на момент обчислення першого результату списку. |
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
resourceVersion | string | resourceVersion встановлює обмеження на те, з яких версій ресурсів може обслуговуватися запит. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
resourceVersionMatch | string | resourceVersionMatch визначає, як resourceVersion застосовується до викликів списку. Рекомендується встановлювати resourceVersionMatch для викликів списку, де встановлено resourceVersion. Див. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions для деталей. Стандартне значення не встановлено |
sendInitialEvents | boolean | sendInitialEvents=true може бути встановлено разом з watch=true. У цьому випадку потік спостереження почнеться з синтетичних подій для відтворення поточного стану обʼєктів у колекції. Після надсилання всіх таких подій буде надіслано синтетичну подію "Bookmark". Закладка повідомить ResourceVersion (RV), що відповідає набору обʼєктів, і буде позначена анотацією "k8s.io/initial-events-end": "true". Після цього потік спостереження продовжиться як зазвичай, надсилаючи події спостереження, що відповідають змінам (після RV) для спостережуваних обʼєктів. Коли встановлено опцію sendInitialEvents, ми вимагаємо також встановлення опції resourceVersionMatch. Семантика запиту спостереження наступна:
|
shardSelector | string | shardSelector обмежує список обʼєктів, що повертаються, за допомогою виразу вибору шардів на основі CEL. Формат використовує функцію shardRange() у поєднанні з || (логічне АБО) для вказівки одного або кількох діапазонів хешів: shardRange(object.metadata.uid, '0x0', '0x8000000000000000') shardRange(object.metadata.uid, '0x0', '0x8000000000000000') || shardRange(object.metadata.uid, '0x8000000000000000', '0x10000000000000000') Шляхи полів використовують синтаксис CEL, що починається з обʼєкта (наприклад, "object.metadata.uid"), а не формат fieldSelector ("metadata.uid"). Наразі підтримуються такі шляхи:
|
timeoutSeconds | integer | Час очікування для виклику list/watch. Це обмежує тривалість виклику, незалежно від будь-якої активності чи неактивності. |
watch | boolean | Спостерігати за змінами описаних ресурсів і повертати їх як потік сповіщень про додавання, оновлення та видалення. Вкажіть resourceVersion. |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | WatchEvent |
patch Patch StatusPATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. Це поле обовʼязкове для запитів apply (application/apply-patch), але необовʼязкове для типів патчів, що не застосовуються (JsonPatch, MergePatch, StrategicMergePatch). |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
force | boolean | Force має на меті "примусово" застосовувати запити Apply. Це означає, що користувач повторно отримає конфліктні поля, що належать іншим користувачам. Прапорець Force повинен бути скасований для запитів, що не є патчами apply. |
| Назва | Тип | Опис |
|---|---|---|
body | Patch |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinition |
| 201 | Created | CustomResourceDefinition |
get Read StatusGET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinition |
put Replace StatusPUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
| Назва | Тип | Опис |
|---|---|---|
name | string | Назва CustomResourceDefinition |
| Назва | Тип | Опис |
|---|---|---|
pretty | string | Якщо 'true', то вихідні дані форматуються у зручному для читання вигляді. Зазвичай 'false', якщо user-agent не вказує оглядач або командний інструмент для роботи з HTTP (curl та wget). |
dryRun | string | Коли параметр присутній, це вказує, що зміни не повинні зберігатися. Неправильна або нерозпізнана директива dryRun призведе до помилки та припинення обробки запиту. Дійсні значення:
|
fieldManager | string | fieldManager є імʼям, повʼязаним з а́ктором або сутністю, яка вносить ці зміни. Значення повинно бути менше або дорівнювати 128 символам і містити лише друковані символи, як визначено в https://golang.org/pkg/unicode/#IsPrint. |
fieldValidation | string | fieldValidation інструктує сервер, як обробляти обʼєкти в запиті (POST/PUT/PATCH), що містять невідомі або дубльовані поля. Дійсні значення:
|
| Назва | Тип | Опис |
|---|---|---|
body | CustomResourceDefinition |
| Статус | Опис | Відповідь |
|---|---|---|
| 200 | OK | CustomResourceDefinition |
| 201 | Created | CustomResourceDefinition |