Move service pods to target nodes - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Move service pods to target nodes","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/cbdfb304-9f2e-36a4-8d2f-22185509856f","info":{"title":"Crosswork Placement Manager API","description":"Placement manager provide api methods for service placement on node ,job details and event details.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/PLACEMENT/placement-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v2","securityDefinitions":{"api_key":{"description":"security definitions details","type":"apiKey","name":"Authorization","in":"header"}}},"spec":{"summary":"Move service pods to target nodes","description":"PlaceServices - Move service pods to target nodes. Currently supports robot-postgres and cw-timeseries-db services for all options. \nFor other services which are not system-critical and are in default namespace, the system will attempt to move the pods to the specified nodes, subject to the constraints of the system as best effort.User is encouraged to put the system in maintenance mode before invoking this api. Total time taken to move is proportional to the number of services and the size of the database. The system will be in maintenance mode until the move is complete.\nOnly query option is supported for Placement api query.\nnodes name: kubectl node names\nservice name: [ robot-postgres | cw-timeseries-db ]\n```\nInput: PlacementRequest\n Example:\n {\n \"service_placements\":\n [\n {\n \"service\": {\n \"name\": \"robot-postgres\",\n \"clean_data_folder\": true\n },\n \"nodes\": [\n {\n \"name\": \"fded-1bc1-fc3e-96d0-192-168-6-114-worker.cisco.com\"\n },\n {\n \"name\": \"fded-1bc1-fc3e-96d0-192-168-6-115-worker.cisco.com\"\n }\n ]\n },\n {\n \"service\": {\n \"name\": \"cw-timeseries-db\",\n \"clean_data_folder\": true\n },\n \"nodes\": [\n {\n \"name\": \"fded-1bc1-fc3e-96d0-192-168-6-114-worker.cisco.com\"\n },\n {\n \"name\": \"fded-1bc1-fc3e-96d0-192-168-6-115-worker.cisco.com\"\n }\n ]\n }\n ]\n }\n```\n```\nOutput: PlacementResponse\n Example:\n {\n \"job_id\": \"PJ6\",\n \"result\": {\n \"request_result\": \"ACCEPTED\",\n \"error\": null\n }\n }\n```","operationId":"PlacementManager_PlaceServices","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"job_id":{"type":"string"},"result":{"title":"Accepted or Rejected","type":"object","properties":{"request_result":{"description":"ResultValue indicated accept/reject for a request, not the outcome of the work itself.","type":"string","enum":["UNKNOWN_RESULT","REJECTED","ACCEPTED"],"default":"UNKNOWN_RESULT","title":"Request - reply\nresponse","$$ref":"#/definitions/placementRequestResult"},"error":{"description":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI.","type":"object","properties":{"message":{"type":"string","title":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI"}},"title":"Error associated with an Object","$$ref":"#/definitions/common_platformError"}},"description":"Result is used to convey whether an operation (individual or in a batch)\nhas been accepted or rejected. For sync API's an error or rejection indicates failure of operation.\nA string error message accompanies rejection to support troubleshooting. For notification objects,\nrejection represents failure to do intended operation.","$$ref":"#/definitions/placementResult"}},"title":"Deployment unit specification","$$ref":"#/definitions/placementPlacementResponse"},"examples":{"example":{"job_id":"PJ1","result":{"request_result":"ACCEPTED","error":{}}}}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","format":"byte","description":"Must be a valid serialized protocol buffer of the above specified type."}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","$$ref":"#/definitions/protobufAny"}}},"$$ref":"#/definitions/gatewayruntimeError"},"examples":{"example":{"error":"nil service placement","code":2,"message":"nil service placement","details":[]}}}},"parameters":[{"description":"PlaceServices - Move service pods to target nodes. Currently\nsupports robot-postgres and cw-timeseries-db services for all options. For other services\nwhich are not system-critical and are in default namespace, the system will attempt to move the pods to the\nspecified nodes , subject to the constraints of the system as best effort.\nIt is recommended to put the system in\nmaintenance mode before invoking this api. Total time taken to move is proportional to the number of services\nand the size of the database. The system will be in maintenance mode until the move is complete.\nOnly query option is supported for Placement api query.","name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"service_placements":{"type":"array","items":{"type":"object","properties":{"service":{"title":"Service name","type":"object","properties":{"name":{"type":"string","title":"Service name"},"clean_data_folder":{"type":"boolean","title":"Clean data folder - only supported for robot-postgres, cw-timeseries-db"},"pin_to_node":{"type":"boolean","title":"Pin services to node only supported for robot-postgres, cw-timeseries-db"}},"$$ref":"#/definitions/placementService"},"nodes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"Node name"}},"title":"Node","$$ref":"#/definitions/placementNode"},"title":"Node name"},"force":{"type":"boolean","title":"force placement allows to perform service placement without any checks"}},"title":"Service Placement which maps service to nodes assingment","$$ref":"#/definitions/placementServicePlacement"},"title":"Service Placement request\nCurrently only database services are supported"}},"title":"Placement Request","$$ref":"#/definitions/placementPlacementRequest"}}],"tags":["PlacementManager"],"__originalOperationId":"PlacementManager_PlaceServices","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/placement/move_services_to_nodes"}}