{"type":"doc","content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"8ff999fb-ff28-491d-8e0d-18bf95ecb5f6"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Background","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The DCM is one of the components of ONAP4K8s. It will run as a microservice exposing Rest APIs, external components will use REST to communicate with the DCM while other microservices will use gRPC. The DCM will perform the following functions;","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"User creation (currently one user per logical cloud)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Namespace creation (currently one namespace per logical cloud)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Generate intermediate CA key for each edge which is signed by a root or intermediate key","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Logical Cloud creation - Create Istio control planes for the logical clouds.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Different components (microservice) work together with the DCM to make the above possible, the components are;","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Main DCM Microservice (contains the service mesh Module(formally Logical Cloud Controller), User Module and Namespace Module, Quota Module(Limits resources available to each logical cloud))","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CA Key Distribution Controller","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/display/DW/CA+Key+distribution+Controller"}}]},{"text":" ( ","type":"text"},{"text":"Generate intermediate CA key for each edge which is signed by an root or intermediate key)","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Design Overview","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"drawio","parameters":{"macroParams":{"border":{"value":"true"},"viewerToolbar":{"value":"true"},"":{"value":""},"fitWindow":{"value":"false"},"diagramDisplayName":{"value":""},"lbox":{"value":"true"},"revision":{"value":"17"},"diagramName":{"value":"DCM"},"simpleViewer":{"value":"false"},"width":{"value":"1000"},"links":{"value":"auto"},"tbstyle":{"value":"top"},"diagramWidth":{"value":"721"}},"macroMetadata":{"macroId":{"value":"5cd3ecc8-6934-4f24-8085-ecd4a92478a1"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"image","data":{"url":"https://ac.draw.io/connectImage?border=true&viewerToolbar=true&=&fitWindow=false&diagramDisplayName=&lbox=true&revision=17&diagramName=DCM&simpleViewer=false&width=1000&links=auto&tbstyle=top&diagramWidth=721"}}],"title":"draw.io Diagram"}}}},{"type":"paragraph","content":[{"text":"Fig 1: DCM Components","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"DCM Sequence","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Client creates logical cloud using ","type":"text"},{"text":"logical cloud creation API","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/pages/viewpage.action?pageId=16407653#DistributedCloudManager(DCM)-APItoCreateLogicalCloudNameandAssociatesomecomponents"}}]},{"text":" and the following documents are created in the DCM collection","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The core module parses the Json and creates a new document for the logical cloud in the mongodb DCM collection.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The core module also creates a cluster document in the DCM collection","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The user module parses the Json and creates a new document for user ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The namespace module parses the Json and creates a new document for namespace","type":"text","marks":[{"type":"strike"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Associates logical cloud with clusters (this API is called multiple times)","type":"text"},{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Updates the cluster document with the cluster name, loadbalancer ip every time its called","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add quota for logical cloud","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The quota module creates a quota document containing the quota details","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Apply API is called","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Service mesh module gets CA bundle from CA controller via gRPC","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Service mesh module gets names of logical cloud and creates a new namespace name using name of logical cloud name","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Service mesh module creates helm template/istioctl manifest (WIP)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Service mesh module creates service mesh document in the DCM collection and stores the above (CA bundle contents, istio namespace, istioctl manifest) in the document","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DCM informs the resource synchronizer to start the logical cloud creation via gRPC and the resource synchronizer starts reading from the DB","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The DCM gets status from the resource synchronizer via gRPC","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" When the logical cloud creation is complete, the resource synchronizer will store the modified kubeconfig file for each cluster in the cluster document of the logical cloud","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"The details of the DCM Data Model can be found in ","type":"text"},{"text":"DCM MongoDB Data Model","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/display/DW/DCM+MongoDB+Data+Model"}},{"type":"strong"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"DCM Source Code Directory Structure","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"dcm","type":"text"},{"type":"hardBreak"},{"text":"├── ","type":"text"},{"text":"core","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"type":"hardBreak"},{"text":"│ └── main.go","type":"text"},{"type":"hardBreak"},{"text":"├── ","type":"text"},{"text":"namespace-controller","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"type":"hardBreak"},{"text":"│ └── namespace.go","type":"text"},{"type":"hardBreak"},{"text":"├── ","type":"text"},{"text":"quota-controller","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"type":"hardBreak"},{"text":"│ └── quota.go","type":"text"},{"type":"hardBreak"},{"text":"├── ","type":"text"},{"text":"service-mesh-controller","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"type":"hardBreak"},{"text":"│ └── service-mesh.go","type":"text"},{"type":"hardBreak"},{"text":"└── ","type":"text"},{"text":"user-controller","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"type":"hardBreak"},{"text":" └── user.go","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"GO API","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"text":"func createNamespace(logicalCloudName Namespace string) error //Stores the namespace for the logical cloud in the database\n\nfunc createUser(user logicalCloudName string permissions []map[string]map[string][]string) error //Stores the user details for the logical cloud in the database\n\nfunc createKVpair(name description string userData map[string]string kvPair []map[string]string) error //Stores a new key value pair in the database\n\nfunc addCluster(cluster logicalCloudName string) error //Associates a new cluster with the logical cloud\n\nfunc addUserPermissions(user permissionName string apiGroups resources verbs []string) error\n\nfunc applyConfig(logicalCloudName string) error //Talks to the Resource Synchronizer to start the actual creation of all the resources for the logical cloud\n\nfunc getKVPair(name string) ([]map[string]string error)\n\nfunc getClusterConfig(cluster logicalCloudName string) ([]byte, error) //Returns Kubeconfig for the cluster in JSON format\n\nfunc getNamespace(logicalCloudName string) (string error)\n\nfunc getUser(logicalCloudName string) (string error)\n\nfunc getClusters(logicalCloudName string) ([]string error)\n\nfunc getUserPermissions(user string) (([]map[string]map[string][]string) error) //Sample output [{\"permission-1\": {\"apiGroups\": [\"stable.example.com\"], \"resources\" : [\"secrets\", \"pods\"], \"verbs\" : [\"get\", \"watch\", \"list\", \"create\"] }}, \n {\"permission-2\": {\"apiGroups\": [\"\"], \"resources\" : [\"configmaps\"], \"verbs\" : [\"*\"] }}]\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Service Mesh API","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Service Mesh API","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"visualbasic"},"content":[{"text":"\nfunc create_mesh () {\n\n func get_lc_clusters() (map[string]string) //Returns a map containing a mapping of cluster names to load balancer ip address\n\tfunc create_mesh_namespace(logical-cloud-name, []clusters)\n\n\tfunc create_ca_secrets(logical-cloud-name){\n\t\tfunc get_ca_certs(url)\n\t}\n\n\tfunc install_helm([] clusters) (or install istioctl)\n\tfunc create_helm_chart() (or istioctl manifest)\n}\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"REST API","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API to Create Logical Cloud Name and Associate some components","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Create Logical cloud name for new logical cloud, add user name, namespace and user permissions","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Logical Cloud Creation API","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds\nPOST BODY:\n{\n \"metadata\" : {\n \t\"name\": \"lc-1\", //unique name for the record\n \"description\": \"logical cloud for walmart finance department\", //description for the logical cloud \n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\" : {\n\t\"namespace\" : \"ns-1\", // one namespace per logical cloud\n \t\"user\" : {\n \"user-name\" : \"user-1\", //name of user for this cloud (username and logical cloud name would be used as subject for the user key)\n \"type\" : \"certificate\", //type of authentication credentials used by user (certificate, Token, UNPW)\n \"user-permissions\" : [\n { \"permission-name\" : \"permission-1\",\n \"apiGroups\" : [\"stable.example.com\"],\n \"resources\" : [\"secrets\", \"pods\"],\n \"verbs\" : [\"get\", \"watch\", \"list\", \"create\"]\n },\n { \"permission-name\" : \"permission-2\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"configmaps\"],\n \"verbs\" : [\"*\"]\n }\n ]\n }\n }\n}\n\nReturn Status: 201\nReturn Body:\n{\n \"name\" : \"logical-cloud-1\",\n \"logical-cloud-name\" : \"logical-cloud-1\",\n \"namespace\" : \"ns-1\",\n \"user-name\" : \"user-1\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"PUT (Change logical cloud contents)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"PUT Logical Cloud","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds/\nPUT BODY:\n{\n \"metadata\" : {\n\t\"name\": \"lc-1\",\n \"description\": \"logical cloud for walmart finance department\", //description for the logical cloud \n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\" : {\n\t\"namespace\" : \"ns-1\", // one namespace per logical cloud\n \t\"user\" : {\n \"user-name\" : \"user-1\", //name of user for this cloud (username and logical cloud name would be used as subject for the user key)\n \"type\" : \"certificate\", //type of authentication credentials used by user (certificate, Token, UNPW)\n \"user-permissions\" : [\n { \"permission-name\" : \"permission-1\",\n \"apiGroups\" : [\"stable.example.com\"],\n \"resources\" : [\"secrets\", \"pods\"],\n \"verbs\" : [\"get\", \"watch\", \"list\", \"create\"]\n },\n { \"permission-name\" : \"permission-2\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"configmaps\"],\n \"verbs\" : [\"*\"]\n }\n ]\n }\n }\n}\n\nReturn Status: 200 (OK)\nReturn Body:\n{\n \"name\" : \"logical-cloud-1\",\n \"logical-cloud-name\" : \"logical-cloud-1\",\n \"namespace\" : \"ns-1\",\n \"user\" : \"user-1\"\n}\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"GET Logical Cloud","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"GET Logical Cloud","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"GET\nURL: /v2/projects//logical-clouds/\nRESPONSE BODY:\n{\n \"metadata\" : {\n \t\"name\": \"lc-1\", //unique name for the record\n \"description\": \"logical cloud for walmart finance department\", //description for the logical cloud \n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\" : {\n\t\"namespace\" : \"ns-1\", // one namespace per logical cloud\n \t\"user\" : {\n \"user-name\" : \"user-1\", //name of user for this cloud (username and logical cloud name would be used as subject for the user key)\n \"type\" : \"certificate\", //type of authentication credentials used by user (certificate, Token, UNPW)\n \"user-permissions\" : [\n { \"permission-name\" : \"permission-1\",\n \"apiGroups\" : [\"stable.example.com\"],\n \"resources\" : [\"secrets\", \"pods\"],\n \"verbs\" : [\"get\", \"watch\", \"list\", \"create\"]\n },\n { \"permission-name\" : \"permission-2\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"configmaps\"],\n \"verbs\" : [\"*\"]\n }\n ],\n \"clusters\" : [\"cluster-1\", \"cluster-2\", \"cluster-3]\n }\n }\n}\n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"DELETE Logical Cloud","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"DELETE Logical Cloud","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"DELETE\nURL: /v2/projects//logical-clouds/\n\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Logical Cloud Cluster API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":" POST (Associate cluster with logical cloud )","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Associate logical cloud with cluster","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//cluster-references/\nPOST BODY:\n{\n \"metadata\" : {\n \t\"name\": \"lc-cl-1\",\n \"description\": \"desc\",\n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n\n \"spec\" : {\n\t\"cluster-provider\": \"cp-1\",\n\t\"cluster-name\": \"c1\", //name of the cluster,\n\t\"loadbalancer-ip\" : \"0.0.0.0\" //IP address of the istio loadbalancer for the logical cloud control plane in the cluster\n }\n}\n\n\n\n \n}\nReturn Status: 200 (OK)\nReturn Body:\n{\n \"cluster-name\" : \"cluster-1\"\n \"loadbalancer-ip\" : \"0.0.0.0\"\n}\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"PUT","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update cluster in logical cloud","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//cluster-references/cluster-name\nPUT BODY:\n{\n \"loadbalancer-ip\" : \"0.0.0.0\" //IP address of the istio loadbalancer for the logical cloud control plane in the cluster\n}\nReturn Status: 200 (OK)\nReturn Body:\n{\n \"cluster-name\" : \"cluster-1\"\n \"loadbalancer-ip\" : \"0.0.0.0\"\n \n}","type":"text"}]},{"type":"paragraph","content":[{"text":"GET","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get Clusters Associated with logical clouds","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"GET\nURL: /v2/projects//logical-clouds//cluster-references/\n\nRESPONSE BODY:\n{ cluster-references : [\n { \"cluster-name\" : \"c1\",\n \"loadbalancer-ip\" : \"0.0.0.0\n },\n { \"cluster-name\" : \"c2\",\n \"loadbalancer-ip\" : \"x.x.x.x\n }\n]\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"DELETE (Delete cluster from Logical cloud)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete Cluster from logical cloud","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"DELETE\nURL: /v2/projects//logical-clouds//cluster-references/\nRESPONSE STATUS: 204\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Logical Cloud User Permissions API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":" Add user permissions","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Add User permissions","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//user-permissions\nPOST BODY:\n \n{ \"name\" : \"permission-3\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"jobs\"],\n \"verbs\" : [\"list\"]\n}\n \nReturn Status: 200 (OK)\nReturn Body:\n{ \"name\" : \"permission-3\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"jobs\"],\n \"verbs\" : [\"list\"]\n}\n \n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"GET User Permissions","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get User permissions","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//user-permissions\nGET:\nReturn Body: \n{\"permissions\" : [\n { \"name\" : \"permission-1\",\n \"apiGroups\" : [\"stable.example.com\"],\n \"resources\" : [\"secrets\", \"pods\"],\n \"verbs\" : [\"get\", \"watch\", \"list\", \"create\"]\n },\n { \"name\" : \"permission-2\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"configmaps\"],\n \"verbs\" : [\"*\"]\n },\n { \"name\" : \"permission-3\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"jobs\"],\n \"verbs\" : [\"list\"]\n }\n ]\n}\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"PUT (Update User permissions)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update User permissions","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//user-permissions/permission-3\nPOST BODY:\n \n{\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"pvc\"],\n \"verbs\" : [\"list\"]\n}\n \nReturn Status: 200 (OK)\nReturn Body:\n{ \"name\" : \"permission-3\",\n \"apiGroups\" : [\"\"],\n \"resources\" : [\"pvc\"],\n \"verbs\" : [\"list\"]\n}\n \n","type":"text"}]},{"type":"paragraph","content":[{"text":" Delete User Permissions","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete User permissions","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"DELETE\nURL: /v2/projects//logical-clouds//user-permissions/\nRETURN STATUS: 204\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Logical Cloud Quota API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Create logical cloud Quota ( quota will be applied to each cluster in the logical cloud)","type":"text"}]},{"type":"paragraph","content":[{"text":"This allows resources to be tuned for the logical cloud","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create Logical cloud quota","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//cluster-quotas\nPOST BODY:\n{\n \"metadata\" : {\n \"name\" : \"quota-1\",\n \"description\": \"desc\"\n },\n \"spec\" : {\n \"limits.cpu\": \"400\",\n \"limits.memory\": \"1000Gi\",\n \"requests.cpu\": \"300\",\n \"requests.memory\": \"900Gi\",\n \"requests.storage\" : \"500Gi\",\n \"requests.ephemeral-storage\": \"\",\n \"limits.ephemeral-storage\": \"\",\n \"persistentvolumeclaims\" : \" \", \n \"pods\": \"500\", \n \"configmaps\" : \"\",\n \"replicationcontrollers\": \"\",\n \"resourcequotas\" : \"\",\n \"services\": \"\",\n \"services.loadbalancers\" : \"\",\n \"services.nodeports\" : \"\",\n \"secrets\" : \"\",\n \"count/replicationcontrollers\" : \"\",\n \"count/deployments.apps\" : \"\",\n \"count/replicasets.apps\" : \"\",\n \"count/statefulsets.apps\" : \"\",\n \"count/jobs.batch\" : \"\",\n \"count/cronjobs.batch\" : \"\",\n \"count/deployments.extensions\" : \"\"\n } \n}\n\nRETURN STATUS: 201","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":" GET logical cloud Quota","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get Logical cloud quota","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"GET\nURL: /v2/projects//logical-clouds//cluster-quotas/\nRETURN BODY:\n{\n \"metadata\" : {\n \"name\" : \"quota-1\",\n \"description\": \"desc\"\n },\n \"spec\" : {\n \"cpu\": \"400\",\n \"memory\": \"1000Gi\",\n \"pods\": \"500\"\n } \n}\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Update Logical Cloud Quota","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update Logical cloud quota","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//cluster-quotas/\nPUT BODY:\n{\n \"metadata\" : {\n \"description\": \"desc\"\n },\n \"spec\" : {\n \"cpu\": \"400\",\n \"memory\": \"1000Gi\",\n \"pods\": \"500\"\n } \n}\n\nRETURN STATUS: 201","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Delete Logical Cloud Quota","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update Logical cloud quota","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"DELETE\nURL: /v2/projects//logical-clouds//cluster-quotas/\n\nRETURN STATUS: 204","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Logical Cloud Key Value API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"16. Add Key Value pair to logical cloud database","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Add KV pair","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//kv-pairs\nPOST BODY\n{\n \"metadata\":{\n \"name\":\"\",\n \"description\":\"\",\n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\":{\n \"kv\":[\n {\n \"key1\":\"val1\"\n },\n {\n \"key2\":\"val2\"\n }\n ]\n }\n}\n \nRETURN STATUS: 201\nRETURN BODY:\n{\n \"metadata\":{\n \"name\":\"\",\n \"description\":\"\",\n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\":{\n \"kv\":[\n {\n \"key1\":\"val1\"\n },\n {\n \"key2\":\"val2\"\n }\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"17. PUT (Update kv pair)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update KV pair","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//kv-pairs/\nPUT BODY\n{\n \"metadata\":{\n \"description\":\"\",\n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\":{\n \"kv\":[\n {\n \"key1\":\"val3\"\n },\n {\n \"key2\":\"val4\"\n }\n ]\n }\n}\nRETURN STATUS: 201\nRETURN BODY:\n{\n \"metadata\":{\n \"description\":\"\",\n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\":{\n \"kv\":[\n {\n \"key1\":\"val3\"\n },\n {\n \"key2\":\"val4\"\n }\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"18. GET KV pair","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get KV pair","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//kv-pairs/\n\nRETURN STATUS: 200\nRETURN BODY:\n{\n \"metadata\":{\n \"name\":\"\",\n \"description\":\"\",\n \"userData1\":\"\",\n \"userData2\":\"\"\n },\n \"spec\":{\n \"kv\":[\n {\n \"key1\":\"val1\"\n },\n {\n \"key2\":\"val2\"\n }\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"19. DELETE KV pair","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete KV pair","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//kv-pairs/\n\nRETURN STATUS: 204\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Kubeconfig API (WORK IN PROGRESS)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Important points to Note","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cluster CA and cluster CRT will be gotten when a cluster is registered and this will be used to create the user crt after the user csr and user key are created","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Kubeconfig will be put in the mongoDB","type":"text"}]},{"type":"paragraph","content":[{"text":"2. Get Logical Cloud kubeconfig","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get Logical cloud kubeconfig","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//kubeconfig?cluster-reference=cluster-1\nGET\nReturn Status: 201\nReturn Body :\n {\n \"apiVersion\": \"v1\",\n \"clusters\": [\n {\n \"cluster\": {\n \"certificate-authority-data\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRJd01ERXhOakl5TlRReU1sb1hEVE13TURFeE16SXlOVFF5TWxvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTXZ5ClpSMmtHZ201OHJtRUYxZ0VVNDlwR281TjR5WlZzbUtsemJxeitHcmp3MWY4ZHBaa01JN1RYbm1xaXdjbmpiZksKdlZDYmFKblBwRm9Wc0gyMTFMRVYxa1pqQ2RZakgrQnA4VUNadFpOZnJha1o1TU91RW40MXlpbDRxVTFxRnBYcgpvMnAvTTJNSTc0bzdYSis5V2VUNmZ1MFJ0RjRjK1p6K3IzbWY3YWFnem9weEo1TzcyN010WkN5bzJHaWNJdzgyCk1uSmUrbHBnNDdEdTNwK0JzOVZ4cENNVjhUTFBDWWFxVUZHZWZ1U25zTHpCOWFHUGJaMi9kWlMrQll6VGJ1dWIKZ0pzbmxKd1o2Z1orVkJKWGtxcFN4ZmJTWFE3V2VLR1BkMkptYk04THFtd2UxcEtIMnNnVEs0cnBuM3dKdzk1Uwp5c01LZWp5aS9TcmZWci9ZdmRNQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFIRkJ3VUJrRE56MDV3cGlVVkhaeld3Z0JWWTgKTFRIV2RZYUliaTZzeCthTUhIOFF3cERhSUIvME9KUlZmc01XNXd2eldTWE05d28zR2ltMlYxNnBsN0E3ZXRkLwo3OWZiT0FaTTh0bUFHMVlraFlJbjc0NzRvaE5GZjhLdjFqY3ZIUStIREZZRTRHdTBXUXhBQU9sRmh2SUNKc1VDCmRrN25mREpMRTIwa1E0M1ZIMnc3Ukg3clFVcUVNVnhVU2VTTWdid0xEQms5bWFQNm83RjdsT0ZqQnJibmhaVlgKNDA3U3Z2aTFRM0x6eCtubklhY3RidkZaUGFDRlpPMlkvS0dpcFpYM3o0R3hiR0sxM3VweExuSllHZEI4eFBrRApmK3FISFYvMHVVV2Yzb2JpSUNTT09qUjF5VnB3eXdIVFcrTHhyM1BZcXQ5b0NTRXErYitPUDE2SVV5az0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=\",\n \"server\": \"https://1.2.3.4:6443\"\n },\n \"name\": \"kubernetes\"\n }\n ],\n \"contexts\": [\n {\n \"context\": {\n \"cluster\": \"cluster-1\",\n \"user\": \"user-1\"\n },\n \"name\": \"user-1-context\"\n }\n ],\n \"current-context\": \"user-1-context\",\n \"kind\": \"Config\",\n \"users\": [\n {\n \"name\": \"user-1\",\n \"user\": {\n \"client-certificate-data\" : \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUM4akNDQWRxZ0F3SUJBZ0lJZVovY05tQVE5NGd3RFFZSktvWklodmNOQVFFTEJRQXdGVEVUTUJFR0ExVUUKQXhNS2EzVmlaWEp1WlhSbGN6QWVGdzB5TURBeE1UWXlNalUwTWpKYUZ3MHlNVEF4TVRVeU1qVTBNamhhTURReApGekFWQmdOVkJBb1REbk41YzNSbGJUcHRZWE4wWlhKek1Sa3dGd1lEVlFRREV4QnJkV0psY201bGRHVnpMV0ZrCmJXbHVNSUlCSWpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQW0zblA0eTdURjNrZldaZFoKaFdaV2RTSWZlNlpkbTdWK1BpcER6UWFHMTVuU0ZNSVRSeFVyYkhHdWlzakZQRlAzbUIyT09yN3BSQjJab3VDegppOFlYS21iYjJ6K2tjeWZxT1drcHhmTzlHQlV6SlYxL1BoUGU2dGRaSEp3c3FtNlhYZ2xkcTEvNjBSTWNwUVUxCi9LOXNZNHhWQ1djSkN4SEkvTnp4VDY0TU5zQlF3VldONXZWTTJOUDJtZDFOa2x2S3J2bnFRUERXTGxVWEx2THIKK2NESk50VytxcFc4dzVreXF5YWp1ZHQ4ZGw0dzZSY3FnL3VnbXRVMHRnVEdxcFdSYm5yZlFMSzBsaGJKejVMTgpmK1pNTjRCYllxWGRBZ2hFMTNEeHhYd2tHUHdnL3h0aFhManBaQzhjeTNlV0hCenV2cWY1aWJ2S0hRQ20zRmFjCjhBTlVpUUlEQVFBQm95Y3dKVEFPQmdOVkhROEJBZjhFQkFNQ0JhQXdFd1lEVlIwbEJBd3dDZ1lJS3dZQkJRVUgKQXdJd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFDV3BuY1RhTWowOWZDL25CQTF1NWhkbFQrQmdhc3NZSFVEeQplM2tQUXJlUXdseUhYTGtWdDdiSkIxT0l6Y1V3K2M5MVF6Mm9lRFBaNzZGNGlQMTd5RUgrUFZrMVVUSzBLRU9jCjM2cVpXTUdMK0ptZy9wTnFBNXRsNG1EUTVneFhHTENpa2JiYzRTM0oxL0FicmFVakRtM1FEOTd6UEhSUkZnN2oKN2VXMnB2V3ZEakRTWDZGejY0dEorRHB2NUpGZGRHNU5lQVErZ0hNOWFPVUdCVG1oZlYzZnl1NzkzV0cyUGlxMgpMMlZQU0YycU5DRG96Y3Z3am84VHkxbUpXSzIvTkVjN2ZMd24wbml3UTd3aXpMWHU0N1hvL3Frb2pBMUN6MW9YCkhid1JQMjZXdVNDTGpnNnpHVUh3VnBZWmV4Z3pkY05CRERQTnlPem94RTFwUVlXRXkrZz0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=\",\n\t\t\t\t\"client-key-data\" : \"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBbTNuUDR5N1RGM2tmV1pkWmhXWldkU0lmZTZaZG03VitQaXBEelFhRzE1blNGTUlUClJ4VXJiSEd1aXNqRlBGUDNtQjJPT3I3cFJCMlpvdUN6aThZWEttYmIyeitrY3lmcU9Xa3B4Zk85R0JVekpWMS8KUGhQZTZ0ZFpISndzcW02WFhnbGRxMS82MFJNY3BRVTEvSzlzWTR4VkNXY0pDeEhJL056eFQ2NE1Oc0JRd1ZXTgo1dlZNMk5QMm1kMU5rbHZLcnZucVFQRFdMbFVYTHZMcitjREpOdFcrcXBXOHc1a3lxeWFqdWR0OGRsNHc2UmNxCmcvdWdtdFUwdGdUR3FwV1JibnJmUUxLMGxoYkp6NUxOZitaTU40QmJZcVhkQWdoRTEzRHh4WHdrR1B3Zy94dGgKWExqcFpDOGN5M2VXSEJ6dXZxZjVpYnZLSFFDbTNGYWM4QU5VaVFJREFRQUJBb0lCQURSeCs3RTd5MU1ndFhXSQpPMWRuZFFTZ0ZSU2x3dS9TWWhwZ01XeklwZFcyZW9vc0NVcXlGbXJIVWtSWWcwZmRYeWk5MTR0emVNWlVZYzN5CmxENHkvUDk5b080dFlyREJweDNrbm9XNnVXK1ZQeUo4am42SFAydmlacG5qQ0tJWkdoQkxnb0JicVFTN3VLN2wKdWhkWnFXdFBIQ1JHMEdNZWhiamVZcndwRHMrc3V5Y0tUNlh2OGR0am9PRGlSenpodTBBWjErSDBMbC9MaUp5NgpubUF1M3IzUDN2dGt1ZndoOXB2SjA2TjhHVWhRZFlvVENBMHQ4c0lEN0Q0ZUZGcXdjM2FVTmlyVGdtcllmcVFkCnJQMnRUMkYxbEE5bEJ1bUJmNDBCUFMrejR0MS92Tk5XSEtseFFzaDRkTnNJczlFbHB1YkVTMlovbmJkUHpEOXUKUHlmWmNCMENnWUVBemZEZ21TVVZ2REpJMEZWWnNENWszNWxRWFpmQ3ZLZWpaaU5ScTZzaDlROUhBcTdaN3dESwo3RmNHSGZFQVhNZ1YyQ2VibUtkbFZ4aFJMQUVQb0todzNCbG94RlhiNC9ESytYdmV0ek4vUnQzQ0VGN29jZTFECko0eXVTS0pYR25RVW82NXV6RVBJMmVVdi81Njh5dEdDdXlNRmdIZDNTRHBxeUZqSjhlVXp3RGNDZ1lFQXdVU2kKVVpkMTEzVnFWeEpUQytSeTlsRzNIeGZFekhBbUdkMXNQNFdmYm9nZ3hjbmZrZk9ndU1ua0dzVVNnNGZjN3BKNworVDd2dFg2QVRXQkUzeUV1SHdMcytJd2VQT2RFeDNBZytSYnBKU25pTEc2WmUxdER0K2NtdTdObGZGRWRuR0l2CkUvTkt1c3FLdmduN3FzK216OHR5UmwxZ0pYMGdjT3J1TFVnbnNUOENnWUVBaGlUdUY3TnBXZ0lqSGRsS3A1dXMKMTEwbFZTR2lqb0pmMUFzVGlzL1pPYWh1NTlkL1M4aG5aZFUxdmRFYkhGU1VyZ3oydEZQdGxmTFlCT0xZREIxTQpEb0phbFBFY1gzaWNyaSs2bmZqa1lnUFhBaFRnTWoyTExicmNWNkd2UFNMNXdyaS9vVHhTRzJUSGhDa2c3cmZVCkFSUEo1S2xzd0ZhVThkV3NEVzN2N0xjQ2dZQlhlZGc2TStLcmpjSisvSlZJR2JPTEY3dFp3R2xiMnhyenRBdk4KeUk0NytqTlRNcWNWcVg3Q2hPYlEwd2dwTG5KcUxUVWR3RVhCRVN2RFdlSnlWOU5IU0F5NEJydWM5MVJqTExaUAo1L1hJMDJkQ2t5QzIrN3p2M1JqajlqUG1DOVRxTm1wMmpqVHh6TUQxZVJGRzQ4dnQyM2l5cm9yWkRRU0U5MkNzCmNDOC9Bd0tCZ1FDamRrVTNOcWFPZHUzMlpkWm5IK0cxY0NwbGtRK1VFZXNmTlcrWjdiWWtocng2Z2l6eCtjY0UKS3FhNTRxTmJkQVdLQXRzSU5lZ3pQU0toV0g0eXFnaWYrNmQ1aVVZUlFoUUhNVG0yTHpEQ2xGQ001N2FPdmQ3YQpNUEZxR3BNV2tqVmlnZjlwdHV3YW1qWkYwbm5MUVE5dWIzMlB3Zjk0Yzl4NFBEdkpmdTQrUHc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=\"\n }\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Apply API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"When the API is called, the resource synchronizer is called and the resource creation in the cluster begins","type":"text"}]},{"type":"paragraph","content":[{"text":"Apply all the created configuration, this creates the K8s resources","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Apply configuration","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"URL: /v2/projects//logical-clouds//apply\n\nReturn Status: 200 (OK)\nReturn Body:\n{\n \"logical-cloud-name\" : \"logical-cloud-1\",\n \"namespace\" : \"ns-1\", // one namespace per logical cloud\n \"description\": \"logical cloud for walmart finance department\", //description for the logical cloud\n \"user\" : \"user-1\",\n \"clusters\" : [\"cluster1\", \"cluster2\", \"cluster3\"]\n \"quota-name\" : \"quota-1\"\n}\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Status API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"GET (Check status of operation)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get Operation status","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"GET\nURL: /v2/projects//logical-clouds//status\nGET BODY:\n\nReturn Body :\n{\n \"metadata\" : {\n \"name\" : \"logical-cloud-1\"\n \"description\" : \"\",\n }\n \n \"clusters\" : [\n \"cluster-1\" : {\n \"namespace-status\" : \"\",\n \"role-status\" : \"\",\n \"role-binding-status\" : \"\"\n \n }\n \"cluster-2\" : {\n \"namespace-status\" : \"\",\n \"role-status\" : \"\",\n \"role-binding-status\" : \"\"\n \"control-plane-status\" : \"\"\n }\n ],\n \"status\": \"Creation in Progress \" //Created, Creation Failed \n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}