magnum_ui.api.rest package

Submodules

magnum_ui.api.rest.magnum module

class magnum_ui.api.rest.magnum.Addons(**kwargs)

Bases: django.views.generic.base.View

get(request)

url_regex = 'container_infra/available_addons/'

class magnum_ui.api.rest.magnum.Certificate(**kwargs)

Bases: django.views.generic.base.View

API for retrieving a single certificate

delete(request, cluster_id)

Rotate a certificate from a clsuter.

Returns HTTP 204 (no content) on successful deletion.

get(request, cluster_id)

Get a certificate from a cluster.

Returns the CA.pem string on success

url_regex = 'container_infra/certificates/(?P<cluster_id>[^/]+)$'

class magnum_ui.api.rest.magnum.Certificates(**kwargs)

Bases: django.views.generic.base.View

API for Magnum Certificates

post(request)

Create a new Certificate.

Returns the new Cert.pem string from csr for a cluster on success.

url_regex = 'container_infra/certificates/$'

class magnum_ui.api.rest.magnum.Cluster(**kwargs)

Bases: django.views.generic.base.View

API for retrieving a single cluster

get(request, cluster_id)

Get a specific cluster

patch(request, cluster_id)

Update a Cluster.

Returns the Cluster object on success.

url_regex = 'container_infra/clusters/(?P<cluster_id>[^/]+)$'

class magnum_ui.api.rest.magnum.ClusterConfig(**kwargs)

Bases: django.views.generic.base.View

API for retrieving config for a single cluster

get(request, cluster_id)

Get config for a specific cluster

url_regex = 'container_infra/clusters/(?P<cluster_id>[^/]+)/config$'

class magnum_ui.api.rest.magnum.ClusterResize(**kwargs)

Bases: django.views.generic.base.View

get(request, cluster_id)

Get cluster details for resize

post(request, cluster_id)

Resize a cluster

url_regex = 'container_infra/clusters/(?P<cluster_id>[^/]+)/resize$'

class magnum_ui.api.rest.magnum.ClusterTemplate(**kwargs)

Bases: django.views.generic.base.View

API for retrieving a single cluster template

get(request, template_id)

Get a specific cluster template

patch(request, template_id)

Update a Cluster Template.

Returns the Cluster Template object on success.

url_regex = 'container_infra/cluster_templates/(?P<template_id>[^/]+)$'

class magnum_ui.api.rest.magnum.ClusterTemplates(**kwargs)

Bases: django.views.generic.base.View

API for Magnum Cluster Templates

delete(request)

Delete one or more Cluster Templates by id.

Returns HTTP 204 (no content) on successful deletion.

get(request)

Get a list of the Cluster Templates for a project.

The returned result is an object with property ‘items’ and each item under this is a Cluster Template.

If a GET query param for ‘related_to’ is specified, and the setting for template filtering is set, then Horizon will only return template groups which the given template falls into, or all if none match.

post(request)

Create a new Cluster Template.

Returns the new ClusterTemplate object on success.

url_regex = 'container_infra/cluster_templates/$'

class magnum_ui.api.rest.magnum.ClusterUpgrade(**kwargs)

Bases: django.views.generic.base.View

post(request, cluster_id)

Upgrade a cluster

url_regex = 'container_infra/clusters/(?P<cluster_id>[^/]+)/upgrade$'

class magnum_ui.api.rest.magnum.Clusters(**kwargs)

Bases: django.views.generic.base.View

API for Magnum Clusters

delete(request)

Delete one or more Clusters by id.

Returns HTTP 204 (no content) on successful deletion.

get(request)

Get a list of the Clusters for a project.

The returned result is an object with property ‘items’ and each item under this is a Cluster.

post(request)

Create a new Cluster.

Returns the new Cluster object on success.

url_regex = 'container_infra/clusters/$'

class magnum_ui.api.rest.magnum.IngressControllers(**kwargs)

Bases: django.views.generic.base.View

get(request)

url_regex = 'container_infra/ingress_controllers/'

class magnum_ui.api.rest.magnum.Networks(**kwargs)

Bases: django.views.generic.base.View

API for Neutron networks for Cluster Templates creation

get(request)

Get a list of the Networks for a project.

Networks includes external and private. Also, each network has subnets. The returned result is an object with property ‘items’ and each item under this is a Network.

url_regex = 'container_infra/networks/$'

class magnum_ui.api.rest.magnum.Quota(**kwargs)

Bases: django.views.generic.base.View

API for retrieving a single Quota

delete(request, project_id, resource)

Delete one Quota by id and resource.

Returns HTTP 204 (no content) on successful deletion.

get(request, project_id, resource)

Get a specific quota

patch(request, project_id, resource)

Update a Quota.

Returns the Quota object on success.

url_regex = 'container_infra/quotas/(?P<project_id>[^/]+)/(?P<resource>[^/]+)$'

class magnum_ui.api.rest.magnum.Quotas(**kwargs)

Bases: django.views.generic.base.View

API for Magnum Quotas

get(request)

Get a list of the Quotas for a project.

The returned result is an object with property ‘items’ and each item under this is a Quota.

post(request)

Create a new Quota.

Returns the new Quota object on success.

url_regex = 'container_infra/quotas/$'

class magnum_ui.api.rest.magnum.Stats(**kwargs)

Bases: django.views.generic.base.View

API for Magnum Stats

get(request)

Get a list of the Stats.

The returned result is an object with property ‘items’ and each item under this is a Stat.

url_regex = 'container_infra/stats/$'

magnum_ui.api.rest.magnum.change_to_id(obj)

Change key named ‘uuid’ to ‘id’

Magnum returns objects with a field called ‘uuid’ many of Horizons directives however expect objects to have a field called ‘id’.

Module contents