You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
625 lines
17 KiB
625 lines
17 KiB
# Header params |
|
request_id: |
|
type: UUID |
|
in: header |
|
required: true |
|
description: | |
|
A unique ID for tracking service request. The request ID associated |
|
with the request by default appears in the service logs. |
|
|
|
# Path params |
|
bay_ident: |
|
type: string |
|
in: path |
|
required: true |
|
description: | |
|
The UUID or name of bays in Magnum. |
|
baymodel_ident: |
|
description: | |
|
The UUID or name of baymodels in Magnum. |
|
in: path |
|
required: true |
|
type: string |
|
cluster_ident: |
|
type: string |
|
in: path |
|
required: true |
|
description: | |
|
The UUID or name of clusters in Magnum. |
|
clustertemplate_ident: |
|
type: string |
|
in: path |
|
required: true |
|
description: | |
|
The UUID or name of cluster templates in Magnum. |
|
project_id: |
|
type: string |
|
in: path |
|
required: true |
|
description: | |
|
Project ID. |
|
|
|
# Body params |
|
api_address: |
|
description: | |
|
The endpoint URL of COE API exposed to end-users. |
|
in: body |
|
format: uri |
|
required: true |
|
type: string |
|
apiserver_port: |
|
type: integer |
|
in: body |
|
required: true |
|
description: | |
|
The exposed port of COE API server. |
|
bay_create_timeout: |
|
type: integer |
|
in: body |
|
required: true |
|
description: | |
|
The timeout for bay creation in minutes. The value expected is a |
|
positive integer and the default is 60 minutes. If the timeout is reached |
|
during bay creation process, the operation will be aborted and the |
|
bay status will be set to ``CREATE_FAILED``. |
|
bay_id: |
|
type: UUID |
|
in: body |
|
required: true |
|
description: | |
|
The UUID of the bay. |
|
bay_list: |
|
type: array |
|
in: body |
|
required: true |
|
description: | |
|
The list of all bays in Magnum. |
|
The list of all clusters in Magnum. |
|
baymodel_id: |
|
type: UUID |
|
in: body |
|
required: true |
|
description: | |
|
The UUID of the baymodel. |
|
baymodel_list: |
|
type: array |
|
in: body |
|
required: true |
|
description: | |
|
The list of all baymodels in Magnum. |
|
binary: |
|
type: string |
|
in: body |
|
required: true |
|
description: | |
|
The name of the binary form of the Magnum service. |
|
cluster_distro: |
|
type: string |
|
in: body |
|
required: true |
|
description: | |
|
Display the attribute ``os_distro`` defined as appropriate metadata in |
|
image for the bay/cluster driver. |
|
cluster_id: |
|
type: UUID |
|
in: body |
|
required: true |
|
description: | |
|
The UUID of the cluster. |
|
cluster_list: |
|
type: array |
|
in: body |
|
required: true |
|
description: | |
|
The list of all clusters in Magnum. |
|
clusters: |
|
type: integer |
|
in: body |
|
required: true |
|
description: | |
|
The number of clusters. |
|
clustertemplate_id: |
|
type: UUID |
|
in: body |
|
required: true |
|
description: | |
|
The UUID of the cluster template. |
|
clustertemplate_list: |
|
type: array |
|
in: body |
|
required: true |
|
description: | |
|
The list of all cluster templates in Magnum. |
|
coe: |
|
type: string |
|
in: body |
|
required: true |
|
description: | |
|
Specify the Container Orchestration Engine to use. Supported COEs |
|
include ``kubernetes``, ``swarm``, ``mesos``. If your environment has |
|
additional bay/cluster drivers installed, refer to the bay/cluster driver |
|
documentation for the new COE names. |
|
coe_version: |
|
type: string |
|
in: body |
|
required: true |
|
description: | |
|
Version info of chosen COE in bay/cluster for helping client in picking |
|
the right version of client. |
|
create_timeout: |
|
type: integer |
|
in: body |
|
required: true |
|
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``. |
|
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. |
|
in: body |
|
required: true |
|
type: string |
|
csr: |
|
description: | |
|
Certificate Signing Request (CSR) for authenticating client key. |
|
|
|
The CSR will be used by Magnum to generate a signed certificate |
|
that client will use to communicate with the Bay/Cluster. |
|
in: body |
|
required: true |
|
type: string |
|
description: |
|
description: | |
|
Descriptive text about the Magnum service. |
|
in: body |
|
required: true |
|
type: string |
|
disabled_reason: |
|
description: | |
|
The disable reason of the service, ``null`` if the service is enabled or |
|
disabled without reason provided. |
|
in: body |
|
required: true |
|
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 bay and |
|
store the info for the servers. |
|
in: body |
|
format: uri |
|
required: true |
|
type: string |
|
dns_nameserver: |
|
description: | |
|
The DNS nameserver for the servers and containers in the bay/cluster to |
|
use. This is configured in the private Neutron network for the bay/cluster. |
|
The default is ``8.8.8.8``. |
|
in: body |
|
required: true |
|
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``. |
|
in: body |
|
required: true |
|
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. |
|
in: body |
|
required: true |
|
type: integer |
|
external_network_id: |
|
description: | |
|
The name or network ID of a Neutron network to provide connectivity to the |
|
external internet for the bay/cluster. This network must be an external |
|
network, i.e. its attribute ``router:external`` must be ``True``. The |
|
servers in the bay/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 bay/cluster. |
|
in: body |
|
required: true |
|
type: string |
|
fixed_network: |
|
description: | |
|
The name or network ID of a Neutron network to provide connectivity to |
|
the internal network for the bay/cluster. |
|
in: body |
|
required: false |
|
type: string |
|
fixed_subnet: |
|
description: | |
|
Fixed subnet that are using to allocate network address for nodes in |
|
bay/cluster. |
|
in: body |
|
required: false |
|
type: string |
|
flavor_id: |
|
description: | |
|
The nova flavor ID or name for booting the node servers. The default is |
|
``m1.small``. |
|
in: body |
|
required: true |
|
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. |
|
in: body |
|
required: true |
|
type: boolean |
|
floating_ip_enabled_cluster: |
|
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. |
|
in: body |
|
required: false |
|
type: boolean |
|
host: |
|
description: | |
|
The host for the service. |
|
in: body |
|
required: true |
|
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``. |
|
in: body |
|
required: false |
|
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``. |
|
in: body |
|
required: false |
|
type: string |
|
id_s: |
|
description: | |
|
The ID of the Magnum service. |
|
in: body |
|
required: true |
|
type: string |
|
image_id: |
|
description: | |
|
The name or UUID of the base image in Glance to boot the servers for the |
|
bay/cluster. The image must have the attribute ``os_distro`` defined as |
|
appropriate for the bay/cluster driver. |
|
in: body |
|
required: true |
|
type: string |
|
insecure_registry: |
|
description: | |
|
The URL pointing to users's own private insecure docker registry to |
|
deploy and run docker containers. |
|
in: body |
|
required: true |
|
type: string |
|
keypair_id: |
|
description: | |
|
The name of the SSH keypair to configure in the bay/cluster servers |
|
for ssh access. Users will need the key to be able to ssh to the servers in |
|
the bay/cluster. The login name is specific to the bay/cluster driver, for |
|
example with fedora-atomic image, default login name is ``fedora``. |
|
in: body |
|
required: true |
|
type: string |
|
labels: |
|
description: | |
|
Arbitrary labels in the form of ``key=value`` pairs. The accepted keys and |
|
valid values are defined in the bay/cluster drivers. They are used as a way |
|
to pass additional parameters that are specific to a bay/cluster driver. |
|
in: body |
|
required: false |
|
type: array |
|
links: |
|
description: | |
|
Links to the resources in question. |
|
in: body |
|
required: true |
|
type: array |
|
master_addresses: |
|
description: | |
|
List of floating IP of all master nodes. |
|
in: body |
|
required: true |
|
type: array |
|
master_count: |
|
description: | |
|
The number of servers that will serve as master for the bay/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 baymodel/cluster |
|
template, the master servers will be placed in a load balancer pool. |
|
in: body |
|
required: true |
|
type: integer |
|
master_flavor_id: |
|
description: | |
|
The flavor of the master node for this baymodel/cluster template. |
|
in: body |
|
required: false |
|
type: string |
|
master_lb_enabled: |
|
description: | |
|
Since multiple masters may exist in a bay/cluster, a Neutron load balancer |
|
is created to provide the API endpoint for the bay/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 bay/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 bay. |
|
in: body |
|
required: true |
|
type: boolean |
|
max_batch_size: |
|
description: | |
|
The max batch size each time when doing upgrade, default value is 1 |
|
in: body |
|
required: false |
|
type: int |
|
mservices: |
|
description: | |
|
A list of Magnum services. |
|
in: body |
|
required: true |
|
type: array |
|
name: |
|
description: | |
|
Name of the resource. |
|
in: body |
|
required: true |
|
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 |
|
bay/cluster. The operation and networking model are specific to the |
|
particular driver. |
|
in: body |
|
required: true |
|
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``. |
|
in: body |
|
required: false |
|
type: string |
|
node_addresses: |
|
description: | |
|
List of floating IP of all servers that serve as node. |
|
in: body |
|
required: true |
|
type: array |
|
node_count: |
|
description: | |
|
The number of servers that will serve as node in the bay/cluster. The |
|
default is 1. |
|
in: body |
|
required: true |
|
type: integer |
|
nodegroup: |
|
description: | |
|
The ID of node group. A node group is a subset of node instances within |
|
a cluster that all have the same configuration. |
|
in: body |
|
required: false |
|
type: string |
|
nodes: |
|
description: | |
|
The total number of nodes including master nodes. |
|
in: body |
|
required: true |
|
type: integer |
|
nodes_to_remove: |
|
description: | |
|
The server ID list will be removed. |
|
in: body |
|
required: false |
|
type: array |
|
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. |
|
in: body |
|
required: true |
|
type: string |
|
path: |
|
description: | |
|
Resource attribute's name. |
|
in: body |
|
required: true |
|
type: string |
|
pem: |
|
description: | |
|
CA certificate for the bay/cluster. |
|
in: body |
|
required: true |
|
type: string |
|
public_type: |
|
description: | |
|
Access to a baymodel/cluster template is normally limited to the admin, |
|
owner or users within the same tenant as the owners. Setting this flag |
|
makes the baymodel/cluster template public and accessible by other users. |
|
The default is not public. |
|
in: body |
|
required: true |
|
type: boolean |
|
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 bay/cluster backed by swift to host the |
|
images. The default is to use the public registry. |
|
in: body |
|
required: false |
|
type: boolean |
|
report_count: |
|
description: | |
|
The total number of report. |
|
in: body |
|
required: true |
|
type: integer |
|
server_type: |
|
description: | |
|
The servers in the bay/cluster can be ``vm`` or ``baremetal``. This |
|
parameter selects the type of server to create for the bay/cluster. |
|
The default is ``vm``. |
|
in: body |
|
required: true |
|
type: string |
|
stack_id: |
|
description: | |
|
The reference UUID of orchestration stack from Heat orchestration service. |
|
in: body |
|
required: true |
|
type: UUID |
|
state: |
|
description: | |
|
The current state of Magnum services. |
|
in: body |
|
required: true |
|
type: string |
|
status: |
|
description: | |
|
The current state of the bay/cluster. |
|
in: body |
|
required: true |
|
type: string |
|
status_reason: |
|
description: | |
|
The reason of bay/cluster current status. |
|
in: body |
|
required: true |
|
type: string |
|
tls_disabled: |
|
description: | |
|
Transport Layer Security (TLS) is normally enabled to secure the |
|
bay/cluster. In some cases, users may want to disable TLS in the |
|
bay/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. |
|
in: body |
|
required: true |
|
type: boolean |
|
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``. |
|
in: body |
|
required: true |
|
type: string |
|
value: |
|
description: | |
|
Resource attribute's value. |
|
in: body |
|
required: true |
|
type: string |
|
version: |
|
description: | |
|
The version. |
|
in: body |
|
required: true |
|
type: string |
|
version_id: |
|
type: string |
|
in: body |
|
required: true |
|
description: > |
|
A common name for the version in question. Informative only, it |
|
has no real semantic meaning. |
|
version_max: |
|
type: string |
|
in: body |
|
required: true |
|
description: > |
|
If this version of the API supports microversions, the maximum |
|
microversion that is supported. This will be the empty string if |
|
microversions are not supported. |
|
version_min: |
|
type: string |
|
in: body |
|
required: true |
|
description: > |
|
If this version of the API supports microversions, the minimum |
|
microversion that is supported. This will be the empty string if |
|
microversions are not supported. |
|
version_status: |
|
type: string |
|
in: body |
|
required: true |
|
description: | |
|
The status of this API version. This can be one of: |
|
|
|
- ``CURRENT``: this is the preferred version of the API to use |
|
- ``SUPPORTED``: this is an older, but still supported version of the API |
|
- ``DEPRECATED``: a deprecated version of the API that is slated for removal |
|
volume_driver: |
|
type: string |
|
in: body |
|
required: true |
|
description: > |
|
The name of a volume driver for managing the persistent storage for |
|
the containers. The functionality supported are specific to the driver.
|
|
|