Cluster

Подсказка

Актуальную спецификацию можно скачать и использовать в привычном инструменте.

Набор методов для управления кластером OpenShift:

Метод API

HTTP-метод

Описание

Create

POST

Создает кластер OpenShift

Delete

DELETE

Удаляет кластер OpenShift

Get {serviceInstanceId}/clusters

GET

Возвращает информацию о кластерах в рамках услуги

Get {serviceInstanceId}/clusters/{clusterId}

GET

Возвращает информацию о конкретном кластере

Пример запроса на создание кластера

{
  "serviceInstanceId": XXXX-XXXX-XXXX-XXXX,
  "clusterName": test-name,
  "openshiftVersion": 4.7,
  "ipv4Policy": {
    "serviceCidrBlock": 10.0.0.0/8,
    "clusterNetworkCidrBlock": 172.16.0.0./12
  },
  "workersCount": 2
}
GET /openshift/v1/{serviceInstanceId}/clusters

Возвращает информацию о кластерах

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • clusters[].consoleUrl (string) – URL консоли управления OpenShift

  • clusters[].coresUsed (integer) – используемые кластером vCPU (ядра)

  • clusters[].createdAt (string) – время создания кластера

  • clusters[].healthy (boolean) – состояние кластера

  • clusters[].id (string) – идентификатор кластера

  • clusters[].name (string) – имя кластера

  • clusters[].ramUsed (integer) – используемая кластером оперативная память (ГБ)

  • clusters[].storageUsed (integer) – используемое кластером дисковое пространство (ГБ)

  • clusters[].version (string) – версия OpenShift

  • clusters[].workersCount (integer) – количество воркеров в кластере

POST /openshift/v1/{serviceInstanceId}/clusters

создаёт кластер OpenShift

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

Request JSON Object
  • clusterName (string) – имя кластера. Должно быть уникальным. Может содержать строчные буквы латинского алфавита, цифры и дефисы. Допустимое количество символов от 3 до 20.

  • ipv4Policy.clusterNetworkCidrBlock (string) – подсеть IP-адресов, из которой для каждой ноды будет выделяться подсеть (/23) IP-адресов подов. Пример: 10.128.0.0/14 Минимальный размер подсети: /16. Рекомендуемый: /14. Должна принадлежать приватным диапазонам (RFC 1918): 10.0.0.0/8, 172.16.0.0/12. Недопустимо пересечение с подсетью/подсетями в вашей облачной инфраструктуре. Недопустимо пересечение с serviceNetwork. Недопустимо пересечение с зарезервированными служебными подсетями: 172.17.0.0/16, 10.0.0.0/16, 192.168.0.0/24.

  • ipv4Policy.serviceCidrBlock (string) – подсеть IP-адресов для сервисов. Пример: 172.30.0.0/16 Минимальный размер подсети: /16. Должна принадлежать приватным диапазонам (RFC 1918): 10.0.0.0/8, 172.16.0.0/12. Недопустимо пересечение с подсетью/подсетями в облачной сети, в которой находится кластер OpenShift. Недопустимо пересечение с clusterNetwork. Недопустимо пересечение с зарезервированными служебными подсетями: 172.17.0.0/16, 10.0.0.0/16, 192.168.0.0/24.

  • openshiftVersion (string) – версия OpenShift кластера.

  • workersCount (integer) – необязательное поле. Количество воркеров для создаваемого кластера. Минимальное количество: 2. По умолчанию: 2.

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • task.command (string) – тип задачи (создать кластер, удалить кластер и т.п.)

  • task.createdAt (string) – время создания задачи

  • task.createdBy (string) – идентификатор пользователя или сервисного аккаунта, инициировавшего задачу

  • task.error.code (integer) – The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

  • task.error.details[].typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • task.error.details[].value (string) – Must be a valid serialized protocol buffer of the above specified type.

  • task.error.message (string) – A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

  • task.id (string) – идентификатор задачи

  • task.metadata (object) – метаданные задачи. Обычно в поле содержится идентификатор ресурса, над которым выполняется задача.

  • task.modifiedAt (string) – время последнего изменения ресурса

  • task.response.typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • task.response.value (string) – Must be a valid serialized protocol buffer of the above specified type.

  • task.serviceInstanceId (string) – идентификатор vDC (услуги)

  • task.status (string) – статус выполнения задачи

GET /openshift/v1/{serviceInstanceId}/clusters/{clusterId}

Возвращает информацию о кластере

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

  • clusterId (string) – идентификатор кластера

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • cluster.consoleUrl (string) – URL консоли управления OpenShift

  • cluster.coresUsed (integer) – используемые кластером vCPU (ядра)

  • cluster.createdAt (string) – время создания кластера

  • cluster.healthy (boolean) – состояние кластера

  • cluster.id (string) – идентификатор кластера

  • cluster.name (string) – имя кластера

  • cluster.ramUsed (integer) – используемая кластером оперативная память (ГБ)

  • cluster.storageUsed (integer) – используемое кластером дисковое пространство (ГБ)

  • cluster.version (string) – версия OpenShift

  • cluster.workersCount (integer) – количество воркеров в кластере

DELETE /openshift/v1/{serviceInstanceId}/clusters/{clusterId}

Удаляет кластер OpenShift

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

  • clusterId (string) – идентификатор кластера

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • task.command (string) – тип задачи (создать кластер, удалить кластер и т.п.)

  • task.createdAt (string) – время создания задачи

  • task.createdBy (string) – идентификатор пользователя или сервисного аккаунта, инициировавшего задачу

  • task.error.code (integer) – The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

  • task.error.details[].typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • task.error.details[].value (string) – Must be a valid serialized protocol buffer of the above specified type.

  • task.error.message (string) – A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

  • task.id (string) – идентификатор задачи

  • task.metadata (object) – метаданные задачи. Обычно в поле содержится идентификатор ресурса, над которым выполняется задача.

  • task.modifiedAt (string) – время последнего изменения ресурса

  • task.response.typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • task.response.value (string) – Must be a valid serialized protocol buffer of the above specified type.

  • task.serviceInstanceId (string) – идентификатор vDC (услуги)

  • task.status (string) – статус выполнения задачи