Docs: Enable O2 DMS by exposing k8s API endpoint
[pti/o2.git] / o2ims / views / ocloud_dto.py
1 # Copyright (C) 2021 Wind River Systems, Inc.
2 #
3 #  Licensed under the Apache License, Version 2.0 (the "License");
4 #  you may not use this file except in compliance with the License.
5 #  You may obtain a copy of the License at
6 #
7 #      http://www.apache.org/licenses/LICENSE-2.0
8 #
9 #  Unless required by applicable law or agreed to in writing, software
10 #  distributed under the License is distributed on an "AS IS" BASIS,
11 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 #  See the License for the specific language governing permissions and
13 #  limitations under the License.
14
15 from flask_restx import fields
16
17 from o2ims.views.api_ns import api_ims_inventory_v1
18
19
20 class OcloudDTO:
21
22     ocloud = api_ims_inventory_v1.model(
23         "OcloudDto",
24         {
25             'oCloudId': fields.String(required=True),
26             'globalCloudId': fields.String,
27             'name': fields.String,
28             'description': fields.String,
29             'infrastructureManagementServiceEndpoint': fields.String,
30         }
31     )
32
33
34 class ResourceTypeDTO:
35
36     resource_type_get = api_ims_inventory_v1.model(
37         "ResourceTypeGetDto",
38         {
39             'resourceTypeId': fields.String(required=True,
40                                             description='Resource type ID'),
41             'name': fields.String,
42             'vendor': fields.String,
43             'version': fields.String,
44             'description': fields.String,
45         }
46     )
47
48
49 class ResourcePoolDTO:
50
51     resource_pool_get = api_ims_inventory_v1.model(
52         "ResourcePoolGetDto",
53         {
54             'resourcePoolId': fields.String(required=True,
55                                             description='Resource pool ID'),
56             'name': fields.String,
57             'globalLocationId': fields.String,
58             'location': fields.String,
59             'description': fields.String,
60         }
61     )
62
63
64 class ResourceDTO:
65
66     resource_list = api_ims_inventory_v1.model(
67         "ResourceListDto",
68         {
69             'resourceId': fields.String(required=True,
70                                         description='Resource ID'),
71             'resourceTypeId': fields.String,
72             'resourcePoolId': fields.String,
73             'name': fields.String,
74             'parentId': fields.String,
75             'description': fields.String,
76         }
77     )
78
79     def recursive_resource_mapping(iteration_number=2):
80         resource_json_mapping = {
81             'resourceId': fields.String(required=True,
82                                         description='Resource ID'),
83             'resourceTypeId': fields.String,
84             'resourcePoolId': fields.String,
85             'name': fields.String,
86             'parentId': fields.String,
87             'description': fields.String,
88             'elements': fields.String,
89         }
90         if iteration_number:
91             resource_json_mapping['children'] = fields.List(
92                 fields.Nested(ResourceDTO.recursive_resource_mapping(
93                     iteration_number-1)))
94         return api_ims_inventory_v1.model(
95             'ResourceGetDto' + str(iteration_number), resource_json_mapping)
96
97     # def _recursive_resource_mapping(self, iteration_number=2):
98     #     resource_json_mapping = {
99     #         'resourceId': fields.String(required=True,
100     #                                     description='Resource ID'),
101     #         'resourceTypeId': fields.String,
102     #         'resourcePoolId': fields.String,
103     #         'name': fields.String,
104     #         'parentId': fields.String,
105     #         'description': fields.String,
106     #     }
107     #     if iteration_number:
108     #         resource_json_mapping['children'] = fields.List(
109     #             fields.Nested(self._recursive_resource_mapping(
110     #                 iteration_number-1)))
111     #         # print(type(resource_json_mapping['children']))
112     #         if resource_json_mapping['children'] is None:
113     #             del resource_json_mapping['children']
114     #     return resource_json_mapping
115
116     # def get_resource_get(self):
117     #     return api_ims_inventory_v1.model(
118     #         'ResourceGetDto',
119     #         {
120     #             'resourceId': fields.String(required=True,
121     #                                         description='Resource ID'),
122     #             'resourceTypeId': fields.String,
123     #             'resourcePoolId': fields.String,
124     #             'name': fields.String,
125     #             'parentId': fields.String,
126     #             'description': fields.String,
127     #             'children': fields.List(fields.Nested(
128     #                 self._recursive_resource_mapping()))
129     #         }
130     #     )
131
132
133 class DeploymentManagerDTO:
134
135     deployment_manager_list = api_ims_inventory_v1.model(
136         "DeploymentManagerListDto",
137         {
138             'deploymentManagerId': fields.String(
139                 required=True,
140                 description='Deployment manager ID'),
141             'name': fields.String,
142             'description': fields.String,
143             'deploymentManagementServiceEndpoint': fields.String,
144             'supportedLocations': fields.String,
145             'capabilities': fields.String,
146             'capacity': fields.String,
147             'profileSupportList': fields.List(
148                 fields.String,
149                 description='Profile support list, use default for the return \
150                      endpoint'),
151         }
152     )
153
154     profile = api_ims_inventory_v1.model("DeploymentManagerGetDtoProfile", {
155         'cluster_api_endpoint': fields.String(
156             attributes='cluster_api_endpoint'),
157         'cluster_ca_cert': fields.String(attributes='cluster_ca_cert'),
158         'admin_user': fields.String(attributes='admin_user'),
159         'admin_client_cert': fields.String(attributes='admin_client_cert'),
160         'admin_client_key': fields.String(attributes='admin_client_key'),
161         # 'kube_config_file': fields.String(attributes='kube_config_file')
162     })
163
164     deployment_manager_get = api_ims_inventory_v1.model(
165         "DeploymentManagerGetDto",
166         {
167             'deploymentManagerId': fields.String(
168                 required=True,
169                 description='Deployment manager ID'),
170             'name': fields.String,
171             'description': fields.String,
172             'deploymentManagementServiceEndpoint': fields.String,
173             'supportedLocations': fields.String,
174             'capabilities': fields.String,
175             'capacity': fields.String,
176             'profileName': fields.String,
177             'profileData': fields.Nested(profile, False, True),
178         }
179     )
180
181
182 class SubscriptionDTO:
183
184     subscription_get = api_ims_inventory_v1.model(
185         "SubscriptionGetDto",
186         {
187             'subscriptionId': fields.String(required=True,
188                                             description='Subscription ID'),
189             'callback': fields.String,
190             'consumerSubscriptionId': fields.String,
191             'filter': fields.String,
192         }
193     )
194
195     subscription = api_ims_inventory_v1.model(
196         "SubscriptionCreateDto",
197         {
198             'callback': fields.String(
199                 required=True, description='Subscription callback address'),
200             'consumerSubscriptionId': fields.String,
201             'filter': fields.String,
202         }
203     )
204
205     subscription_post_resp = api_ims_inventory_v1.model(
206         "SubscriptionCreatedRespDto",
207         {
208             'subscriptionId': fields.String(required=True,
209                                             description='Subscription ID'),
210         }
211     )