Commit bdc63864 authored by Spiros Koulouzis's avatar Spiros Koulouzis

Documentation

parent 0d8320e1
......@@ -21,4 +21,5 @@
/drip_transformer/nbproject/private/
/drip_parser/nbproject/private/
/drip_parser (copy)/nbproject/private/
/drip-provisioner (copy)/target/
\ No newline at end of file
/drip-provisioner (copy)/target/
/drip_parser.tar.gz
\ No newline at end of file
......@@ -71,7 +71,7 @@ public class BenchmarkController {
}
/**
* Returns sysbench results only. Not Not supported yet
* Returns sysbench results only. Not supported yet
*
* @return
*/
......
......@@ -162,7 +162,6 @@ public class CloudCredentialsController {
})
public @ResponseBody
CloudCredentials get(@PathVariable("id") String id) {
// User user = (User) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
CloudCredentials cc = cloudCredentialsService.findOne(id);
if (cc == null) {
throw new NotFoundException();
......@@ -234,7 +233,6 @@ public class CloudCredentialsController {
List<String> keyIDs = new ArrayList<>();
keyIDs.add("58da4c91f7b43a3282cacdbb");
keyIDs.add("58da4d2af7b43a3282cacdbd");
// cloudCredentials.setKeyIDs(keyIDs);
Map<String, Object> attributes = new HashMap<>();
attributes.put("myProxyEndpoint", "myproxy.egee.host.com");
attributes.put("trustedCertificatesURL", "https://dist.eugridpma.info/distribution/igtf/current/accredited/igtf-preinstalled-bundle-classic.tar.gz");
......
......@@ -39,8 +39,8 @@ import nl.uva.sne.drip.api.service.UserService;
import org.springframework.web.bind.annotation.RequestBody;
/**
* This controller is responsible for storing PlayBook descriptions that can be
* used by the planner.
* This controller is responsible for managing deployment configurations used
* by the deployer. Currently docker-compose.yml and ansible playbooks are supported.
*
* @author S. Koulouzis
*/
......@@ -78,7 +78,7 @@ public class ConfigurationController {
}
/**
* Uploads and stores a PlayBook description file
* Uploads and stores a configuration file
*
* @param file. The PlayBook description file
* @return the ID of the PlayBook description
......@@ -87,7 +87,8 @@ public class ConfigurationController {
@RolesAllowed({UserService.USER, UserService.ADMIN})
@StatusCodes({
@ResponseCode(code = 200, condition = "Successful upload"),
@ResponseCode(code = 400, condition = "Didn't upload (multipart) file or contents are not valid (e.g. not a yaml format)")
@ResponseCode(code = 400, condition = "Didn't upload (multipart) file or "
+ "contents are not valid (e.g. not a yaml format)")
})
public @ResponseBody
String toscaUpload(@RequestParam("file") MultipartFile file) {
......@@ -102,11 +103,11 @@ public class ConfigurationController {
}
/**
* Gets the PlayBook description.
* Gets the configuration contents.
*
* @param id the ID PlayBook description.
* @param id the ID configuration contents.
* @param format. the format to display the PlayBook description.
* @return the PlayBook description.
* @return the configuration contents.
*/
@RequestMapping(value = "/{id}", method = RequestMethod.GET, params = {"format"})
@RolesAllowed({UserService.USER, UserService.ADMIN})
......@@ -125,10 +126,10 @@ public class ConfigurationController {
}
/**
* Deletes the PlayBook description.
* Deletes the configuration
*
* @param id. The ID of PlayBook description to delete.
* @return The ID of the deleted PlayBook description.
* @param id. The ID of configuration
* @return The ID of the deleted configuration
*/
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
@RolesAllowed({UserService.USER, UserService.ADMIN})
......@@ -147,7 +148,7 @@ public class ConfigurationController {
}
/**
* Gets the IDs of all the stored PlayBook descriptions.
* Gets the IDs of all the stored configuration
*
* @return a list of all the IDs
*/
......
......@@ -91,6 +91,11 @@ public class DeployController {
}
}
/**
* Scales deployment
* @param scaleRequest
* @return
*/
@RequestMapping(value = "/scale", method = RequestMethod.POST)
@RolesAllowed({UserService.USER, UserService.ADMIN})
public @ResponseBody
......
......@@ -149,7 +149,7 @@ public class ToscaController {
*
* @param id the ID TOSCA description.
* @param type. Transform it to a specific type e.g. "docker_compose"
* @return the docker-compose.
* @return the docker-compose ID.
*/
@RequestMapping(value = "/transform/{id}", method = RequestMethod.GET, params = {"type"})
@RolesAllowed({UserService.USER, UserService.ADMIN})
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment