openapi: 3.1.0
info:
description: |-
None
title: OpenStack Container Managent Infrastructure API
version: '1.12'
paths:
/v1:
get:
operationId: :get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RootGetResponse'
description: Ok
tags:
- v1
/v1/certificates:
post:
description: |-
Sign a new certificate by the CA.
| param certificate: | |
| --- | --- |
| | a certificate within the request body. |
operationId: certificates:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificatesCreateResponse'
description: Ok
tags:
- certificates
/v1/certificates/{certificate_id}:
get:
description: |-
Show CA certificate details that are associated with the created cluster based on the
given CA certificate type.
operationId: certificates/certificate_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateShowResponse'
description: Ok
summary: Show details about the CA certificate for a cluster
tags:
- certificates
parameters:
- $ref: '#/components/parameters/certificates_certificate_id'
/v1/clusters:
get:
description: |-
List all clusters in Magnum.
operationId: clusters:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersListResponse'
description: Ok
summary: List all clusters
tags:
- clusters
post:
description: |-
Create new cluster based on cluster template.
operationId: clusters:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersCreateResponse'
description: Ok
summary: Create new cluster
tags:
- clusters
/v1/clusters/actions/resize:
post:
operationId: clusters/actions/resize:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterResizeRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersActionsResizeResponse'
description: Ok
tags:
- clusters
/v1/clusters/actions/upgrade:
post:
operationId: clusters/actions/upgrade:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterUpgradeRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersActionsUpgradeResponse'
description: Ok
tags:
- clusters
/v1/clusters/nodegroups:
delete:
description: |-
Delete NodeGroup for a given project_id and resource.
| param cluster_id: | |
| --- | --- |
| | cluster id. |
| param nodegroup_id: | |
| | resource name. |
operationId: clusters/nodegroups:delete
responses:
'204':
description: Ok
tags:
- clusters
get:
description: |-
Retrieve a list of nodegroups.
| param cluster_id: | |
| --- | --- |
| | the cluster id or name |
| param marker: | pagination marker for large data sets. |
| param limit: | maximum number of resources to return in a single result. |
| param sort_key: | column to sort results by. Default: id. |
| param sort_dir: | direction to sort. "asc" or "desc". Default: asc. |
| param role: | list all nodegroups with the specified role. |
operationId: clusters/nodegroups:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersNodegroupsListResponse'
description: Ok
tags:
- clusters
post:
description: |-
Retrieve a list of nodegroups.
| param cluster_id: | |
| --- | --- |
| | the cluster id or name |
| param marker: | pagination marker for large data sets. |
| param limit: | maximum number of resources to return in a single result. |
| param sort_key: | column to sort results by. Default: id. |
| param sort_dir: | direction to sort. "asc" or "desc". Default: asc. |
| param role: | list all nodegroups with the specified role. |
operationId: clusters/nodegroups:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NodeGroup'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersNodegroupsGet_OneResponse'
description: Ok
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersNodegroupsCreateResponse'
description: Ok
tags:
- clusters
/v1/clusters/nodegroups/{nodegroup_id}:
delete:
description: |-
Delete NodeGroup for a given project_id and resource.
| param cluster_id: | |
| --- | --- |
| | cluster id. |
| param nodegroup_id: | |
| | resource name. |
operationId: clusters/nodegroups/nodegroup_id:delete
responses:
'204':
description: Ok
tags:
- clusters
get:
description: |-
Retrieve information for the given nodegroup in a cluster.
| | |
| --- | --- |
| param id: | cluster id. |
| param resource: | nodegroup id. |
operationId: clusters/nodegroups/nodegroup_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersNodegroupShowResponse'
description: Ok
tags:
- clusters
parameters:
- $ref: '#/components/parameters/clusters_nodegroups_nodegroup_id'
patch:
description: |-
Update NodeGroup.
| param cluster_id: | |
| --- | --- |
| | cluster id. |
System Message: WARNING/2 (<string>, line 4)
Field list ends without a blank line; unexpected unindent.
:param : resource name.
:param values: a json document to update a nodegroup.
operationId: clusters/nodegroups/nodegroup_id:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersNodegroupPatchRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersNodegroupPatchResponse'
description: Ok
tags:
- clusters
/v1/clusters/{cluster_id}:
delete:
description: |-
Delete a cluster.
operationId: clusters/cluster_id:delete
responses:
'204':
description: Ok
summary: Delete a cluster
tags:
- clusters
get:
description: |-
Get all information of a cluster in Magnum.
operationId: clusters/cluster_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterShowResponse'
description: Ok
summary: Show details of a cluster
tags:
- clusters
parameters:
- $ref: '#/components/parameters/clusters_cluster_id'
patch:
description: |-
Update information of one cluster attributes using operations
including: `add`, `replace` or `remove`. The attributes to `add` and
`replace` in the form of `key=value` while `remove` only needs the keys.
operationId: clusters/cluster_id:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterPatchRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterPatchResponse'
description: Ok
summary: Update information of cluster
tags:
- clusters
/v1/clustertemplates:
get:
description: |-
List all available cluster templates in Magnum.
operationId: clustertemplates:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustertemplatesListResponse'
description: Ok
summary: List all cluster templates
tags:
- clustertemplates
post:
description: |-
Create new cluster template.
operationId: clustertemplates:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterTemplate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustertemplatesCreateResponse'
description: Ok
summary: Create new cluster template
tags:
- clustertemplates
/v1/clustertemplates/{clustertemplate_id}:
delete:
description: |-
Delete a cluster template.
operationId: clustertemplates/clustertemplate_id:delete
responses:
'204':
description: Ok
summary: Delete a cluster template
tags:
- clustertemplates
get:
description: |-
Get all information of a cluster template in Magnum.
operationId: clustertemplates/clustertemplate_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClustertemplateShowResponse'
description: Ok
summary: Show details of a cluster template
tags:
- clustertemplates
parameters:
- $ref: '#/components/parameters/clustertemplates_clustertemplate_id'
patch:
description: |-
Update information of one cluster template attributes using operations
including: `add`, `replace` or `remove`. The attributes to `add` and
`replace` in the form of `key=value` while `remove` only needs the keys.
summary: Update information of cluster template
/v1/credentials/{credential_id}:
parameters:
- $ref: '#/components/parameters/credentials_credential_id'
patch:
description: |-
Rotate the credential in use by a cluster.
| param cluster_ident: | |
| --- | --- |
| | UUID of a cluster or logical name of the cluster. |
operationId: credentials/credential_id:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialPatchRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialPatchResponse'
description: Ok
tags:
- credentials
/v1/federations:
get:
description: |-
Retrieve a list of federations.
| | |
| --- | --- |
| param marker: | pagination marker for large data sets. |
| param limit: | maximum number of resources to return in a single result. |
| param sort_key: | column to sort results by. Default: id. |
| param sort_dir: | direction to sort. "asc" or "desc". Default: asc. |
operationId: federations:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FederationsListResponse'
description: Ok
tags:
- federations
post:
description: |-
Create a new federation.
| param federation: | |
| --- | --- |
| | a federation within the request body. |
operationId: federations:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Federation'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/FederationsCreateResponse'
description: Ok
tags:
- federations
/v1/federations/{federation_id}:
delete:
description: |-
Delete a federation.
| param federation_ident: | |
| --- | --- |
| | UUID of federation or logical name of the federation. |
operationId: federations/federation_id:delete
responses:
'204':
description: Ok
tags:
- federations
get:
description: |-
Retrieve information about a given Federation.
| param federation_ident: | |
| --- | --- |
| | UUID or logical name of the Federation. |
operationId: federations/federation_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FederationShowResponse'
description: Ok
tags:
- federations
parameters:
- $ref: '#/components/parameters/federations_federation_id'
/v1/mservices:
get:
description: |-
Enables administrative users to list all Magnum services.
Container infrastructure service information include service id, binary,
host, report count, creation time, last updated time, health status, and
the reason for disabling service.
operationId: mservices:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MservicesListResponse'
description: Ok
summary: List container infrastructure management services
tags:
- mservices
/v1/quotas:
get:
description: |-
List all quotas in Magnum.
operationId: quotas:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/QuotasListResponse'
description: Ok
summary: List all quotas
tags:
- quotas
post:
description: |-
Create new quota for a project.
operationId: quotas:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Quota'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/QuotasCreateResponse'
description: Ok
summary: Set new quota
tags:
- quotas
/v1/quotas/{quota_id}:
delete:
description: |-
Delete Quota for a given project_id and resource.
| param project_id: | |
| --- | --- |
| | project id. |
| param resource: | resource name. |
operationId: quotas/quota_id:delete
responses:
'204':
description: Ok
tags:
- quotas
get:
description: |-
Retrieve Quota information for the given project_id.
| | |
| --- | --- |
| param id: | project id. |
| param resource: | resource name. |
operationId: quotas/quota_id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/QuotaShowResponse'
description: Ok
tags:
- quotas
parameters:
- $ref: '#/components/parameters/quotas_quota_id'
/v1/stats:
get:
description: |-
Show overall Magnum system stats.
If the requester is non-admin user show self stats.
operationId: stats:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StatsListResponse'
description: Ok
summary: Show overall stats
tags:
- stats
components:
parameters:
certificates_certificate_id:
description: certificate_id parameter for
/v1/certificates/{certificate_id} API
in: path
name: certificate_id
required: true
schema:
type: string
clusters_cluster_id:
description: cluster_id parameter for /v1/clusters/{cluster_id} API
in: path
name: cluster_id
required: true
schema:
type: string
clusters_nodegroups_nodegroup_id:
description: nodegroup_id parameter for
/v1/clusters/nodegroups/{nodegroup_id} API
in: path
name: nodegroup_id
required: true
schema:
type: string
clustertemplates_clustertemplate_id:
description: clustertemplate_id parameter for
/v1/clustertemplates/{clustertemplate_id} API
in: path
name: clustertemplate_id
required: true
schema:
type: string
credentials_credential_id:
description: credential_id parameter for /v1/credentials/{credential_id}
API
in: path
name: credential_id
required: true
schema:
type: string
federations_federation_id:
description: federation_id parameter for /v1/federations/{federation_id}
API
in: path
name: federation_id
required: true
schema:
type: string
quotas_quota_id:
description: quota_id parameter for /v1/quotas/{quota_id} API
in: path
name: quota_id
required: true
schema:
type: string
schemas:
Certificate:
description: "API representation of a certificate.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a\ncertificate."
properties:
ca_cert_type:
type: string
cluster_uuid:
type: string
created_at:
format: date-time
type: string
csr:
minLength: 1
type: string
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
pem:
type: string
updated_at:
format: date-time
type: string
type: object
CertificateShowResponse:
description: "API representation of a certificate.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a\ncertificate."
properties:
ca_cert_type:
type: string
cluster_uuid:
description: |-
The UUID of the cluster.
type: string
created_at:
format: date-time
type: string
csr:
minLength: 1
type: string
links:
description: |-
Links to the resources in question.
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
pem:
description: |-
CA certificate for the cluster.
type: string
updated_at:
format: date-time
type: string
type: object
CertificatesCreateResponse:
description: "API representation of a certificate.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a\ncertificate."
properties:
ca_cert_type:
type: string
cluster_uuid:
type: string
created_at:
format: date-time
type: string
csr:
minLength: 1
type: string
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
pem:
type: string
updated_at:
format: date-time
type: string
type: object
Cluster:
description: "API representation of a cluster.\n\nThis class enforces type checking
and value constraints, and converts\nbetween the internal object model and
the API representation of a Cluster."
properties:
api_address:
type: string
cluster_template_id:
description: |-
The UUID of the cluster template.
type: string
coe_version:
type: string
container_version:
type: string
create_timeout:
description: |-
The timeout for cluster creation in minutes. The value expected is a
positive integer and the default is 60 minutes. If the timeout is reached
during cluster creation process, the operation will be aborted and the
cluster status will be set to `CREATE_FAILED`.
type: integer
created_at:
format: date-time
type: string
discovery_url:
description: |-
The custom discovery url for node discovery. This is used by the COE to
discover the servers that have been created to host the containers. The
actual discovery mechanism varies with the COE. In some cases, Magnum fills
in the server info in the discovery service. In other cases, if the
`discovery_url` is not specified, Magnum will use the public discovery
service at:
```
https://discovery.etcd.io
```
In this case, Magnum will generate a unique url here for each uster and
store the info for the servers.
type: string
docker_volume_size:
minimum: 1
type: integer
faults:
additionalProperties:
type: string
type: object
fixed_network:
description: |-
The name or network ID of a Neutron network to provide connectivity to
the internal network for the cluster.
maxLength: 255
minLength: 1
type: string
fixed_subnet:
description: |-
Fixed subnet that are using to allocate network address for nodes in
cluster.
maxLength: 255
minLength: 1
type: string
flavor_id:
description: |-
The nova flavor ID or name for booting the node servers. The default is
`m1.small`.
maxLength: 255
minLength: 1
type: string
floating_ip_enabled:
description: |-
Whether enable or not using the floating IP of cloud provider. Some
cloud providers used floating IP, some used public IP, thus Magnum
provide this option for specifying the choice of using floating IP.
If it’s not set, the value of floating_ip_enabled in template
will be used.
format: boolean
type: string
health_status:
enum:
- HEALTHY
- UNHEALTHY
- UNKNOWN
type: string
health_status_reason:
additionalProperties:
type: string
type: object
keypair:
description: |-
The name of the SSH keypair to configure in the cluster servers
for ssh access. Users will need the key to be able to ssh to the servers in
the cluster. The login name is specific to the cluster driver, for
example with fedora-atomic image, default login name is `fedora`.
maxLength: 255
minLength: 1
type: string
labels:
additionalProperties:
format:
type: string
description: |-
Arbitrary labels in the form of `key=value` pairs. The accepted keys and
valid values are defined in the cluster drivers. They are used as a way
to pass additional parameters that are specific to a cluster driver.
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
master_addresses:
items:
type: string
type: array
master_count:
description: |-
The number of servers that will serve as master for the cluster. The
default is 1. Set to more than 1 master to enable High Availability. If
the option `master-lb-enabled` is specified in the cluster
template, the master servers will be placed in a load balancer pool.
minimum: 1
type: integer
master_flavor_id:
description: |-
The flavor of the master node for this cluster template.
maxLength: 255
minLength: 1
type: string
master_lb_enabled:
description: |-
Since multiple masters may exist in a cluster, a Neutron load balancer
is created to provide the API endpoint for the cluster and to direct
requests to the masters. In some cases, such as when the LBaaS service is
not available, this option can be set to `false` to create a cluster
without the load balancer. In this case, one of the masters will serve as
the API endpoint. The default is `true`, i.e. to create the load
balancer for the cluster.
format: boolean
type: string
merge_labels:
format: boolean
type: string
name:
description: |-
Name of the resource.
maxLength: 242
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
description: |-
The number of servers that will serve as node in the cluster. The
default is 1.
type: integer
project_id:
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
user_id:
type: string
uuid:
format: uuid
type: string
required:
- cluster_template_id
type: object
ClusterPatchRequest:
items:
description: |-
A complex type that represents a single json-patch operation.
properties:
op:
description: |-
The operation used to modify resource’s attributes. Supported operations
are following: `add`, `replace` and `remove`. In case of
`remove`, users only need to provide `path` for deleting attribute.
enum:
- add
- remove
- replace
type: string
path:
description: |-
Resource attribute’s name.
type: string
value:
description: |-
Resource attribute’s value.
format:
type: string
required:
- op
- path
type: object
type: array
ClusterPatchResponse:
description: "API representation of a cluster ID\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a cluster\nID."
properties:
uuid:
description: |-
The UUID of the cluster.
format: uuid
type: string
type: object
ClusterResizeRequest:
description: "API object for handling resize requests.\n\nThis class enforces
type checking and value constraints."
properties:
created_at:
format: date-time
type: string
node_count:
type: integer
nodegroup:
maxLength: 255
minLength: 1
type: string
nodes_to_remove:
items:
type: string
type: array
updated_at:
format: date-time
type: string
required:
- node_count
type: object
ClusterShowResponse:
description: "API representation of a cluster.\n\nThis class enforces type checking
and value constraints, and converts\nbetween the internal object model and
the API representation of a Cluster."
properties:
api_address:
description: |-
The endpoint URL of COE API exposed to end-users.
type: string
cluster_template_id:
description: |-
The UUID of the cluster template.
type: string
coe_version:
description: |-
Version info of chosen COE in cluster for helping client in picking
the right version of client.
type: string
container_version:
type: string
create_timeout:
description: |-
The timeout for cluster creation in minutes. The value expected is a
positive integer and the default is 60 minutes. If the timeout is reached
during cluster creation process, the operation will be aborted and the
cluster status will be set to `CREATE_FAILED`.
type: integer
created_at:
format: date-time
type: string
discovery_url:
description: |-
The custom discovery url for node discovery. This is used by the COE to
discover the servers that have been created to host the containers. The
actual discovery mechanism varies with the COE. In some cases, Magnum fills
in the server info in the discovery service. In other cases, if the
`discovery_url` is not specified, Magnum will use the public discovery
service at:
```
https://discovery.etcd.io
```
In this case, Magnum will generate a unique url here for each uster and
store the info for the servers.
type: string
docker_volume_size:
minimum: 1
type: integer
faults:
additionalProperties:
type: string
type: object
fixed_network:
maxLength: 255
minLength: 1
type: string
fixed_subnet:
maxLength: 255
minLength: 1
type: string
flavor_id:
maxLength: 255
minLength: 1
type: string
floating_ip_enabled:
description: |-
Whether enable or not using the floating IP of cloud provider. Some
cloud providers used floating IP, some used public IP, thus Magnum
provide this option for specifying the choice of using floating IP.
If it’s not set, the value of floating_ip_enabled in template
will be used.
format: boolean
type: string
health_status:
enum:
- HEALTHY
- UNHEALTHY
- UNKNOWN
type: string
health_status_reason:
additionalProperties:
type: string
type: object
keypair:
description: |-
The name of the SSH keypair to configure in the cluster servers
for ssh access. Users will need the key to be able to ssh to the servers in
the cluster. The login name is specific to the cluster driver, for
example with fedora-atomic image, default login name is `fedora`.
maxLength: 255
minLength: 1
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
description: |-
Links to the resources in question.
items:
description: |-
A link representation.
properties:
created_at:
description: |-
The date and time when the resource was created.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC.
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
description: |-
The date and time when the resource was updated.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC. In the previous example, the offset value is `-05:00`.
If the `updated_at` date and time stamp is not set, its value is
`null`.
format: date-time
type: string
type: object
type: array
master_addresses:
description: |-
List of floating IP of all master nodes.
items:
type: string
type: array
master_count:
description: |-
The number of servers that will serve as master for the cluster. The
default is 1. Set to more than 1 master to enable High Availability. If
the option `master-lb-enabled` is specified in the cluster
template, the master servers will be placed in a load balancer pool.
minimum: 1
type: integer
master_flavor_id:
maxLength: 255
minLength: 1
type: string
master_lb_enabled:
description: |-
Since multiple masters may exist in a cluster, a Neutron load balancer
is created to provide the API endpoint for the cluster and to direct
requests to the masters. In some cases, such as when the LBaaS service is
not available, this option can be set to `false` to create a cluster
without the load balancer. In this case, one of the masters will serve as
the API endpoint. The default is `true`, i.e. to create the load
balancer for the cluster.
format: boolean
type: string
merge_labels:
format: boolean
type: string
name:
description: |-
Name of the resource.
maxLength: 242
minLength: 1
type: string
node_addresses:
description: |-
List of floating IP of all servers that serve as node.
items:
type: string
type: array
node_count:
description: |-
The number of servers that will serve as node in the cluster. The
default is 1.
type: integer
project_id:
type: string
stack_id:
description: |-
The reference UUID of orchestration stack from Heat orchestration service.
type: string
status:
description: |-
The current state of the cluster.
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
description: |-
The reason of cluster current status.
type: string
updated_at:
format: date-time
type: string
user_id:
type: string
uuid:
description: |-
The UUID of the cluster.
format: uuid
type: string
required:
- cluster_template_id
type: object
ClusterTemplate:
description: "API representation of a ClusterTemplate.\n\nThis class enforces
type checking and value constraints, and converts\nbetween the internal object
model and the API representation of\na ClusterTemplate."
properties:
apiserver_port:
maximum: 65535
minimum: 1024
type: integer
cluster_distro:
maxLength: 255
minLength: 1
type: string
coe:
description: |-
Specify the Container Orchestration Engine to use. Supported COEs
include `kubernetes`. If your environment has additional cluster drivers
installed, refer to the cluster driver documentation for the new COE names.
enum:
- kubernetes
type: string
created_at:
format: date-time
type: string
dns_nameserver:
description: |-
The DNS nameserver for the servers and containers in the cluster to
use. This is configured in the private Neutron network for the cluster.
The default is `8.8.8.8`.
format: dnslist
type: string
docker_storage_driver:
description: |-
The name of a driver to manage the storage for the images and the
container’s writable layer. The default is `devicemapper`.
maxLength: 255
minLength: 1
type: string
docker_volume_size:
description: |-
The size in GB for the local storage on each server for the Docker daemon
to cache the images and host the containers. Cinder volumes provide the
storage. The default is 25 GB. For the `devicemapper` storage driver,
the minimum value is 3GB. For the `overlay` storage driver, the minimum
value is 1GB.
minimum: 1
type: integer
driver:
maxLength: 255
type: string
external_network_id:
description: |-
The name or network ID of a Neutron network to provide connectivity to the
external internet for the cluster. This network must be an external
network, i.e. its attribute `router:external` must be `True`. The
servers in the cluster will be connected to a private network and
Magnum will create a router between this private network and the external
network. This will allow the servers to download images, access discovery
service, etc, and the containers to install packages, etc. In the opposite
direction, floating IPs will be allocated from the external network to
provide access from the external internet to servers and the container
services hosted in the cluster.
maxLength: 255
minLength: 1
type: string
fixed_network:
description: |-
The name or network ID of a Neutron network to provide connectivity to
the internal network for the cluster.
maxLength: 255
minLength: 1
type: string
fixed_subnet:
description: |-
Fixed subnet that are using to allocate network address for nodes in
cluster.
maxLength: 255
minLength: 1
type: string
flavor_id:
description: |-
The nova flavor ID or name for booting the node servers. The default is
`m1.small`.
maxLength: 255
minLength: 1
type: string
floating_ip_enabled:
description: |-
Whether enable or not using the floating IP of cloud provider. Some
cloud providers used floating IP, some used public IP, thus Magnum
provide this option for specifying the choice of using floating IP.
format: boolean
type: string
hidden:
description: |-
Indicates whether the ClusterTemplate is hidden or not, the default
value is false.
format: boolean
type: string
http_proxy:
description: |-
The IP address for a proxy to use when direct http access from the servers
to sites on the external internet is blocked. This may happen in certain
countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
https_proxy:
description: |-
The IP address for a proxy to use when direct https access from the
servers to sites on the external internet is blocked. This may happen in
certain countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
image_id:
description: |-
The name or UUID of the base image in Glance to boot the servers for the
cluster. The image must have the attribute `os_distro` defined as
appropriate for the cluster driver.
maxLength: 255
minLength: 1
type: string
insecure_registry:
description: |-
The URL pointing to users’s own private insecure docker registry to
deploy and run docker containers.
maxLength: 255
minLength: 1
type: string
keypair_id:
description: |-
The name of the SSH keypair to configure in the cluster servers
for ssh access. Users will need the key to be able to ssh to the servers in
the cluster. The login name is specific to the cluster driver, for
example with fedora-atomic image, default login name is `fedora`.
maxLength: 255
minLength: 1
type: string
labels:
additionalProperties:
format:
type: string
description: |-
Arbitrary labels in the form of `key=value` pairs. The accepted keys and
valid values are defined in the cluster drivers. They are used as a way
to pass additional parameters that are specific to a cluster driver.
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
master_flavor_id:
description: |-
The flavor of the master node for this cluster template.
maxLength: 255
minLength: 1
type: string
master_lb_enabled:
description: |-
Since multiple masters may exist in a cluster, a Neutron load balancer
is created to provide the API endpoint for the cluster and to direct
requests to the masters. In some cases, such as when the LBaaS service is
not available, this option can be set to `false` to create a cluster
without the load balancer. In this case, one of the masters will serve as
the API endpoint. The default is `true`, i.e. to create the load
balancer for the cluster.
format: boolean
type: string
name:
description: |-
Name of the resource.
maxLength: 255
minLength: 1
type: string
network_driver:
description: |-
The name of a network driver for providing the networks for the containers.
Note that this is different and separate from the Neutron network for the
cluster. The operation and networking model are specific to the
particular driver.
maxLength: 255
minLength: 1
type: string
no_proxy:
description: |-
When a proxy server is used, some sites should not go through the proxy
and should be accessed normally. In this case, users can specify these
sites as a comma separated list of IPs. The default is `None`.
maxLength: 255
minLength: 1
type: string
project_id:
type: string
public:
description: |-
Access to a cluster template is normally limited to the admin,
owner or users within the same tenant as the owners. Setting this flag
makes the cluster template public and accessible by other users.
The default is not public.
format: boolean
type: string
registry_enabled:
description: |-
Docker images by default are pulled from the public Docker registry,
but in some cases, users may want to use a private registry. This option
provides an alternative registry based on the Registry V2: Magnum will
create a local registry in the cluster backed by swift to host the
images. The default is to use the public registry.
format: boolean
type: string
server_type:
description: |-
The servers in the cluster can be `vm` or `baremetal`. This
parameter selects the type of server to create for the cluster.
The default is `vm`.
enum:
- bm
- vm
type: string
tags:
description: |-
Administrator tags for the cluster template.
maxLength: 255
type: string
tls_disabled:
description: |-
Transport Layer Security (TLS) is normally enabled to secure the
cluster. In some cases, users may want to disable TLS in the
cluster, for instance during development or to troubleshoot certain
problems. Specifying this parameter will disable TLS so that users can
access the COE endpoints without a certificate. The default is TLS enabled.
format: boolean
type: string
updated_at:
format: date-time
type: string
user_id:
type: string
uuid:
format: uuid
type: string
volume_driver:
description: |-
The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver.
maxLength: 255
minLength: 1
type: string
required:
- image_id
type: object
ClusterUpgradeRequest:
description: "API object for handling upgrade requests.\n\nThis class enforces
type checking and value constraints."
properties:
cluster_template:
maxLength: 255
minLength: 1
type: string
created_at:
format: date-time
type: string
max_batch_size:
minimum: 1
type: integer
nodegroup:
maxLength: 255
minLength: 1
type: string
updated_at:
format: date-time
type: string
type: object
ClustersActionsResizeResponse:
description: "API representation of a cluster ID\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a cluster\nID."
properties:
uuid:
format: uuid
type: string
type: object
ClustersActionsUpgradeResponse:
description: "API representation of a cluster ID\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a cluster\nID."
properties:
uuid:
format: uuid
type: string
type: object
ClustersCreateResponse:
description: "API representation of a cluster ID\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a cluster\nID."
properties:
uuid:
description: |-
The UUID of the cluster.
format: uuid
type: string
type: object
ClustersListResponse:
description: API representation of a collection of clusters.
properties:
clusters:
description: |-
The list of all clusters in Magnum.
items:
description: |-
API representation of a cluster.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of a Cluster.
properties:
api_address:
type: string
cluster_template_id:
description: |-
The UUID of the cluster template.
type: string
coe_version:
type: string
container_version:
type: string
create_timeout:
description: |-
The timeout for cluster creation in minutes. The value expected is a
positive integer and the default is 60 minutes. If the timeout is reached
during cluster creation process, the operation will be aborted and the
cluster status will be set to `CREATE_FAILED`.
type: integer
created_at:
format: date-time
type: string
discovery_url:
type: string
docker_volume_size:
minimum: 1
type: integer
faults:
additionalProperties:
type: string
type: object
fixed_network:
maxLength: 255
minLength: 1
type: string
fixed_subnet:
maxLength: 255
minLength: 1
type: string
flavor_id:
maxLength: 255
minLength: 1
type: string
floating_ip_enabled:
format: boolean
type: string
health_status:
enum:
- HEALTHY
- UNHEALTHY
- UNKNOWN
type: string
health_status_reason:
additionalProperties:
type: string
type: object
keypair:
description: |-
The name of the SSH keypair to configure in the cluster servers
for ssh access. Users will need the key to be able to ssh to the servers in
the cluster. The login name is specific to the cluster driver, for
example with fedora-atomic image, default login name is `fedora`.
maxLength: 255
minLength: 1
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
description: |-
Links to the resources in question.
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
master_addresses:
items:
type: string
type: array
master_count:
description: |-
The number of servers that will serve as master for the cluster. The
default is 1. Set to more than 1 master to enable High Availability. If
the option `master-lb-enabled` is specified in the cluster
template, the master servers will be placed in a load balancer pool.
minimum: 1
type: integer
master_flavor_id:
maxLength: 255
minLength: 1
type: string
master_lb_enabled:
format: boolean
type: string
merge_labels:
format: boolean
type: string
name:
description: |-
Name of the resource.
maxLength: 242
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
description: |-
The number of servers that will serve as node in the cluster. The
default is 1.
type: integer
project_id:
type: string
stack_id:
description: |-
The reference UUID of orchestration stack from Heat orchestration service.
type: string
status:
description: |-
The current state of the cluster.
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
user_id:
type: string
uuid:
description: |-
The UUID of the cluster.
format: uuid
type: string
required:
- cluster_template_id
type: object
type: array
created_at:
format: date-time
type: string
next:
type: string
updated_at:
format: date-time
type: string
type: object
ClustersNodegroupPatchRequest:
items:
description: |-
A complex type that represents a single json-patch operation.
properties:
op:
enum:
- add
- remove
- replace
type: string
path:
type: string
value:
format:
type: string
required:
- op
- path
type: object
type: array
ClustersNodegroupPatchResponse:
description: "API representation of a Node group.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of NodeGroup."
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
ClustersNodegroupShowResponse:
description: "API representation of a Node group.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of NodeGroup."
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
ClustersNodegroupsCreateResponse:
description: "API representation of a Node group.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of NodeGroup."
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
ClustersNodegroupsGet_AllRequest:
description: Request of the clusters/nodegroups:post operation
type: object
x-openstack:
action-name: get_all
ClustersNodegroupsGet_AllResponse:
description: API representation of a collection of Node Groups.
properties:
created_at:
format: date-time
type: string
next:
type: string
nodegroups:
items:
description: |-
API representation of a Node group.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of NodeGroup.
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
type: array
updated_at:
format: date-time
type: string
type: object
ClustersNodegroupsGet_OneRequest:
description: Request of the clusters/nodegroups:post operation
type: object
x-openstack:
action-name: get_one
ClustersNodegroupsGet_OneResponse:
description: "API representation of a Node group.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of NodeGroup."
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
ClustersNodegroupsListResponse:
description: API representation of a collection of Node Groups.
properties:
created_at:
format: date-time
type: string
next:
type: string
nodegroups:
items:
description: |-
API representation of a Node group.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of NodeGroup.
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
type: array
updated_at:
format: date-time
type: string
type: object
ClustersNodegroupsPostResponse:
description: "API representation of a Node group.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of NodeGroup."
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
ClustersPostResponse:
description: "API representation of a cluster ID\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a cluster\nID."
properties:
uuid:
format: uuid
type: string
type: object
ClustertemplateShowResponse:
description: "API representation of a ClusterTemplate.\n\nThis class enforces
type checking and value constraints, and converts\nbetween the internal object
model and the API representation of\na ClusterTemplate."
properties:
apiserver_port:
description: |-
The exposed port of COE API server.
maximum: 65535
minimum: 1024
type: integer
cluster_distro:
description: |-
Display the attribute `os_distro` defined as appropriate metadata in
image for the cluster driver.
maxLength: 255
minLength: 1
type: string
coe:
description: |-
Specify the Container Orchestration Engine to use. Supported COEs
include `kubernetes`. If your environment has additional cluster drivers
installed, refer to the cluster driver documentation for the new COE names.
enum:
- kubernetes
type: string
created_at:
format: date-time
type: string
dns_nameserver:
description: |-
The DNS nameserver for the servers and containers in the cluster to
use. This is configured in the private Neutron network for the cluster.
The default is `8.8.8.8`.
format: dnslist
type: string
docker_storage_driver:
description: |-
The name of a driver to manage the storage for the images and the
container’s writable layer. The default is `devicemapper`.
maxLength: 255
minLength: 1
type: string
docker_volume_size:
description: |-
The size in GB for the local storage on each server for the Docker daemon
to cache the images and host the containers. Cinder volumes provide the
storage. The default is 25 GB. For the `devicemapper` storage driver,
the minimum value is 3GB. For the `overlay` storage driver, the minimum
value is 1GB.
minimum: 1
type: integer
driver:
maxLength: 255
type: string
external_network_id:
description: |-
The name or network ID of a Neutron network to provide connectivity to the
external internet for the cluster. This network must be an external
network, i.e. its attribute `router:external` must be `True`. The
servers in the cluster will be connected to a private network and
Magnum will create a router between this private network and the external
network. This will allow the servers to download images, access discovery
service, etc, and the containers to install packages, etc. In the opposite
direction, floating IPs will be allocated from the external network to
provide access from the external internet to servers and the container
services hosted in the cluster.
maxLength: 255
minLength: 1
type: string
fixed_network:
description: |-
The name or network ID of a Neutron network to provide connectivity to
the internal network for the cluster.
maxLength: 255
minLength: 1
type: string
fixed_subnet:
description: |-
Fixed subnet that are using to allocate network address for nodes in
cluster.
maxLength: 255
minLength: 1
type: string
flavor_id:
description: |-
The nova flavor ID or name for booting the node servers. The default is
`m1.small`.
maxLength: 255
minLength: 1
type: string
floating_ip_enabled:
description: |-
Whether enable or not using the floating IP of cloud provider. Some
cloud providers used floating IP, some used public IP, thus Magnum
provide this option for specifying the choice of using floating IP.
format: boolean
type: string
hidden:
description: |-
Indicates whether the ClusterTemplate is hidden or not, the default
value is false.
format: boolean
type: string
http_proxy:
description: |-
The IP address for a proxy to use when direct http access from the servers
to sites on the external internet is blocked. This may happen in certain
countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
https_proxy:
description: |-
The IP address for a proxy to use when direct https access from the
servers to sites on the external internet is blocked. This may happen in
certain countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
image_id:
description: |-
The name or UUID of the base image in Glance to boot the servers for the
cluster. The image must have the attribute `os_distro` defined as
appropriate for the cluster driver.
maxLength: 255
minLength: 1
type: string
insecure_registry:
description: |-
The URL pointing to users’s own private insecure docker registry to
deploy and run docker containers.
maxLength: 255
minLength: 1
type: string
keypair_id:
description: |-
The name of the SSH keypair to configure in the cluster servers
for ssh access. Users will need the key to be able to ssh to the servers in
the cluster. The login name is specific to the cluster driver, for
example with fedora-atomic image, default login name is `fedora`.
maxLength: 255
minLength: 1
type: string
labels:
additionalProperties:
format:
type: string
description: |-
Arbitrary labels in the form of `key=value` pairs. The accepted keys and
valid values are defined in the cluster drivers. They are used as a way
to pass additional parameters that are specific to a cluster driver.
type: object
links:
description: |-
Links to the resources in question.
items:
description: |-
A link representation.
properties:
created_at:
description: |-
The date and time when the resource was created.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC.
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
description: |-
The date and time when the resource was updated.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC. In the previous example, the offset value is `-05:00`.
If the `updated_at` date and time stamp is not set, its value is
`null`.
format: date-time
type: string
type: object
type: array
master_flavor_id:
description: |-
The flavor of the master node for this cluster template.
maxLength: 255
minLength: 1
type: string
master_lb_enabled:
description: |-
Since multiple masters may exist in a cluster, a Neutron load balancer
is created to provide the API endpoint for the cluster and to direct
requests to the masters. In some cases, such as when the LBaaS service is
not available, this option can be set to `false` to create a cluster
without the load balancer. In this case, one of the masters will serve as
the API endpoint. The default is `true`, i.e. to create the load
balancer for the cluster.
format: boolean
type: string
name:
description: |-
Name of the resource.
maxLength: 255
minLength: 1
type: string
network_driver:
description: |-
The name of a network driver for providing the networks for the containers.
Note that this is different and separate from the Neutron network for the
cluster. The operation and networking model are specific to the
particular driver.
maxLength: 255
minLength: 1
type: string
no_proxy:
description: |-
When a proxy server is used, some sites should not go through the proxy
and should be accessed normally. In this case, users can specify these
sites as a comma separated list of IPs. The default is `None`.
maxLength: 255
minLength: 1
type: string
project_id:
type: string
public:
description: |-
Access to a cluster template is normally limited to the admin,
owner or users within the same tenant as the owners. Setting this flag
makes the cluster template public and accessible by other users.
The default is not public.
format: boolean
type: string
registry_enabled:
description: |-
Docker images by default are pulled from the public Docker registry,
but in some cases, users may want to use a private registry. This option
provides an alternative registry based on the Registry V2: Magnum will
create a local registry in the cluster backed by swift to host the
images. The default is to use the public registry.
format: boolean
type: string
server_type:
description: |-
The servers in the cluster can be `vm` or `baremetal`. This
parameter selects the type of server to create for the cluster.
The default is `vm`.
enum:
- bm
- vm
type: string
tags:
description: |-
Administrator tags for the cluster template.
maxLength: 255
type: string
tls_disabled:
description: |-
Transport Layer Security (TLS) is normally enabled to secure the
cluster. In some cases, users may want to disable TLS in the
cluster, for instance during development or to troubleshoot certain
problems. Specifying this parameter will disable TLS so that users can
access the COE endpoints without a certificate. The default is TLS enabled.
format: boolean
type: string
updated_at:
format: date-time
type: string
user_id:
type: string
uuid:
description: |-
The UUID of the cluster template.
format: uuid
type: string
volume_driver:
description: |-
The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver.
maxLength: 255
minLength: 1
type: string
required:
- image_id
type: object
ClustertemplatesCreateResponse:
description: "API representation of a ClusterTemplate.\n\nThis class enforces
type checking and value constraints, and converts\nbetween the internal object
model and the API representation of\na ClusterTemplate."
properties:
apiserver_port:
description: |-
The exposed port of COE API server.
maximum: 65535
minimum: 1024
type: integer
cluster_distro:
description: |-
Display the attribute `os_distro` defined as appropriate metadata in
image for the cluster driver.
maxLength: 255
minLength: 1
type: string
coe:
description: |-
Specify the Container Orchestration Engine to use. Supported COEs
include `kubernetes`. If your environment has additional cluster drivers
installed, refer to the cluster driver documentation for the new COE names.
enum:
- kubernetes
type: string
created_at:
format: date-time
type: string
dns_nameserver:
description: |-
The DNS nameserver for the servers and containers in the cluster to
use. This is configured in the private Neutron network for the cluster.
The default is `8.8.8.8`.
format: dnslist
type: string
docker_storage_driver:
description: |-
The name of a driver to manage the storage for the images and the
container’s writable layer. The default is `devicemapper`.
maxLength: 255
minLength: 1
type: string
docker_volume_size:
description: |-
The size in GB for the local storage on each server for the Docker daemon
to cache the images and host the containers. Cinder volumes provide the
storage. The default is 25 GB. For the `devicemapper` storage driver,
the minimum value is 3GB. For the `overlay` storage driver, the minimum
value is 1GB.
minimum: 1
type: integer
driver:
maxLength: 255
type: string
external_network_id:
description: |-
The name or network ID of a Neutron network to provide connectivity to the
external internet for the cluster. This network must be an external
network, i.e. its attribute `router:external` must be `True`. The
servers in the cluster will be connected to a private network and
Magnum will create a router between this private network and the external
network. This will allow the servers to download images, access discovery
service, etc, and the containers to install packages, etc. In the opposite
direction, floating IPs will be allocated from the external network to
provide access from the external internet to servers and the container
services hosted in the cluster.
maxLength: 255
minLength: 1
type: string
fixed_network:
description: |-
The name or network ID of a Neutron network to provide connectivity to
the internal network for the cluster.
maxLength: 255
minLength: 1
type: string
fixed_subnet:
description: |-
Fixed subnet that are using to allocate network address for nodes in
cluster.
maxLength: 255
minLength: 1
type: string
flavor_id:
description: |-
The nova flavor ID or name for booting the node servers. The default is
`m1.small`.
maxLength: 255
minLength: 1
type: string
floating_ip_enabled:
description: |-
Whether enable or not using the floating IP of cloud provider. Some
cloud providers used floating IP, some used public IP, thus Magnum
provide this option for specifying the choice of using floating IP.
format: boolean
type: string
hidden:
description: |-
Indicates whether the ClusterTemplate is hidden or not, the default
value is false.
format: boolean
type: string
http_proxy:
description: |-
The IP address for a proxy to use when direct http access from the servers
to sites on the external internet is blocked. This may happen in certain
countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
https_proxy:
description: |-
The IP address for a proxy to use when direct https access from the
servers to sites on the external internet is blocked. This may happen in
certain countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
image_id:
description: |-
The name or UUID of the base image in Glance to boot the servers for the
cluster. The image must have the attribute `os_distro` defined as
appropriate for the cluster driver.
maxLength: 255
minLength: 1
type: string
insecure_registry:
description: |-
The URL pointing to users’s own private insecure docker registry to
deploy and run docker containers.
maxLength: 255
minLength: 1
type: string
keypair_id:
description: |-
The name of the SSH keypair to configure in the cluster servers
for ssh access. Users will need the key to be able to ssh to the servers in
the cluster. The login name is specific to the cluster driver, for
example with fedora-atomic image, default login name is `fedora`.
maxLength: 255
minLength: 1
type: string
labels:
additionalProperties:
format:
type: string
description: |-
Arbitrary labels in the form of `key=value` pairs. The accepted keys and
valid values are defined in the cluster drivers. They are used as a way
to pass additional parameters that are specific to a cluster driver.
type: object
links:
description: |-
Links to the resources in question.
items:
description: |-
A link representation.
properties:
created_at:
description: |-
The date and time when the resource was created.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC.
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
description: |-
The date and time when the resource was updated.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC. In the previous example, the offset value is `-05:00`.
If the `updated_at` date and time stamp is not set, its value is
`null`.
format: date-time
type: string
type: object
type: array
master_flavor_id:
description: |-
The flavor of the master node for this cluster template.
maxLength: 255
minLength: 1
type: string
master_lb_enabled:
description: |-
Since multiple masters may exist in a cluster, a Neutron load balancer
is created to provide the API endpoint for the cluster and to direct
requests to the masters. In some cases, such as when the LBaaS service is
not available, this option can be set to `false` to create a cluster
without the load balancer. In this case, one of the masters will serve as
the API endpoint. The default is `true`, i.e. to create the load
balancer for the cluster.
format: boolean
type: string
name:
description: |-
Name of the resource.
maxLength: 255
minLength: 1
type: string
network_driver:
description: |-
The name of a network driver for providing the networks for the containers.
Note that this is different and separate from the Neutron network for the
cluster. The operation and networking model are specific to the
particular driver.
maxLength: 255
minLength: 1
type: string
no_proxy:
description: |-
When a proxy server is used, some sites should not go through the proxy
and should be accessed normally. In this case, users can specify these
sites as a comma separated list of IPs. The default is `None`.
maxLength: 255
minLength: 1
type: string
project_id:
type: string
public:
description: |-
Access to a cluster template is normally limited to the admin,
owner or users within the same tenant as the owners. Setting this flag
makes the cluster template public and accessible by other users.
The default is not public.
format: boolean
type: string
registry_enabled:
description: |-
Docker images by default are pulled from the public Docker registry,
but in some cases, users may want to use a private registry. This option
provides an alternative registry based on the Registry V2: Magnum will
create a local registry in the cluster backed by swift to host the
images. The default is to use the public registry.
format: boolean
type: string
server_type:
description: |-
The servers in the cluster can be `vm` or `baremetal`. This
parameter selects the type of server to create for the cluster.
The default is `vm`.
enum:
- bm
- vm
type: string
tags:
description: |-
Administrator tags for the cluster template.
maxLength: 255
type: string
tls_disabled:
description: |-
Transport Layer Security (TLS) is normally enabled to secure the
cluster. In some cases, users may want to disable TLS in the
cluster, for instance during development or to troubleshoot certain
problems. Specifying this parameter will disable TLS so that users can
access the COE endpoints without a certificate. The default is TLS enabled.
format: boolean
type: string
updated_at:
format: date-time
type: string
user_id:
type: string
uuid:
description: |-
The UUID of the cluster template.
format: uuid
type: string
volume_driver:
description: |-
The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver.
maxLength: 255
minLength: 1
type: string
required:
- image_id
type: object
ClustertemplatesListResponse:
description: API representation of a collection of ClusterTemplates.
properties:
clustertemplates:
description: |-
The list of all cluster templates in Magnum.
items:
description: |-
API representation of a ClusterTemplate.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of
a ClusterTemplate.
properties:
apiserver_port:
description: |-
The exposed port of COE API server.
maximum: 65535
minimum: 1024
type: integer
cluster_distro:
description: |-
Display the attribute `os_distro` defined as appropriate metadata in
image for the cluster driver.
maxLength: 255
minLength: 1
type: string
coe:
description: |-
Specify the Container Orchestration Engine to use. Supported COEs
include `kubernetes`. If your environment has additional cluster drivers
installed, refer to the cluster driver documentation for the new COE names.
enum:
- kubernetes
type: string
created_at:
format: date-time
type: string
dns_nameserver:
description: |-
The DNS nameserver for the servers and containers in the cluster to
use. This is configured in the private Neutron network for the cluster.
The default is `8.8.8.8`.
format: dnslist
type: string
docker_storage_driver:
description: |-
The name of a driver to manage the storage for the images and the
container’s writable layer. The default is `devicemapper`.
maxLength: 255
minLength: 1
type: string
docker_volume_size:
description: |-
The size in GB for the local storage on each server for the Docker daemon
to cache the images and host the containers. Cinder volumes provide the
storage. The default is 25 GB. For the `devicemapper` storage driver,
the minimum value is 3GB. For the `overlay` storage driver, the minimum
value is 1GB.
minimum: 1
type: integer
driver:
maxLength: 255
type: string
external_network_id:
description: |-
The name or network ID of a Neutron network to provide connectivity to the
external internet for the cluster. This network must be an external
network, i.e. its attribute `router:external` must be `True`. The
servers in the cluster will be connected to a private network and
Magnum will create a router between this private network and the external
network. This will allow the servers to download images, access discovery
service, etc, and the containers to install packages, etc. In the opposite
direction, floating IPs will be allocated from the external network to
provide access from the external internet to servers and the container
services hosted in the cluster.
maxLength: 255
minLength: 1
type: string
fixed_network:
description: |-
The name or network ID of a Neutron network to provide connectivity to
the internal network for the cluster.
maxLength: 255
minLength: 1
type: string
fixed_subnet:
description: |-
Fixed subnet that are using to allocate network address for nodes in
cluster.
maxLength: 255
minLength: 1
type: string
flavor_id:
description: |-
The nova flavor ID or name for booting the node servers. The default is
`m1.small`.
maxLength: 255
minLength: 1
type: string
floating_ip_enabled:
description: |-
Whether enable or not using the floating IP of cloud provider. Some
cloud providers used floating IP, some used public IP, thus Magnum
provide this option for specifying the choice of using floating IP.
format: boolean
type: string
hidden:
description: |-
Indicates whether the ClusterTemplate is hidden or not, the default
value is false.
format: boolean
type: string
http_proxy:
description: |-
The IP address for a proxy to use when direct http access from the servers
to sites on the external internet is blocked. This may happen in certain
countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
https_proxy:
description: |-
The IP address for a proxy to use when direct https access from the
servers to sites on the external internet is blocked. This may happen in
certain countries or enterprises, and the proxy allows the servers and
containers to access these sites. The format is a URL including a port
number. The default is `None`.
maxLength: 255
minLength: 1
type: string
image_id:
description: |-
The name or UUID of the base image in Glance to boot the servers for the
cluster. The image must have the attribute `os_distro` defined as
appropriate for the cluster driver.
maxLength: 255
minLength: 1
type: string
insecure_registry:
description: |-
The URL pointing to users’s own private insecure docker registry to
deploy and run docker containers.
maxLength: 255
minLength: 1
type: string
keypair_id:
description: |-
The name of the SSH keypair to configure in the cluster servers
for ssh access. Users will need the key to be able to ssh to the servers in
the cluster. The login name is specific to the cluster driver, for
example with fedora-atomic image, default login name is `fedora`.
maxLength: 255
minLength: 1
type: string
labels:
additionalProperties:
format:
type: string
description: |-
Arbitrary labels in the form of `key=value` pairs. The accepted keys and
valid values are defined in the cluster drivers. They are used as a way
to pass additional parameters that are specific to a cluster driver.
type: object
links:
description: |-
Links to the resources in question.
items:
description: |-
A link representation.
properties:
created_at:
description: |-
The date and time when the resource was created.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC.
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
description: |-
The date and time when the resource was updated.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC. In the previous example, the offset value is `-05:00`.
If the `updated_at` date and time stamp is not set, its value is
`null`.
format: date-time
type: string
type: object
type: array
master_flavor_id:
description: |-
The flavor of the master node for this cluster template.
maxLength: 255
minLength: 1
type: string
master_lb_enabled:
description: |-
Since multiple masters may exist in a cluster, a Neutron load balancer
is created to provide the API endpoint for the cluster and to direct
requests to the masters. In some cases, such as when the LBaaS service is
not available, this option can be set to `false` to create a cluster
without the load balancer. In this case, one of the masters will serve as
the API endpoint. The default is `true`, i.e. to create the load
balancer for the cluster.
format: boolean
type: string
name:
description: |-
Name of the resource.
maxLength: 255
minLength: 1
type: string
network_driver:
description: |-
The name of a network driver for providing the networks for the containers.
Note that this is different and separate from the Neutron network for the
cluster. The operation and networking model are specific to the
particular driver.
maxLength: 255
minLength: 1
type: string
no_proxy:
description: |-
When a proxy server is used, some sites should not go through the proxy
and should be accessed normally. In this case, users can specify these
sites as a comma separated list of IPs. The default is `None`.
maxLength: 255
minLength: 1
type: string
project_id:
type: string
public:
description: |-
Access to a cluster template is normally limited to the admin,
owner or users within the same tenant as the owners. Setting this flag
makes the cluster template public and accessible by other users.
The default is not public.
format: boolean
type: string
registry_enabled:
description: |-
Docker images by default are pulled from the public Docker registry,
but in some cases, users may want to use a private registry. This option
provides an alternative registry based on the Registry V2: Magnum will
create a local registry in the cluster backed by swift to host the
images. The default is to use the public registry.
format: boolean
type: string
server_type:
description: |-
The servers in the cluster can be `vm` or `baremetal`. This
parameter selects the type of server to create for the cluster.
The default is `vm`.
enum:
- bm
- vm
type: string
tags:
description: |-
Administrator tags for the cluster template.
maxLength: 255
type: string
tls_disabled:
description: |-
Transport Layer Security (TLS) is normally enabled to secure the
cluster. In some cases, users may want to disable TLS in the
cluster, for instance during development or to troubleshoot certain
problems. Specifying this parameter will disable TLS so that users can
access the COE endpoints without a certificate. The default is TLS enabled.
format: boolean
type: string
updated_at:
format: date-time
type: string
user_id:
type: string
uuid:
description: |-
The UUID of the cluster template.
format: uuid
type: string
volume_driver:
description: |-
The name of a volume driver for managing the persistent storage for the containers. The functionality supported are specific to the driver.
maxLength: 255
minLength: 1
type: string
required:
- image_id
type: object
type: array
created_at:
format: date-time
type: string
next:
type: string
updated_at:
format: date-time
type: string
type: object
CredentialPatchRequest:
description: Request of the credentials/credential_id:patch operation
type: object
x-openstack:
action-name: patch
CredentialPatchResponse:
description: "API representation of a cluster ID\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a cluster\nID."
properties:
uuid:
format: uuid
type: string
type: object
Federation:
description: "API representation of a federation.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a\nFederation."
properties:
created_at:
format: date-time
type: string
hostcluster_id:
type: string
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
member_ids:
items:
type: string
type: array
name:
maxLength: 242
minLength: 1
type: string
properties:
additionalProperties:
type: string
type: object
status:
enum:
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
type: object
FederationShowResponse:
description: "API representation of a federation.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a\nFederation."
properties:
created_at:
format: date-time
type: string
hostcluster_id:
type: string
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
member_ids:
items:
type: string
type: array
name:
maxLength: 242
minLength: 1
type: string
properties:
additionalProperties:
type: string
type: object
status:
enum:
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
type: object
FederationsCreateResponse:
description: "API representation of a federation ID\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of a\nfederation ID."
properties:
uuid:
format: uuid
type: string
type: object
FederationsListResponse:
description: API representation of a collection of federations.
properties:
created_at:
format: date-time
type: string
federations:
items:
description: |-
API representation of a federation.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of a
Federation.
properties:
created_at:
format: date-time
type: string
hostcluster_id:
type: string
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
member_ids:
items:
type: string
type: array
name:
maxLength: 242
minLength: 1
type: string
properties:
additionalProperties:
type: string
type: object
status:
enum:
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
type: object
type: array
next:
type: string
updated_at:
format: date-time
type: string
type: object
MservicesListResponse:
description: Base type for complex types
properties:
created_at:
format: date-time
type: string
mservices:
description: |-
A list of Magnum services.
items:
description: |-
Base type for complex types
properties:
binary:
description: |-
The name of the binary form of the Magnum service.
enum:
- magnum-conductor
type: string
created_at:
description: |-
The date and time when the resource was created.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC.
format: date-time
type: string
disabled:
format: boolean
type: string
disabled_reason:
description: |-
The disable reason of the service, `null` if the service is enabled or
disabled without reason provided.
maxLength: 255
type: string
host:
description: |-
The host for the service.
maxLength: 255
minLength: 1
type: string
id:
description: |-
The ID of the Magnum service.
minimum: 1
type: integer
report_count:
description: |-
The total number of report.
type: integer
state:
description: |-
The current state of Magnum services.
enum:
- down
- up
type: string
updated_at:
description: |-
The date and time when the resource was updated.
The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):
```
CCYY-MM-DDThh:mm:ss±hh:mm
```
For example, `2015-08-27T09:49:58-05:00`.
The `±hh:mm` value, if included, is the time zone as an offset
from UTC. In the previous example, the offset value is `-05:00`.
If the `updated_at` date and time stamp is not set, its value is
`null`.
format: date-time
type: string
type: object
type: array
next:
type: string
updated_at:
format: date-time
type: string
type: object
NodeGroup:
description: "API representation of a Node group.\n\nThis class enforces type
checking and value constraints, and converts\nbetween the internal object
model and the API representation of NodeGroup."
properties:
cluster_id:
format: uuid
type: string
created_at:
format: date-time
type: string
docker_volume_size:
minimum: 1
type: integer
flavor_id:
maxLength: 255
minLength: 1
type: string
id:
minimum: 1
type: integer
image_id:
maxLength: 255
minLength: 1
type: string
is_default:
format: boolean
type: string
labels:
additionalProperties:
format:
type: string
type: object
labels_added:
additionalProperties:
format:
type: string
type: object
labels_overridden:
additionalProperties:
format:
type: string
type: object
labels_skipped:
additionalProperties:
format:
type: string
type: object
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
max_node_count:
type: integer
merge_labels:
format: boolean
type: string
min_node_count:
type: integer
name:
maxLength: 255
minLength: 1
type: string
node_addresses:
items:
type: string
type: array
node_count:
type: integer
project_id:
type: string
role:
maxLength: 255
minLength: 1
type: string
stack_id:
type: string
status:
enum:
- ADOPT_COMPLETE
- CHECK_COMPLETE
- CREATE_COMPLETE
- CREATE_FAILED
- CREATE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- DELETE_IN_PROGRESS
- RESTORE_COMPLETE
- RESUME_COMPLETE
- RESUME_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_FAILED
- ROLLBACK_IN_PROGRESS
- SNAPSHOT_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_IN_PROGRESS
type: string
status_reason:
type: string
updated_at:
format: date-time
type: string
uuid:
format: uuid
type: string
version:
type: string
type: object
Quota:
description: "API representation of a project Quota.\n\nThis class enforces
type checking and value constraints, and converts\nbetween the internal object
model and the API representation of Quota."
properties:
created_at:
format: date-time
type: string
hard_limit:
type: integer
id:
minimum: 1
type: integer
project_id:
maxLength: 255
minLength: 1
type: string
resource:
enum:
- Cluster
type: string
updated_at:
format: date-time
type: string
type: object
QuotaShowResponse:
description: "API representation of a project Quota.\n\nThis class enforces
type checking and value constraints, and converts\nbetween the internal object
model and the API representation of Quota."
properties:
created_at:
format: date-time
type: string
hard_limit:
type: integer
id:
minimum: 1
type: integer
project_id:
maxLength: 255
minLength: 1
type: string
resource:
enum:
- Cluster
type: string
updated_at:
format: date-time
type: string
type: object
QuotasCreateResponse:
description: "API representation of a project Quota.\n\nThis class enforces
type checking and value constraints, and converts\nbetween the internal object
model and the API representation of Quota."
properties:
created_at:
format: date-time
type: string
hard_limit:
type: integer
id:
minimum: 1
type: integer
project_id:
maxLength: 255
minLength: 1
type: string
resource:
enum:
- Cluster
type: string
updated_at:
format: date-time
type: string
type: object
QuotasListResponse:
description: API representation of a collection of quotas.
properties:
created_at:
format: date-time
type: string
next:
type: string
quotas:
items:
description: |-
API representation of a project Quota.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of Quota.
properties:
created_at:
format: date-time
type: string
hard_limit:
type: integer
id:
minimum: 1
type: integer
project_id:
maxLength: 255
minLength: 1
type: string
resource:
enum:
- Cluster
type: string
updated_at:
format: date-time
type: string
type: object
type: array
updated_at:
format: date-time
type: string
type: object
RootGetResponse:
description: The representation of the version 1 of the API.
properties:
certificates:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
clusters:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
clustertemplates:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
created_at:
format: date-time
type: string
credentials:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
federations:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
id:
type: string
links:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
media_types:
items:
description: |-
A media type representation.
properties:
base:
type: string
created_at:
format: date-time
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
mservices:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
nodegroups:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
quotas:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
stats:
items:
description: |-
A link representation.
properties:
created_at:
format: date-time
type: string
href:
type: string
rel:
type: string
type:
type: string
updated_at:
format: date-time
type: string
type: object
type: array
updated_at:
format: date-time
type: string
type: object
StatsListResponse:
description: Base type for complex types
properties:
clusters:
description: |-
The number of clusters.
type: integer
created_at:
format: date-time
type: string
nodes:
description: |-
The total number of nodes including master nodes.
type: integer
updated_at:
format: date-time
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header
name: X-Auth-Token
type: apiKey
security:
- ApiKeyAuth: []
tags:
- name: certificates
- name: clusters
- name: clustertemplates
- name: credentials
- name: federations
- name: mservices
- name: quotas
- name: stats
- name: v1