org.openstack4j.api.magnum

Interface MagnumService

All Superinterfaces:

RestService

All Known Implementing Classes:

MagnumServiceImpl

public interface MagnumService
extends RestService

OpenStack Container Infrastructure Management service (Magnum) APIs

Author:

Sohan Sangwan

Method Summary

Modifier and Type	Method and Description
Bay	createBay(Bay bay) Creates a new bay
Baymodel	createBaymodel(Baymodel baymodel) Creates a new baymodel
Cluster	createCluster(Cluster cluster) Create new cluster based on cluster template
Clustertemplate	createClustertemplate(Clustertemplate template) Create new cluster template
Container	createContainer(Container container) Creates a new Container
Pod	createPod(Pod pod) Create a pod
ActionResponse	deleteBay(String id) Deletes a bay
ActionResponse	deleteBaymodel(String id) Deletes a baymodel
ActionResponse	deleteCluster(String id) Delete a cluster.
ActionResponse	deleteClustertemplate(String id) Delete a cluster template
ActionResponse	deleteContainer(String uuid) Deletes a Container
ActionResponse	deletePod(String bayUuid, String id) Delete a pod
String	execCmdInContainer(String id, String cmd) Execute command in a Container
Certificate	getCertificate(String uuid) Gets certificate
String	getContainerLogs(String id) Get logs of a Container
List<? extends Baymodel>	listBaymodels() Lists all Baymodels
List<? extends Bay>	listBays() Lists all Bays/clusters
List<? extends Cluster>	listClusters() List all clusters
List<? extends Clustertemplate>	listClustertemplate() List all cluster templates
List<? extends Container>	listContainers() Lists all Containers
List<? extends Mservice>	listMservices() Lists all Magnum Services: container infrastructure service status details
List<? extends Pod>	listPods(String bayUuid) List all pods
Container	pauseContainer(String id) Pause a Container
Container	rebootContainer(String id) Reboot a Container
ActionResponse	rotateCertificate(String uuid) Rotate the CA certificate for a bay/cluster and invalidate all user certificates.
Bay	showBay(String id) Show a bay
Baymodel	showBaymodel(String id) Gets all information of a baymodel
Cluster	showCluster(String id) Get all information of a cluster in Magnum
Container	showContainer(String id) Show a Container
Pod	showPod(String bayUuid, String id) Show a pod
Certificate	signCertificate(Carequest ca) Generates certificate
Container	startContainer(String id) Start a Container
Container	stopContainer(String id) Stop a Container
Container	unpauseContainer(String id) Unpause a Container
Bay	updateBay(String id, String operations) Update bay
Baymodel	updateBaymodel(String id, String operations) Updates baymodel attributes
Cluster	updateCluster(String id, String operations) Update information of one cluster attributes using operations including: ``add``, ``replace`` or ``remove``.
Clustertemplate	updateClustertemplate(String id, String operations) Update information of one cluster template attributes using operations including: ``add``, ``replace`` or ``remove``.
Container	updateContainer(String id, String operations) Update a container
Pod	updatePod(String bayUuid, String id, String operations) Update a pod

Method Detail

listMservices

List<? extends Mservice> listMservices()

Lists all Magnum Services: container infrastructure service status details

Returns:

list of Magnum Services

listBaymodels

List<? extends Baymodel> listBaymodels()

Lists all Baymodels

Returns:

list of Baymodels

createBaymodel

Baymodel createBaymodel(Baymodel baymodel)

Creates a new baymodel

Parameters:

baymodel -

Returns:

deleteBaymodel

ActionResponse deleteBaymodel(String id)

Deletes a baymodel

Parameters:

id -

Returns:

showBaymodel

Baymodel showBaymodel(String id)

Gets all information of a baymodel

Parameters:

id -

Returns:

baymodel information

updateBaymodel

Baymodel updateBaymodel(String id,
                        String operations)

Updates baymodel attributes

Parameters:

id -

operations -

Returns:

updated baymodel

listBays

List<? extends Bay> listBays()

Lists all Bays/clusters

Returns:

list of Bays

createBay

Bay createBay(Bay bay)

Creates a new bay

Parameters:

