File size: 14,432 Bytes
af5e1de 58be94e af5e1de | 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 | # TMFC008-ServiceInventory
```yaml
apiVersion: oda.tmforum.org/v1
kind: Component
metadata:
name: components.oda.tmforum.org
spec:
coreFunction:
dependentAPIs:
- id: TMF633
apiType: openapi
apiSDO: tmForum
name: service-catalog-management-api
required: true
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF633_Service_Catalog/4.0.0/swagger/TMF633_Service_Catalog_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- serviceSpecification:
- GET
- GET /id
- id: TMF669
apiType: openapi
apiSDO: tmForum
name: party-role-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF669_Party_Role/4.0.0/swagger/TMF669_Party_Role_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- PartyRole:
- GET
- GET /id
- id: TMF639
apiType: openapi
apiSDO: tmForum
name: resource-inventory-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF639_Resource_Inventory/4.0.0/swagger/TMF639_Resource_Inventory_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- resource:
- GET
- GET /id
- id: TMF638
apiType: openapi
apiSDO: tmForum
name: service-inventory-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF638_Service_Inventory/4.0.0/swagger/TMF638_Service_Inventory_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- service:
- GET
- GET /id
- id: TMF673
apiType: openapi
apiSDO: tmForum
name: geographic-address-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF673_Geographic_Address/4.0.0/swagger/TMF673_Geographic_Address_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- geographicAddress:
- GET
- GET /id
- geographicSubAddress:
- GET
- GET /id
- id: TMF674
apiType: openapi
apiSDO: tmForum
name: geographic-site-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF674_Geographic_Site/4.0.0/swagger/TMF674_Geographic_Site_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- geographicSite:
- GET
- GET /id
- id: TMF675
apiType: openapi
apiSDO: tmForum
name: geographic-location-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/TMF675_Geographic_Location/4.0.0/swagger/TMF675_Geographic_Location_Management_API_v4.0.0_beta_swagger.json
version: v4.0.0
resources:
- geographicLocation:
- GET
- GET /id
- id: TMF641
apiType: openapi
apiSDO: tmForum
name: service-ordering-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/TMF641_Service_Ordering/4.2.0/swagger/TMF641_Service_Ordering_v4.2.0_beta_swagger.json
version: v4.0.0
resources:
- serviceOrder:
- GET
- GET /id
- id: TMF632
apiType: openapi
apiSDO: tmForum
name: party-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF632_Party/4.0.0/swagger/TMF632_Party_Management_API_v4.0.0_swagger.json
version: v4.0.0
resources:
- individual:
- GET
- GET /id
- organization:
- GET
- GET /id
exposedAPIs:
- id: TMF638
apiType: openapi
apiSDO: tmForum
name: service-inventory-management-api
required: true
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF638_Service_Inventory/4.0.0/swagger/TMF638_Service_Inventory_Management_API_v4.0.0_swagger.json
version: v4.0.0
path: not_defined
developerUI: not_defined
implementation: not_defined
port: 8080
resources:
- service:
- GET
- GET /id
- POST
- PATCH
- DELETE
- id: TMF701
apiType: openapi
apiSDO: tmForum
name: process-flow-management-api
required: false
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/TMF701_Process_Flow/4.1.0/swagger/TMF701_Process_Flow_Management_API_v4.1.0_beta_swagger.json
version: v4.0.0
path: not_defined
developerUI: not_defined
implementation: not_defined
port: 8080
resources:
- processFlow:
- POST
- GET
- GET /id
- DELETE
- taskFlow:
- PATCH
- GET
- GET /id
componentMetadata:
id: TMFC008
name: ServiceInventory
version: 1.2.0
description: The Service Inventory component is responsible for storage and exposure
of CFS (Customer Facing Services) that are associated to Product Inventory items.
It is also responsible for RFS (Resource Facing Service) definition, mapping
between CFS and RFS and mapping with infrastructure/network resources. The Service
Inventory component has functionality that enables creation of inventory items,
inventory organization, inventory search or filter, inventory monitoring and
tracking, inventory control and inventory auditing. The minimum check to be
performed at inventory item creation or update is for global consistency with
the related Service Catalog information.
publicationDate: 2024-11-12
status: specified
functionalBlock: Production
owners:
- email: Redacted
name: Redacted
url: Redacted
maintainers:
- name: Redacted
email: components@tmforum.org
url: Redacted
eTOMs:
- 1.4.4|Service_Support_Readiness|v23.0
- 1.4.4.1|Manage_Service_Inventory|v23.0
functionalFrameworkFunctions:
- 576|Service_Data_Retrieval|v23.0
- 593|Service_Inventory_Repository_Updating|v23.0
- 628|Service_to_Resource_Relationship_Management|v23.0
- 629|Service_to_Resource_Relationship_Synchronization|v23.0
- 630|Service-Resource_Relationship_Management_Notifications|v23.0
- 964|Onboarded_Service_Integration_Configuration|v23.0
- 965|Service_Instance_Lifecycle_Management|v23.0
- 1344|Service_Topology_Discovery|v23.0
SIDs:
- Service_Domain|Service_ABE|v25.0
managementFunction:
exposedAPIs:
- name: metrics
apiType: prometheus
apiSDO: not_defined
specification:
- url: '{{.Release.Name}}-{{.Values.component.name}}-sm'
version: v4.0.0
implementation: '{{.Release.Name}}-{{.Values.component.name}}-sm'
path: /{{.Release.Name}}-{{.Values.component.name}}/metrics
port: 4000
id: exposedAPI_id
version: exposedAPI_version
resources: []
required: false
developerUI: exposedAPI_developerUI
dependentAPIs:
- name: dependentAPI_name
id: dependentAPI_id
version: dependentAPI_version
apiType: dependentAPI_apiType
apiSDO: dependentAPI_apiSDO
specification:
- url: dependentAPI_spec
version: dependentAPI_version
resources: []
required: false
securityFunction:
canvasSystemRole: '{{ .Values.security.controllerRole }}'
secretsManagement:
type: sideCar
sideCar:
port: 8080
podSelector:
namespace: '{{ .Values.secretsManagement.podSelector.namespace }}'
name: '{{ .Values.secretsManagement.podSelector.name }}'
serviceaccount: '{{ .Values.secretsManagement.podSelector.serviceaccount }}'
exposedAPIs:
- id: TMF669
apiType: openapi
apiSDO: not_defined
name: party-role-management-api
required: true
specification:
- url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF669_Party_Role/4.0.0/swagger/TMF669_Party_Role_Management_API_v4.0.0_swagger.json
version: v4.0.0
path: /{{.Release.Name}}-{{.Values.component.name}}/tmf-api/partyRoleManagement/v4
developerUI: /{{.Release.Name}}-{{.Values.component.name}}/tmf-api/partyRoleManagement/v4/docs
implementation: '{{.Release.Name}}-partyroleapi'
port: 8080
resources: []
dependentAPIs: []
eventNotification:
publishedEvents:
- hub: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/serviceInventory/hub
implementation: /{{.Release.Name}}-serviceInventoryEvent
name: ServiceInventoryManagement
port: 80
resources:
- serviceCreateEvent
- serviceAttributeValueChangeEvent
- serviceStateChangeEvent
- serviceDeleteEvent
specification:
- url: https://github.com/tmforum-apis/TMF638_ServiceInventoryManagement/blob/master/TMF638_ServiceInventoryManagement-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: TMF638
apiSDO: not_defined
- hub: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/ProcessFlowManagement/hub
implementation: /{{.Release.Name}}-ProcessFlowManagementEvent
name: ProcessFlowManagement
port: 80
resources:
- processFlowCreateEvent
- processFlowStateChangeEvent
- processFlowStateDeleteEvent
- processFlowStateAttributeValueChangeEvent
- taskFlowCreateEvent
- taskFlowStateChangeEvent
- taskFlowDeleteEvent
- taskFlowAttributeValueChangeEvent
- taskFlowInformationRequiredEvent
specification:
- url: https://github.com/tmforum-apis/TMF701_ProcessFlow/blob/master/TMF701-ProcessFlow-v4.1.0.swagger.json
version: v4.0.0
apiType: openapi
id: TMF701
apiSDO: not_defined
subscribedEvents:
- implementation: /{{.Release.Name}}-ResourceInventoryManagement
name: ResourceInventoryManagement
port: 80
resources:
- resourceDeleteEvent
specification:
- url: https://open-api.tmforum.org20-ResourceInventory-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/Resource/call-back
apiSDO: not_defined
- implementation: /{{.Release.Name}}-ServiceInventoryManagement
name: ServiceInventoryManagement
port: 80
resources:
- serviceCreateEvent
- serviceAttributeValueChangeEvent
- serviceStateChangeEvent
- serviceDeleteEvent
specification:
- url: https://open-api.tmforum.org20-ServiceInventory-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/ServiceInventory/call-back
apiSDO: not_defined
- implementation: /{{.Release.Name}}-ServiceCatalogManagement
name: ServiceCatalogManagement
port: 80
resources:
- serviceSpecificationDeleteEvent
specification:
- url: https://open-api.tmforum.org20-ServiceCatalog-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/ServiceCatalog/call-back
apiSDO: not_defined
- implementation: /{{.Release.Name}}-PartyRoleManagement
name: PartyRoleManagement
port: 80
resources:
- partyRoleDeleteEvent
specification:
- url: https://open-api.tmforum.org20-PartyRole-v4.0.0.swagger.json
version: v4.0.0
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/PartyRole/call-back
apiSDO: not_defined
- implementation: /{{.Release.Name}}-GeographicSiteManagement
name: GeographicSiteManagement
port: 80
resources:
- geographicSiteDeleteEvent
specification:
- url: https://open-api.tmforum.org20-GeographicSite-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/GeographicSite/call-back
apiSDO: not_defined
- implementation: /{{.Release.Name}}-GeographicLocation
name: GeographicLocation
port: 80
resources:
- geographicLocationDeleteEvent
specification:
- url: https://open-api.tmforum.org20-GeographicLocatin-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/GeographicLocation/call-back
apiSDO: not_defined
- implementation: /{{.Release.Name}}-PartyManagement
name: PartyManagement
port: 80
resources:
- individualDeleteEvent
- organizationDeleteEvent
specification:
- url: https://open-api.tmforum.org20-Party-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/Party/call-back
apiSDO: not_defined
- implementation: /{{.Release.Name}}-ServiceOrderingManagement
name: ServiceOrderingManagement
port: 80
resources:
- serviceOrderDeleteEvent
specification:
- url: https://open-api.tmforum.org20-ServiceOrdering-v4.0.0.swagger.json
version: v4.0.0
apiType: openapi
id: null
callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/ServiceOrdering/call-back
apiSDO: not_defined
```
|