File size: 72,111 Bytes
ab74ec2 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 | # edge-application-management
```yaml
---
openapi: 3.0.3
info:
title: Edge Application Management API
version: wip
description: |
Edge Application Management API allows API consumers to manage the
Life Cycle of an Application and to Discover Edge Cloud Zones.
# Overview
The reference scenario foresees a distributed Telco Edge Cloud where any
Application Delevoper, known as an Application Provider, can host and
deploy their application according to their specifications and operational
criteria (e.g. within an specific geographical zone for data protection
purposes, ensure a minimum QoS for the application clients, etc).
Through Telco Edge Cloud services Developers around the globe can be
benefit from the traditional Cloud strengths but expertise and advantages
of the Mobile Network Operators offering to their users an evolved
experience for XR, V2X, Holographic and other new services.
# Introduction
The Edge Application Management API provides capabilities for lifecycle
management of application, instances and edge cloud zone discovery.
Lifecycle Management allows Application Provider to onboard
their application to the Edge Cloud Platform which do bookkeeping,
resource validation and other pre-deployment operations.
Application details can contain components network specification,
package type (QCOW2, OVA, CONTAINER, HELM, CSAR), operating system details and
respository to download the image of the desired application.
Once the application is available on the Edge Cloud
Platform, the Application Provider can instantiate the application.
Edge Cloud Provider helps Application Provider to decide where to
instantiate the applications allowing them to retrieve a list of
Edge Cloud Zones that meets the provided criteria.
This discovery can be filtered by an specific geographical region
(e.g when data residency is need) and by status (active, inactive, unknown)
Application Provider can ask the Edge Cloud Platform to instantiate the
application to one or several Edge Cloud Zones that meet the criteria.
Typically when more than one Edge Cloud Zone is required in the same
geographic boundary, Application Provider can define instead
the entire Edge Cloud Region.
Application Provider can retrieve the information of the instances
for a given application, the information could be the Edge Cloud Zone
where the instance is, status (ready, instantiating, failed,
terminating, unknown) and endpoint (ip, port, fqdn).
Application Provider can terminate an instance of an application
(appInstanceId) or all the instances for a given appId.
# Quick Start
The usage of this API is based on several resources including GSMA
Edge Platform, Public Cloud and SDOs, to define a first approach on the
lifecycle management of application instances and edge cloud zones discovery
Before starting to use the API, the developer needs to know about
the below specified details.
__Application Management__
* __submitApp__ - Submits application details to an Edge Cloud Provider.
Based on the details provided, Edge Cloud Provider shall do bookkeeping,
resource validation and other pre-deployment operations.
* __deleteApp__ - Removes an application from an Edge Cloud Provider,
if there is a running instance of the given application,
the request cannot be done.
* __getApp__ - Retrieves the information of a given application.
__Application Instance Management__
* __createAppInstance__ Request the Edge Cloud Provider to instatiate
an instance of an application in a given Edge Cloud Zone,
if this parameter is not set, the Edge Cloud Provider will instantiate
the applications in all the Edge Cloud Zones.
* __getAppInstance__ Retrieves the list with information of the instances
related to a given application.
* __deleteAppInstance__ - Removes a given application instance from an Edge
Cloud Zone.
__Application Deployment Management__
* __createAppDeployment__ - Requests the Edge Cloud Provider to create and
maintain application instances to multiple Edge Cloud Zones.
* __getAppDeployments__ - Retrieves a list of deployments for a given
application.
* __deleteAppDeployment__ - Terminates a specific application deployment,
removing all associated instances.
__Edge Cloud information__
* __getEdgeCloudZones__ List of the operators Edge Cloud Zones and their
status, ordering the results by location and filtering by status
(active/inactive/unknown)
# Authentication and Authorization
CAMARA guidelines defines a set of authorization flows which can grant API
clients access to the API functionality, as outlined in the document
[CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject\
/IdentityAndConsentManagement/blob/main/documentation/CAMARA-API-access\
-and-user-consent.md).
Which specific authorization flows are to be used will be determined during
onboarding process, happening between the API Client and the Telco Edge
exposing the API, taking into account the declared purpose for accessing the
API, while also being subject to the prevailing legal framework dictated by
local legislation.
It is important to remark that in cases where personal user data is
processed by the API, and users can exercise their rights through mechanisms
such as opt-in and/or opt-out, the use of 3-legged access tokens becomes
mandatory. This measure ensures that the API remains in strict compliance
with user privacy preferences and regulatory obligations, upholding the
principles of transparency and user-centric data control.
# API documentation
Two operations have been defined in Edge Application Management API.
*__Application__* - The Application Provider submit application metadata to
the Edge Cloud Platform. The Edge Cloud Platform generates an appId for that
metadata that will be used to instantiate the application within
the Edge Cloud Zone.
*__Edge Cloud__* - Retrieves all the Edge Cloud Zones available according to
some defined parameters where an application can be instantiated.
Definitions of terminologies commonly referred
to throughout the API descriptions.
* __Application Provider__ - The provider of the application that accesses
an Edge Cloud Provider to deploy its application on the Edge Cloud.
An Application Provider may be part of a larger organisation,
like an enterprise, enterprise customer of an Edge Cloud Provider,
or be an independent entity.
* __Application__ - Contains the information about the application to be
instantiated. Descriptor, binary image, charts or any other package
assosiated with the application. The Application Provider request contains
mandatory criteria (e.g. required CPU, memory, storage, bandwidth) defined
in an Application. The Edge Cloud Platform generates a unique ID
for an Application that is ready to be instantiated.
* __Application Instance__ - Is an instance (VM or Container based) running
in an Edge Cloud Zone. The Edge Cloud Platform generates a unique ID
for each instance.
* __Application Deployment__ - A specification that defines the requirements
for the Edge Cloud Provider to create and maintain application instances
across multiple Edge Cloud Zones. The deployment ensures that the
application is instantiated and managed consistently across the specified
zones, meeting the defined requirements.
* __Edge Cloud__ - Cloud-like capabilities located at the network edge
including, from the Application Provider's perspective, access to
elastically allocated compute, data storage and network resources,
this access is provided through the Edge Cloud Platform.
* __Edge Cloud Provider__ - Company name of the provider offering the
Edge Services through the Edge Cloud Platform.
Could be an Operator or a Cloud Provider.
* __Edge Cloud Region__ - An Edge Cloud Region is equivalent
to a Region on a Public Cloud.
The higher construct in the hierarchy exposed to an Application
Provider who wishes to deploy an Application on the Edge Cloud and broadly
represents a geography. An Edge CloudRegion typically contains one or
multiple Edge Cloud Zones.
An Edge Cloud Region exists within an Edge Cloud.
* __Edge Cloud Zone__ - An Edge Cloud Zone is the lowest level of
abstraction exposed to an Application Provider who wants to deploy
an Application on Edge Cloud.
Edge Cloud Zones exists within a Edge Cloud Region.
---
contact:
email: sp-edc@lists.camaraproject.org
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
externalDocs:
description: Product documentation at Camara
url: https://github.com/camaraproject/EdgeCloud
servers:
- url: "{apiRoot}/edge-application-management/vwip"
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
tags:
- name: Application
description: Application and Application Instance Lice Cycle Management
- name: Edge Cloud
description: Edge Cloud Zones Availability
paths:
/apps:
post:
security:
- openId:
- edge-application-management:apps:write
tags:
- Application
summary: Submit application metadata to the Edge Cloud Provider.
description: |
Contains the information about the application to be
instantiated in the Edge Cloud
operationId: submitApp
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: |
The Application Provider request contains mandatory
criteria (e.g. required CPU, memory, storage, bandwidth) and
optional parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/AppManifest'
required: true
responses:
'201':
description: Application created successfully
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/SubmittedApp'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 409
code: CONFLICT
message: "App already exists"
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
get:
security:
- openId:
- edge-application-management:apps:read
tags:
- Application
summary: Retrieve a list of existing Applications
description: |
Get the list of all existing Application definitions from the
Edge Cloud Provider that the user has permission to view.
operationId: getApps
parameters:
- $ref: '#/components/parameters/x-correlator'
responses:
'200':
description: List of existing applications
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppManifest'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/apps/{appId}:
get:
security:
- openId:
- edge-application-management:apps:read
tags:
- Application
summary: Retrieve the information of an Application
description: |
Ask the Edge Cloud Provider the information for a given application
operationId: getApp
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: appId
description: |
A globally unique identifier associated with the
application.
Edge Cloud Provider generates this identifier when the application
is submitted.
in: path
required: true
schema:
$ref: '#/components/schemas/AppId'
responses:
'200':
description: Information of Application
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
type: object
properties:
appManifest:
$ref: '#/components/schemas/AppManifest'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
delete:
security:
- openId:
- edge-application-management:apps:delete
tags:
- Application
summary: |
Delete an Application from an Edge Cloud Provider
description: Delete all the information and content
related to an Application
operationId: deleteApp
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: appId
in: path
description: |
Identificator of the application to be
deleted provided by the Edge Cloud Provider
once the submission was successful
required: true
schema:
$ref: "#/components/schemas/AppId"
responses:
'202':
description: Request accepted
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
'204':
description: App deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 409
code: CONFLICT
message: "App with a running application instance
cannot be deleted"
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/appinstances:
post:
security:
- openId:
- edge-application-management:instances:write
tags:
- Application
summary: Instantiation of an Application
description: |
Ask the Edge Cloud Platform to instantiate an application to an
Edge Cloud Zone.
operationId: createAppInstance
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: |
Information about the application and where to deploy it.
content:
application/json:
schema:
type: object
required:
- name
- appId
- edgeCloudZoneId
properties:
name:
$ref: '#/components/schemas/AppInstanceName'
appId:
$ref: '#/components/schemas/AppId'
edgeCloudZoneId:
$ref: '#/components/schemas/EdgeCloudZoneId'
kubernetesClusterRef:
$ref: '#/components/schemas/KubernetesClusterRef'
required: true
responses:
'202':
description: Application instantiation accepted
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
Location:
description: Contains the URI of the newly created application.
required: true
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AppInstanceInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 409
code: CONFLICT
message: "Application already instantiated in the given
Edge Cloud Zone"
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
get:
security:
- openId:
- edge-application-management:instances:read
tags:
- Application
summary: Retrieve the information of Application Instances for a given App
description: |
Ask the Edge Cloud Provider the information of the instances for a
given application
operationId: getAppInstance
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: appId
description: |
A globally unique identifier associated with
the application.
Edge Cloud Provider generates this identifier when the
application is submitted.
in: query
required: false
schema:
$ref: '#/components/schemas/AppId'
- name: appInstanceId
description: |
A globally unique identifier associated with a running
instance of an application within an specific Edge Cloud Zone.
Edge Cloud Provider generates this identifier.
in: query
required: false
schema:
$ref: '#/components/schemas/AppInstanceId'
- name: region
description: |
Human readable name of the geographical Edge Cloud Region of
the Edge Cloud. Defined by the Edge Cloud Provider.
in: query
required: false
schema:
$ref: '#/components/schemas/EdgeCloudRegion'
responses:
'200':
description: |
List of application instances. Returns an empty list if no
instances were found or none match the specified query
parameters.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppInstanceInfo'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/appinstances/{appInstanceId}:
delete:
security:
- openId:
- edge-application-management:instances:delete
tags:
- Application
summary: Terminate an Application Instance
description: |
Terminate a running instance of an application within
an Edge Cloud Zone
operationId: deleteAppInstance
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: appInstanceId
in: path
description: |
Identificator of the specific application instance
that will be terminated
required: true
schema:
$ref: "#/components/schemas/AppInstanceId"
responses:
'202':
description: |
Request accepted to be processed. It applies for async
deletion process
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
'204':
description: Application Instance Deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/deployments:
post:
security:
- openId:
- edge-application-management:deployments:write
tags:
- Application
summary: Deploy an Application
description: |
Ask the Edge Cloud Platform to instantiate an application to several
Edge Cloud Zones.
operationId: createAppDeployment
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: |
Information about the application and where to deploy it.
content:
application/json:
schema:
type: object
required:
- appDeploymentName
- appId
- edgeCloudZones
properties:
appDeploymentName:
$ref: '#/components/schemas/AppDeploymentName'
appId:
$ref: '#/components/schemas/AppId'
edgeCloudZones:
type: array
items:
$ref: '#/components/schemas/EdgeCloudZoneId'
kubernetesClusterRefs:
type: array
items:
$ref: '#/components/schemas/KubernetesClusterRef'
required: true
responses:
'202':
description: Application deployment accepted
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
type: object
properties:
appDeploymentId:
$ref: '#/components/schemas/AppDeploymentId'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 409
code: CONFLICT
message: "Deployment already exists"
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
get:
security:
- openId:
- edge-application-management:deployments:read
tags:
- Application
summary: Retrieve a list of Application Deployment for a given App
description: |
Ask the Edge Cloud Provider the information of the Deployments for a
given application
operationId: getAppDeployments
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: appId
description: |
A globally unique identifier associated with
the application.
Edge Cloud Provider generates this identifier when the
application is submitted.
in: query
required: false
schema:
$ref: '#/components/schemas/AppId'
- name: appDeploymentId
description: |
A globally unique identifier associated with a existing deployment
of an application. Edge Cloud Platform generates this identifier when
the deployment request in the Edge Cloud Zone is successful.
in: query
required: false
schema:
$ref: '#/components/schemas/AppDeploymentId'
responses:
'200':
description: |
List of application deployments. Returns an empty list if no
deployments were found or none match the specified query
parameters.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppDeploymentInfo'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'410':
$ref: '#/components/responses/410'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/deployments/{appDeploymentId}:
delete:
security:
- openId:
- edge-application-management:deployments:delete
tags:
- Application
summary: Terminate an Application Deployment
description: |
Delete a deployment terminating all related instances of an application
operationId: deleteAppDeployment
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: appDeploymentId
in: path
description: |
Identificator of the specific application deployment
that will be terminated
required: true
schema:
$ref: "#/components/schemas/AppDeploymentId"
responses:
'202':
description: |
Request accepted to be processed. It applies for async
deletion process
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'410':
$ref: '#/components/responses/410'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
patch:
security:
- openId:
- edge-application-management:deployments:update
tags:
- Application
summary: Update an Application Deployment
description: |
Update the configuration or properties of an existing application deployment
using JSON Merge Patch semantics (RFC 7396). Only the fields provided in the
request body will be updated. Fields not included in the request will remain unchanged.
IMPORTANT: When updating array fields (like edgeCloudZones or kubernetesClusterRefs),
JSON Merge Patch will REPLACE the entire array, not merge or append to it.
This operation may include changing the deployment name, target Edge Cloud Zones, or other updatable fields.
operationId: updateAppDeployment
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: appDeploymentId
in: path
description: |
Identifier of the specific application deployment to be updated.
required: true
schema:
$ref: "#/components/schemas/AppDeploymentId"
requestBody:
description: |
The fields to update for the application deployment using JSON Merge Patch (RFC 7396).
Only the fields included in the request will be updated; omitted fields remain unchanged.
NOTE: When updating array fields (edgeCloudZones, kubernetesClusterRefs), the entire array
will be REPLACED, not merged. To modify an array, you must include the complete array
with all desired elements in your request.
required: true
content:
application/merge-patch+json:
schema:
type: object
properties:
appDeploymentName:
$ref: '#/components/schemas/AppDeploymentName'
edgeCloudZones:
type: array
items:
$ref: '#/components/schemas/EdgeCloudZoneId'
kubernetesClusterRefs:
type: array
items:
$ref: '#/components/schemas/KubernetesClusterRef'
examples:
updateDeploymentName:
summary: Update only the deployment name
description: |
This example shows how to update only the deployment name.
Other fields will remain unchanged.
value:
appDeploymentName: "my_updated_deployment"
updateMultipleFields:
summary: Update multiple fields simultaneously
description: |
This example shows how to update both the deployment name
and Edge Cloud Zones in a single request. Remember that both
array fields will be completely replaced with the new values.
value:
appDeploymentName: "production_deployment"
edgeCloudZones:
- "123e4567-e89b-12d3-a456-426614174000"
- "123e4567-e89b-12d3-a456-426614174001"
kubernetesClusterRefs:
- "642f6105-7015-4af1-a4d1-e1ecb8437abc"
- "642f6105-7015-4af1-a4d1-e1ecb8437def"
arrayReplacementExample:
summary: Example of array replacement behavior
description: |
This example demonstrates how arrays are completely replaced in JSON Merge Patch.
If the current deployment has:
- edgeCloudZones: ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001", "123e4567-e89b-12d3-a456-426614174002"]
- kubernetesClusterRefs: ["642f6105-7015-4af1-a4d1-e1ecb8437abc", "642f6105-7015-4af1-a4d1-e1ecb8437def"]
And the user sends this patch:
- edgeCloudZones: ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174003"]
The result will be:
- edgeCloudZones: ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174003"] (completely replaced)
- kubernetesClusterRefs: ["642f6105-7015-4af1-a4d1-e1ecb8437abc", "642f6105-7015-4af1-a4d1-e1ecb8437def"] (unchanged, as it wasn't in the patch)
To add a single zone while keeping existing ones, ALL zones must be included in the request.
value:
edgeCloudZones:
- "123e4567-e89b-12d3-a456-426614174000"
- "123e4567-e89b-12d3-a456-426614174003"
responses:
'200':
description: Application deployment updated successfully
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/AppDeploymentInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'410':
$ref: '#/components/responses/410'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 409
code: CONFLICT
message: "Update conflict"
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/clusters:
get:
security:
- openId:
- edge-application-management:clusters:read
tags:
- Cluster
summary: |
Retrieve a list of the available clusters filtered by the optional
query parameters.
description: |
List available cluster information
operationId: getClusters
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: region
description: |
Human readable name of the geographical Edge Cloud Region of
the Cluster. Defined by the Edge Cloud Provider.
in: query
required: false
schema:
$ref: '#/components/schemas/EdgeCloudRegion'
- name: clusterRef
description: |
A globally unique identifier for the Cluster.
in: query
required: false
schema:
$ref: '#/components/schemas/KubernetesClusterRef'
- name: edgeCloudZoneId
description: |
Edge Cloud Zone identifier.
in: query
required: false
schema:
$ref: '#/components/schemas/EdgeCloudZoneId'
responses:
'200':
description: |
Successful response, returning the cluster's information.
Returns an empty list if no clusters were found or none match
the specified query parameters.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClusterInfo'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/edge-cloud-zones:
get:
security:
- openId:
- edge-application-management:edge-cloud-zones:read
tags:
- Edge Cloud
summary: Retrieve a list of the operators Edge Cloud Zones and
their status
description: |
List of the operators Edge Cloud Zones and their
status, ordering the results by location and filtering by
status (active/inactive/unknown)
operationId: getEdgeCloudZones
parameters:
- $ref: '#/components/parameters/x-correlator'
- name: region
description: |
Human readable name of the geographical Edge Cloud Region of
the Edge Cloud. Defined by the Edge Cloud Provider.
in: query
required: false
schema:
$ref: '#/components/schemas/EdgeCloudRegion'
- name: status
description: Human readable status of the Edge Cloud Zone
in: query
required: false
schema:
$ref: '#/components/schemas/EdgeCloudZoneStatus'
responses:
'200':
description: |
Successful response, returning the
Available Edge Cloud Zones.
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeCloudZones'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
components:
securitySchemes:
openId:
description: OpenID Provider Configuration Information.
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
parameters:
x-correlator:
name: x-correlator
in: header
description: |
Correlation id for the different services
schema:
type: string
headers:
x-correlator:
description: |
Correlation id for the different services
required: false
schema:
type: string
format: uuid
schemas:
AccessEndpoint:
type: object
description: |
Application Endpoint for an especific instance that is
running in an specific Edge Cloud Zone.
required:
- port
anyOf:
- required:
- fqdn
- required:
- ipv4Addresses
- required:
- ipv6Addresses
properties:
port:
$ref: '#/components/schemas/Port'
fqdn:
$ref: '#/components/schemas/Fqdn'
ipv4Addresses:
description: IP version 4 of an application instance
type: array
items:
$ref: '#/components/schemas/Ipv4Addr'
minItems: 1
ipv6Addresses:
description: IP version 6 of an application instance.
type: array
items:
$ref: '#/components/schemas/Ipv6Addr'
minItems: 1
AppId:
type: string
format: uuid
description: |
A globally unique identifier associated with the application.
Edge Cloud Platform generates this identifier when the
Application is submitted.
AppInstanceId:
type: string
format: uuid
description: |
A globally unique identifier associated with a running
instance of an application.
Edge Cloud Platform generates this identifier when the
instantiation in the Edge Cloud Zone is successful.
AppDeploymentId:
type: string
format: uuid
description: |
A globally unique identifier associated with a existing deployment
of an application. Edge Cloud Platform generates this identifier when
the deployment request in the Edge Cloud Zone is successful.
AppDeploymentInfo:
type: object
required:
- appDeploymentName
- appDeploymentId
- appId
- edgeCloudZones
- appInstances
properties:
appDeploymentName:
$ref: '#/components/schemas/AppDeploymentName'
appDeploymentId:
$ref: '#/components/schemas/AppDeploymentId'
appId:
$ref: '#/components/schemas/AppId'
edgeCloudZones:
type: array
items:
$ref: '#/components/schemas/EdgeCloudZoneId'
appInstances:
type: array
items:
$ref: '#/components/schemas/AppInstanceId'
AppInstanceInfo:
description: Information about the application instance.
type: object
required:
- name
- appId
- appInstanceId
- appProvider
- edgeCloudZoneId
properties:
name:
$ref: '#/components/schemas/AppInstanceName'
appId:
$ref: '#/components/schemas/AppId'
appInstanceId:
$ref: '#/components/schemas/AppInstanceId'
appProvider:
$ref: '#/components/schemas/AppProvider'
status:
description: Status of the application instance (default is 'unknown')
type: string
enum:
- ready
- instantiating
- failed
- terminating
- unknown
default: unknown
componentEndpointInfo:
description: |
Information about the IP and Port exposed by the
Edge Cloud Platform.
Application Client shall use these access points to reach this
application instance
type: array
items:
type: object
required:
- interfaceId
- accessPoints
properties:
interfaceId:
type: string
pattern: ^[A-Za-z0-9][A-Za-z0-9_]{6,30}[A-Za-z0-9]$
description: |
This is the interface Identifier that Application Provider
defines when application is being submitted.
accessPoints:
$ref: '#/components/schemas/AccessEndpoint'
minItems: 1
kubernetesClusterRef:
$ref: '#/components/schemas/KubernetesClusterRef'
edgeCloudZoneId:
$ref: '#/components/schemas/EdgeCloudZoneId'
AppInstanceName:
type: string
pattern: ^[A-Za-z][A-Za-z0-9_]{1,63}$
description: Name of the App instance, scoped to the AppProvider
AppDeploymentName:
type: string
pattern: ^[A-Za-z][A-Za-z0-9_]{1,63}$
description: Name of the App Deployment, scoped to the AppProvider
AppManifest:
description: |
Application information and requirements provided by the
Application Provider
properties:
appId:
$ref: '#/components/schemas/AppId'
name:
type: string
pattern: ^[A-Za-z][A-Za-z0-9_]{1,63}$
description: Name of the application.
appProvider:
$ref: '#/components/schemas/AppProvider'
version:
type: string
description: Application version information
packageType:
description: Format of the application image package
type: string
enum:
- QCOW2
- OVA
- CONTAINER
- HELM
- CSAR
operatingSystem:
$ref: '#/components/schemas/OperatingSystem'
appRepo:
description: |
Repository where Application Provider stores the application image
type: object
required:
- type
- imagePath
properties:
type:
type: string
enum:
- PRIVATEREPO
- PUBLICREPO
description: |
Application repository and image URI information.
PUBLICREPO is used of public urls like github, helm repo etc.
PRIVATEREPO is used for private repo managed by the application
developer. Private repo can be accessed by using the app
developer provided userName and password. Password is
recommended to be the personal access token created by developer
e.g. in Github repo.
imagePath:
$ref: '#/components/schemas/Uri'
userName:
type: string
description: |
Username to acces the Helm chart, docker-compose
file or VM image repository
credentials:
type: string
maxLength: 128
description: |
Password or personal access token created by
developer to acces the app repository. API users can generate
a personal access token e.g. docker clients to use them as
password.
authType:
type: string
enum:
- DOCKER
- HTTP_BASIC
- HTTP_BEARER
- NONE
description: |
The credentials can also be formatted as a Basic
auth or Bearer auth in HTTP "Authorization" header.
checksum:
type: string
description: |
MD5 checksum for VM and file-based images, sha256
digest for containers
requiredResources:
$ref: '#/components/schemas/RequiredResources'
componentSpec:
description: |
Information defined in "appRepo" point to the application
descriptor e.g. Helm chart, docker-compose yaml file etc.
The descriptor may contain one or more containers and their
associated meta-data. A component refers to additional details
about these containers to expose the instances of the containers
to external client applications. App provider can define one or
more components (via the associated network port) in componentSpec
corresponding to the containers in helm charts or docker-compose
yaml file as part of app descriptors.
type: array
items:
type: object
required:
- componentName
- networkInterfaces
properties:
componentName:
type: string
description: Component name must be unique with an application
networkInterfaces:
description: |
Each application component exposes some ports
either for external users or for inter component
communication.
Application provider is required to specify which ports are
to be exposed and the type of traffic that will flow through
these ports.The underlying platform may assign a dynamic port
against the "extPort" that the application clients will use
to connect with edge application instance.
type: array
items:
type: object
required:
- interfaceId
- protocol
- port
- visibilityType
properties:
interfaceId:
type: string
pattern: ^[A-Za-z][A-Za-z0-9_]{3,31}$
description: |
Each Port and corresponding traffic protocol
exposed by the component is identified by a name.
Application client on user device requires this to
uniquley idenify the interface.
protocol:
type: string
enum:
- TCP
- UDP
- ANY
description: |
Defines the IP transport communication
protocol i.e., TCP, UDP or ANY
port:
type: integer
format: int32
minimum: 1
maximum: 65535
description: |
Port number exposed by the component.
Edge Cloud Provider may generate a dynamic port
towards the component instance which forwards
external traffic to the component port.
visibilityType:
description: |
Defines whether the interface is exposed
to outer world or not i.e., external, or internal.
If this is set to "external", then it is exposed
to external applications otherwise it is exposed
internally to edge application components within
edge cloud. When exposed to external world,
an external dynamic port is assigned for UC traffic
and mapped to the extPort
type: string
enum:
- VISIBILITY_EXTERNAL
- VISIBILITY_INTERNAL
minItems: 1
required:
- name
- version
- appProvider
- packageType
- appRepo
- requiredResources
- componentSpec
AppProvider:
type: string
pattern: ^[A-Za-z][A-Za-z0-9_]{7,63}$
description: Human readable name of the Application Provider.
ClusterInfo:
description: Kubernetes cluster information
required:
- name
- provider
- clusterRef
- edgeCloudZoneId
properties:
name:
type: string
description: |
Name of the Cluster, scoped to the Provider
provider:
$ref: '#/components/schemas/AppProvider'
clusterRef:
$ref: '#/components/schemas/KubernetesClusterRef'
edgeCloudZoneId:
$ref: '#/components/schemas/EdgeCloudZoneId'
edgeCloudRegion:
$ref: '#/components/schemas/EdgeCloudRegion'
version:
type: string
description: Kubernetes version of the cluster.
nodePools:
description: Node Pools in the cluster.
type: array
items:
$ref: '#/components/schemas/KubernetesNodePool'
minItems: 1
EdgeCloudProvider:
type: string
description: Human readable name of the Edge Cloud Provider.
EdgeCloudRegion:
type: string
description: |
Human readable name of the geographical Edge Cloud Region of
the Edge Cloud. Defined by the Edge Cloud Provider.
EdgeCloudZones:
type: array
items:
$ref: '#/components/schemas/EdgeCloudZone'
minItems: 1
description: |
A collection of Edge Cloud Zones where the Application Provider can
instantiate an Application Instance.
additionalProperties: false
EdgeCloudZoneId:
type: string
format: uuid
description: |
Unique identifier created by the Edge Cloud Platform to identify an
Edge Cloud Zone within an Edge Cloud.
EdgeCloudZone:
type: object
description: |
An Edge Cloud Zone, uniquely identified by a
combination of the value of the Edge Cloud Zone Id object
and the value of the Edge Cloud Provider
object. This value is used to identify an Edge Cloud zone
between Edge Clouds from different Edge Cloud Providers.
required:
- edgeCloudZoneId
- edgeCloudZoneName
- edgeCloudProvider
properties:
edgeCloudZoneId:
$ref: '#/components/schemas/EdgeCloudZoneId'
edgeCloudZoneName:
$ref: '#/components/schemas/EdgeCloudZoneName'
edgeCloudZoneStatus:
$ref: '#/components/schemas/EdgeCloudZoneStatus'
edgeCloudProvider:
$ref: '#/components/schemas/EdgeCloudProvider'
edgeCloudRegion:
$ref: '#/components/schemas/EdgeCloudRegion'
minItems: 1
EdgeCloudZoneName:
type: string
description: |
Human readable name of the geographical zone of
the Edge Cloud. Defined by the Edge Cloud Provider.
EdgeCloudZoneStatus:
description: Status of the Edge Cloud Zone (default is 'unknown')
type: string
enum:
- active
- inactive
- unknown
default: unknown
ErrorInfo:
type: object
description: Information about the error
properties:
status:
type: integer
description: HTTP status code returned along with this error response
code:
type: string
description: Code given to this error
message:
type: string
description: Detailed error description
required:
- status
- code
- message
Fqdn:
type: string
description: |
Full qualified domain name of an application instance
GpuInfo:
type: object
description: Information about the supported GPUs
required:
- gpuMemory
- numGPU
properties:
gpuMemory:
type: integer
description: GPU memory in mega bytes
numGPU:
type: integer
description: Number of GPUs
K8sAddons:
description: |
Addons for the Kubernetes cluster.
Additional addons should be defined in application the helm chart
(Service Mesh, Serverless, AI).
type: object
properties:
monitoring:
type: boolean
example: true
default: false
description: Enable monitoring for Kubernetes cluster.
ingress:
type: boolean
example: true
default: false
description: Enable ingress for Kubernetes cluster.
K8sNetworking:
description: |
Kubernetes networking definition
type: object
properties:
primaryNetwork:
description: Definition of Kubernetes primary Network
type: object
properties:
provider:
description: CNI provider name
type: string
example: cilium
version:
description: CNI provider version
type: string
example: "1.13"
additionalNetworks:
description: Additional Networks for the Kubernetes cluster.
type: array
items:
type: object
description: Additional network interface definition
properties:
name:
description: Additional Network Name
type: string
example: net1
interfaceType:
description: |
Type of additional Interface:
netdevice: (SR-IOV) A regular kernel network device in the
Network Namespace (netns) of the container
vfio-pci: (SR-IOV) A PCI network interface directly mounted
in the container
interface: Additional interface to be used by cni plugins
such as macvlan, ipvlan
Note: The use of SR-IOV interfaces automatically
configure the required kernel parameters for the nodes.
type: string
example: vfio-pci
enum:
- netdevice
- vfio-pci
- interface
AdditionalStorage:
description: Additional storage for the application.
type: array
items:
type: object
required:
- storageSize
- mountPoint
properties:
name:
type: string
description: Name of additional storage resource.
example: logs
storageSize:
type: string
description: Additional persistent volume for the application.
example: 80GB
pattern: ^\d+(GB|MB)$
mountPoint:
type: string
description: Location of additional storage resource.
example: /logs
Vcpu:
type: string
pattern: ^\d+((\.\d{1,3})|(m))?$
description: |
Number of vcpus in whole (i.e 1), decimal (i.e 0.500) up to
millivcpu, or millivcpu (i.e 500m) format.
example: "500m"
KubernetesClusterRef:
description: |
A global unique identifier associated with a Kubernetes cluster
infrastructure.
type: string
format: uuid
example: "642f6105-7015-4af1-a4d1-e1ecb8437abc"
KubernetesNodePool:
description: |
A Kubernetes node pool is a set of Kubernetes nodes that have the
same configuration (vCPU, memory, networking, OS, etc) on each node.
required:
- name
- numNodes
- nodeResources
- scalable
properties:
name:
description: Human readable name of the Kubernetes Node Pool.
type: string
numNodes:
description: Number of nodes in the Node Pool.
type: integer
scalable:
description: |
Indicates if the node pool can be dynamically scaled up by the
system to accomodate more applications, and dynamically scaled
down by the system when there are unused resources.
type: boolean
example: false
nodeResources:
description: Resource configuration of a node.
type: object
required:
- numCPU
- memory
properties:
numCPU:
description: |
Number of whole vcpus for the node.
type: integer
example: 2
memory:
description: |
Amount of system memory in mega bytes for the node.
type: integer
example: 4096
KubernetesResources:
description: Definition of Kubernetes Cluster Infrastructure.
required:
- infraKind
- applicationResources
- isStandalone
properties:
infraKind:
description: Type of infrastructure for the application.
type: string
example: kubernetes
enum:
- kubernetes
applicationResources:
description: |
Application resources define the resources pool required
by the application to be executed in a Kubernetes clusters.
type: object
properties:
cpuPool:
required:
- numCPU
- memory
- topology
type: object
description: |
CPU Pool refers to the amount of application' resources
that is executed in nodes with CPU only. That means the part
of application that doesn't require GPU or other kind of
acceleration.
CPU pool is not mandatory when the application is executed
exclusively in a GPU pool.
A CPU pool is composed by CPU and memory.
properties:
numCPU:
description: |
Total number of vcpus in whole (i.e 1) of CPU pool.
type: integer
example: 1
memory:
description: Total memory in mega bytes of CPU pool.
type: integer
example: 1024
topology:
type: object
description: |
CPU pool topology defines an application's CPU-based
architecture.
When deploying for high availability or redundancy, it
allows for clustering with a configurable number of nodes
and minimum CPU/memory resource per Kubernetes node
requirements.
required:
- minNumberOfNodes
- minNodeCpu
- minNodeMemory
properties:
minNumberOfNodes:
description: |
Minimum number of worker nodes required by the
application.
type: integer
example: 5
minNodeCpu:
description: |
Minimum number of vcpus in whole (i.e 1) per cluster
node in CPU pool.
type: integer
example: 2
minNodeMemory:
description: |
Minimum memory in mega bytes per cluster node in
CPU pool.
type: integer
example: 1024
gpuPool:
required:
- numCPU
- memory
- gpuMemory
- topology
type: object
description: |
GPU Pool refers to the amount of resources of the application
that is executed in nodes with GPU.
GPU Pool is not mandatory when the application is executed
exclusively in a CPU pool.
A GPU pool is composed by memory, CPU and GPU memory
properties:
numCPU:
description: |
Total Number of vcpus in whole (i.e 1) of GPU pool.
type: integer
example: 1
memory:
description: Total memory in mega bytes of GPU pool.
type: integer
example: 1024
gpuMemory:
description: Total GPU memory in giga bytes of GPU pool.
type: integer
example: 16
topology:
type: object
description: |
GPU pool topology defines an application's GPU-based
architecture.
When deploying for high availability or redundancy, it
allows for clustering with a configurable number of nodes
and minimum CPU/memory/GPU memory resource per Kubernetes
node requirements.
required:
- minNumberOfNodes
- minNodeCpu
- minNodeMemory
- minNodeGpuMemory
properties:
minNumberOfNodes:
description: |
Minimum number of worker nodes with GPU required by
the application.
type: integer
example: 2
minNodeCpu:
description: |
Minimum number of vcpus in whole (i.e 1) per cluster
node in GPU pool.
type: integer
example: 2
minNodeMemory:
description: |
Minimum memory in mega bytes per cluster node in
GPU pool.
type: integer
example: 1024
minNodeGpuMemory:
description: Minimum memory in giga bytes per cluster
node in GPU pool.
type: integer
example: 8
isStandalone:
description: |
Define if the Kubernetes clusters can be reused by other
applications.
type: boolean
example: false
version:
type: string
description: Minimum Kubernetes Version.
example: "1.29"
additionalStorage:
type: string
description: |
Amount of persistent storage allocated to the Kubernetes PVC.
example: 80GB
pattern: ^\d+(GB|MB)$
networking:
$ref: '#/components/schemas/K8sNetworking'
addons:
$ref: '#/components/schemas/K8sAddons'
VmResources:
description: Definition of Virtual Machine Infrastructure
type: object
required:
- infraKind
- numCPU
- memory
properties:
infraKind:
description: Type of infrastructure for the application.
type: string
example: virtualMachine
enum:
- virtualMachine
numCPU:
type: integer
description: |
Number of vcpus in whole (i.e 1)
example: 1
memory:
type: integer
example: 1024
description: Memory in mega bytes
additionalStorages:
$ref: '#/components/schemas/AdditionalStorage'
gpu:
$ref: '#/components/schemas/GpuInfo'
DockerComposeResources:
description: Definition of Docker Compose Infrastructure
type: object
required:
- infraKind
- numCPU
- memory
properties:
infraKind:
description: Type of infrastructure for the application.
type: string
example: dockerCompose
enum:
- dockerCompose
numCPU:
type: integer
description: |
Number of vcpus in whole (i.e 1)
example: 1
memory:
type: integer
example: 1024
description: Memory in mega bytes
storage:
$ref: '#/components/schemas/AdditionalStorage'
gpu:
$ref: '#/components/schemas/GpuInfo'
ContainerResources:
description: Container Infrastructure Definition
type: object
required:
- infraKind
- numCPU
- memory
properties:
infraKind:
description: Type of infrastructure for the application.
type: string
example: container
enum:
- container
numCPU:
$ref: '#/components/schemas/Vcpu'
memory:
type: integer
example: 1024
description: Memory in mega bytes
storage:
$ref: '#/components/schemas/AdditionalStorage'
gpu:
$ref: '#/components/schemas/GpuInfo'
Ipv4Addr:
type: string
format: ipv4
example: "192.168.0.1"
description: |
IP of the device. A single IPv4 address may be specified in
dotted-quad form 1.2.3.4. Only this exact IP number will match the flow
control rule.
Ipv6Addr:
type: string
format: ipv6
example: "2001:db8:85a3:8d3:1319:8a2e:370:7344"
description: |
IP of the device. A single IPv6 address, following IETF 5952
format, may be specified like 2001:db8:85a3:8d3:1319:8a2e:370:7344
OperatingSystem:
description: |
Information about the Operating System of the application image
type: object
required:
- architecture
- family
- version
- license
properties:
architecture:
description: Type of the OS Architecture
type: string
enum:
- x86_64
- x86
example: x86_64
family:
description: Family to which OS belongs
type: string
enum:
- RHEL
- UBUNTU
- COREOS
- WINDOWS
- OTHER
version:
description: Version of the OS
type: string
enum:
- OS_VERSION_UBUNTU_2204_LTS
- OS_VERSION_RHEL_8
- OS_MS_WINDOWS_2022
- OTHER
license:
description: License needed to activate the OS
type: string
enum:
- OS_LICENSE_TYPE_FREE
- OS_LICENSE_TYPE_ON_DEMAND
- OTHER
Port:
type: integer
description: Port to stablish the connection
minimum: 0
RequiredResources:
description: |
Fundamental hardware requirements to be provisioned by the
Application Provider.
oneOf:
- $ref: "#/components/schemas/KubernetesResources"
- $ref: "#/components/schemas/VmResources"
- $ref: "#/components/schemas/ContainerResources"
- $ref: "#/components/schemas/DockerComposeResources"
discriminator:
propertyName: infraKind
mapping:
kubernetes: "#/components/schemas/KubernetesResources"
virtualMachine: "#/components/schemas/VmResources"
container: "#/components/schemas/ContainerResources"
dockerCompose: "#/components/schemas/DockerComposeResources"
SubmittedApp:
description: Information about the submitted app
type: object
properties:
appId:
$ref: '#/components/schemas/AppId'
Uri:
type: string
example: https://charts.bitnami.com/bitnami/helm/example-chart:0.1.0
description: |
A Uniform Resource Identifier (URI) as per RFC 3986,
identifies the endpoint within an Edge Cloud Zone where the user
equipment may connect to the selected application instance
responses:
'400':
description: Bad request
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 400
code: INVALID_ARGUMENT
message: "Schema validation failed at ..."
'401':
description: Unauthorized
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 401
code: UNAUTHENTICATED
message: "Authorization failed: ..."
'403':
description: Unauthorized
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 403
code: PERMISSION_DENIED
message: "Operation not allowed: ..."
'404':
description: Not Found
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 404
code: NOT_FOUND
message: "Resource does not exist"
'410':
description: Gone
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 410
code: GONE
message: "The resource has been permanently removed"
'500':
description: Internal Server Error
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 500
code: INTERNAL
message: "Internal server error: ..."
'501':
description: Not Implemented
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 501
code: NOT_IMPLEMENTED
message: "Service not implemented"
'503':
description: Service Unavailable
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
example:
status: 503
code: UNAVAILABLE
message: "Service unavailable"
```
|