|
| 1 | +--- |
| 2 | +title: API Kubernetes |
| 3 | +content_template: templates/concept |
| 4 | +weight: 30 |
| 5 | +card: |
| 6 | + name: concepts |
| 7 | + weight: 30 |
| 8 | +--- |
| 9 | + |
| 10 | +{{% capture overview %}} |
| 11 | + |
| 12 | +Общие соглашения API описаны на [странице соглашений API](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md). |
| 13 | + |
| 14 | +Конечные точки API, типы ресурсов и примеры описаны в [справочнике API](/docs/reference). |
| 15 | + |
| 16 | +Удаленный доступ к API обсуждается в [Controlling API Access doc](/docs/reference/access-authn-authz/controlling-access/). |
| 17 | + |
| 18 | +API Kubernetes также служит основой декларативной схемы конфигурации системы. С помощью инструмента командной строки [kubectl](/ru/docs/reference/kubectl/overview/) можно создавать, обновлять, удалять и получать API-объекты. |
| 19 | + |
| 20 | +Kubernetes также сохраняет сериализованное состояние (в настоящее время в хранилище [etcd](https://coreos.com/docs/distributed-configuration/getting-started-with-etcd/)) каждого API-ресурса. |
| 21 | + |
| 22 | +Kubernetes как таковой состоит из множества компонентов, которые взаимодействуют друг с другом через собственные API. |
| 23 | + |
| 24 | +{{% /capture %}} |
| 25 | + |
| 26 | +{{% capture body %}} |
| 27 | + |
| 28 | +## Изменения в API |
| 29 | + |
| 30 | +Исходя из нашего опыта, любая успешная система должна улучшаться и изменяться по мере появления новых сценариев использования или изменения существующих. Поэтому мы надеемся, что и API Kubernetes будет постоянно меняться и расширяться. Однако в течение продолжительного периода времени мы будем поддерживать хорошую обратную совместимость с существующими клиентами. В целом, новые ресурсы API и поля ресурсов будут добавляться часто. Удаление ресурсов или полей регулируются [соответствующим процессом](/docs/reference/using-api/deprecation-policy/). |
| 31 | + |
| 32 | +Определение совместимого изменения и методы изменения API подробно описаны в [документе об изменениях API](https://git.k8s.io/community/contributors/devel/sig-architecture/api_changes.md). |
| 33 | + |
| 34 | +## Определения OpenAPI и Swagger |
| 35 | + |
| 36 | +Все детали API документируется с использованием [OpenAPI](https://www.openapis.org/). |
| 37 | + |
| 38 | +Начиная с Kubernetes 1.10, API-сервер Kubernetes основывается на спецификации OpenAPI через конечную точку `/openapi/v2`. |
| 39 | +Нужный формат устанавливается через HTTP-заголовоки: |
| 40 | + |
| 41 | +Заголовок | Возможные значения |
| 42 | +------ | --------------- |
| 43 | +Accept | `application/json`, `application/[email protected]+protobuf` (по умолчанию заголовок Content-Type установлен в `application/json` с `*/*`, допустимо также пропускать этот заголовок) |
| 44 | +Accept-Encoding | `gzip` (можно не передавать этот заголовок) |
| 45 | + |
| 46 | +До версии 1.14 конечные точки с форматом (`/swagger.json`, `/swagger-2.0.0.json`, `/swagger-2.0.0.pb-v1`, `/swagger-2.0.0.pb-v1.gz`) предоставляли спецификацию OpenAPI в разных форматах. Эти конечные точки были объявлены устаревшими и удалены в Kubernetes 1.14. |
| 47 | + |
| 48 | +**Примеры получения спецификации OpenAPI**: |
| 49 | + |
| 50 | +До 1.10 | С версии Kubernetes 1.10 |
| 51 | +----------- | ----------------------------- |
| 52 | +GET /swagger.json | GET /openapi/v2 **Accept**: application/json |
| 53 | +GET /swagger-2.0.0.pb-v1 | GET /openapi/v2 **Accept **: application/ [email protected]+protobuf |
| 54 | +GET /swagger-2.0.0.pb-v1.gz | GET /openapi/v2 **Accept **: application/ [email protected]+protobuf **Accept-Encoding **: gzip |
| 55 | + |
| 56 | +В Kubernetes реализован альтернативный формат сериализации API, основанный на Protobuf, который в первую очередь предназначен для взаимодействия внутри кластера. Описание этого формата можно найти в [проектом решении](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/protobuf.md), а IDL-файлы по каждой схемы — в пакетах Go, определяющих API-объекты. |
| 57 | + |
| 58 | +До версии 1.14 apiserver Kubernetes также представлял API, который можно использовать для получения спецификации [Swagger v1.2](http://swagger.io/) для API Kubernetes по пути `/swaggerapi`. Эта конечная точка устарела и была удалена в Kubernetes 1.14 |
| 59 | + |
| 60 | +## Версионирование API |
| 61 | + |
| 62 | +Чтобы упростить удаления полей или изменение ресурсов, Kubernetes поддерживает несколько версий API, каждая из которых доступна по собственному пути, например, `/api/v1` или `/apis/extensions/v1beta1`. |
| 63 | + |
| 64 | +Мы выбрали версионирование API, а не конкретных ресурсов или полей, чтобы API отражал четкое и согласованное представление о системных ресурсах и их поведении, а также, чтобы разграничивать API, которые уже не поддерживаются и/или находятся в экспериментальной стадии. Схемы сериализации JSON и Protobuf следуют одним и тем же правилам по внесению изменений в схему, поэтому описание ниже охватывают оба эти формата. |
| 65 | + |
| 66 | +Обратите внимание, что версиоирование API и программное обеспечение косвенно связаны друг с другом. [Предложение по версионированию API и новых выпусков](https://git.k8s.io/community/contributors/design-proposals/release/versioning.md) описывает, как связаны между собой версии API с версиями программного обеспечения. |
| 67 | + |
| 68 | +Разные версии API имеют характеризуются разной уровнем стабильностью и поддержкой. Критерии каждого уровня более подробно описаны в [документации изменений API](https://git.k8s.io/community/contributors/devel/sig-architecture/api_changes.md#alpha-beta-and-stable-versions). Ниже приводится краткое изложение: |
| 69 | + |
| 70 | +- Альфа-версии: |
| 71 | + - Названия версий включают надпись `alpha` (например, `v1alpha1`). |
| 72 | + - Могут содержать баги. Включение такой функциональности может привести к ошибкам. По умолчанию она отключена. |
| 73 | + - Поддержка функциональности может быть прекращена в любое время без какого-либо оповещения об этом. |
| 74 | + - API может быть несовместим с более поздними версиями без упоминания об этом. |
| 75 | + - Рекомендуется для использования только в тестировочных кластерах с коротким жизненным циклом из-за высокого риска наличия багов и отсутствия долгосрочной поддержки. |
| 76 | +- Бета-версии: |
| 77 | + - Названия версий включают надпись `beta` (например, `v2beta3`). |
| 78 | + - Код хорошо протестирован. Активация этой функциональности — безопасно. Поэтому она включена по умолчанию. |
| 79 | + - Поддержка функциональности в целом не будет прекращена, хотя кое-что может измениться. |
| 80 | + - Схема и/или семантика объектов может стать несовместимой с более поздними бета-версиями или стабильными выпусками. Когда это случится, мы даим инструкции по миграции на следующую версию. Это обновление может включать удаление, редактирование и повторного создание API-объектов. Этот процесс может потребовать тщательного анализа. Кроме этого, это может привести к простою приложений, которые используют данную функциональность. |
| 81 | + - Рекомендуется только для неосновного производственного использования из-за риска возникновения возможных несовместимых изменений с будущими версиями. Если у вас есть несколько кластеров, которые возможно обновить независимо, вы можете снять это ограничение. |
| 82 | + - **Пожалуйста, попробуйте в действии бета-версии функциональности и поделитесь своими впечатлениями! После того, как функциональность выйдет из бета-версии, нам может быть нецелесообразно что-то дальше изменять.** |
| 83 | +- Стабильные версии: |
| 84 | + - Имя версии `vX`, где `vX` — целое число. |
| 85 | + - Стабильные версии функциональностей появятся в новых версиях. |
| 86 | + |
| 87 | +## API-группы |
| 88 | + |
| 89 | +Чтобы упростить расширение API Kubernetes, реализованы [*группы API*](https://git.k8s.io/community/contributors/design-proposals/api-machinery/api-group.md). |
| 90 | +Группа API указывается в пути REST и в поле `apiVersion` сериализованного объекта. |
| 91 | + |
| 92 | +В настоящее время используется несколько API-групп: |
| 93 | + |
| 94 | +1. Группа *core*, которая часто упоминается как *устаревшая* (*legacy group*), доступна по пути `/api/v1` и использует `apiVersion: v1`. |
| 95 | + |
| 96 | +1. Именованные группы находятся в пути REST `/apis/$GROUP_NAME/$VERSION` и используют `apiVersion: $GROUP_NAME/$VERSION` (например, `apiVersion: batch/v1`). Полный список поддерживаемых групп API можно увидеть в [справочнике API Kubernetes](/docs/reference/). |
| 97 | + |
| 98 | +Есть два поддерживаемых пути к расширению API с помощью [пользовательских ресурсов](/docs/concepts/api-extension/custom-resources/): |
| 99 | + |
| 100 | +1. [CustomResourceDefinition](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/) для пользователей, которым нужен очень простой CRUD. |
| 101 | +2. Пользователи, которым нужна полная семантика API Kubernetes, могут реализовать собственный apiserver и использовать [агрегатор](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) для эффективной интеграции для клиентов. |
| 102 | + |
| 103 | +## Включение или отключение групп API |
| 104 | + |
| 105 | +Некоторые ресурсы и группы API включены по умолчанию. Их можно включить или отключить, установив `--runtime-config` для apiserver. Флаг `--runtime-config` принимает значения через запятую. Например, чтобы отключить batch/v1, используйте `--runtime-config=batch/v1=false`, а чтобы включить batch/v2alpha1, используйте флаг `--runtime-config=batch/v2alpha1`. |
| 106 | +Флаг набор пар ключ-значение, указанных через запятую, который описывает конфигурацию во время выполнения сервера. |
| 107 | + |
| 108 | +{{< note >}}Включение или отключение групп или ресурсов требует перезапуска apiserver и controller-manager для применения изменений `--runtime-config`.{{< /note >}} |
| 109 | + |
| 110 | +## Включение определённых ресурсов в группу extensions/v1beta1 |
| 111 | + |
| 112 | +DaemonSets, Deployments, StatefulSet, NetworkPolicies, PodSecurityPolicies и ReplicaSets в API-группе `extensions/v1beta1` по умолчанию отключены. |
| 113 | +Например: чтобы включить deployments и daemonsets, используйте флаг `--runtime-config=extensions/v1beta1/deployments=true,extensions/v1beta1/daemonsets=true`. |
| 114 | + |
| 115 | +{{< note >}}Включение/отключение отдельных ресурсов поддерживается только в API-группе `extensions/v1beta1` по историческим причинам.{{< /note >}} |
| 116 | + |
| 117 | +{{% /capture %}} |
0 commit comments