bay -

Returns:

newly created bay

deleteBay

ActionResponse deleteBay(String id)

Deletes a bay

Parameters:

id -

Returns:

showBay

Bay showBay(String id)

Show a bay

Parameters:

id -

Returns:

bay

updateBay

Bay updateBay(String id,
              String operations)

Update bay

Parameters:

id -

operations -

Returns:

listContainers

List<? extends Container> listContainers()

Lists all Containers

Returns:

list of Containers

createContainer

Container createContainer(Container container)

Creates a new Container

Parameters:

baymodel -

Returns:

newly created Container

deleteContainer

ActionResponse deleteContainer(String uuid)

Deletes a Container

Parameters:

id -

Returns:

success/failure response

execCmdInContainer

String execCmdInContainer(String id,
                          String cmd)

Execute command in a Container

Parameters:

id -

cmd -

Returns:

output of the command

getContainerLogs

String getContainerLogs(String id)

Get logs of a Container

Parameters:

id -

Returns:

logs

pauseContainer

Container pauseContainer(String id)

Pause a Container

Parameters:

id -

Returns:

paused Container

unpauseContainer

Container unpauseContainer(String id)

Unpause a Container

Parameters:

id -

Returns:

paused Container

rebootContainer

Container rebootContainer(String id)

Reboot a Container

Parameters:

id -

Returns:

rebooted Container

startContainer

Container startContainer(String id)

Start a Container

Parameters:

id -

Returns:

Container

stopContainer

Container stopContainer(String id)

Stop a Container

Parameters:

id -

Returns:

Container

showContainer

Container showContainer(String id)

Show a Container

Parameters:

id -

Returns:

Container

updateContainer

Container updateContainer(String id,
                          String operations)

Update a container

Parameters:

id -

operations -

Returns:

getCertificate

Certificate getCertificate(String uuid)

Gets certificate

Parameters:

uuid - of a bay or cluster

Returns:

certificate

signCertificate

Certificate signCertificate(Carequest ca)

Generates certificate

Parameters:

ca - request

Returns:

certificate

rotateCertificate

ActionResponse rotateCertificate(String uuid)

Rotate the CA certificate for a bay/cluster and invalidate all user certificates.

Parameters:

uuid - of a bay or cluster

Returns:

status

createCluster

Cluster createCluster(Cluster cluster)

Create new cluster based on cluster template

Parameters:

cluster -

Returns:

listClusters

List<? extends Cluster> listClusters()

List all clusters

Returns:

showCluster

Cluster showCluster(String id)

Get all information of a cluster in Magnum

Parameters:

id - of the cluster

Returns:

cluster

deleteCluster

ActionResponse deleteCluster(String id)

Delete a cluster.

Parameters:

id - of the cluster

Returns:

success status

updateCluster

Cluster updateCluster(String id,
                      String operations)

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.

Parameters:

id -

operations -

Returns:

updated cluster

createClustertemplate

Clustertemplate createClustertemplate(Clustertemplate template)

Create new cluster template

Parameters:

template -

Returns:

newly created cluster template

listClustertemplate

List<? extends Clustertemplate> listClustertemplate()

List all cluster templates

Returns:

list of cluster templates

deleteClustertemplate

ActionResponse deleteClustertemplate(String id)

Delete a cluster template

Parameters:

id - of the clustertemplate

Returns:

status

updateClustertemplate

Clustertemplate updateClustertemplate(String id,
                                      String operations)

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.

Parameters:

cluster - template

Returns:

updated clustser template

listPods

List<? extends Pod> listPods(String bayUuid)

List all pods

Returns:

list of pods

createPod

Pod createPod(Pod pod)

Create a pod

Parameters:

pod -

Returns:

pod

deletePod

ActionResponse deletePod(String bayUuid,
                         String id)

Delete a pod

Parameters:

bayUuid -

id -

Returns:

status

showPod

Pod showPod(String bayUuid,
            String id)

Show a pod

Parameters:

bayUuid -

id -

Returns:

pod

updatePod

Pod updatePod(String bayUuid,
              String id,
              String operations)

Update a pod

Parameters:

bayUuid -

id -

Returns:

pod