SDK2.0 Messages

App Install

App Installation

Sequence Diagram

Install Message[Json]

{
  "messageId": "5a578452-bfd6-4614-8d79-bda3bb0adfa9",
  "messageVersion": "2.0.0",
  "appIntegrationId": "0bc95e12-ac99-427b-bf48-2235f198d970",
  "referenceId": "dc8abeaf-fd1f-44e0-b3ee-1142d277b040",
  "app": "AppController",
  "module": "App",
  "subtype": "Core",
  "action": "Install",
  "managementProfileId": "b4a64f28-e531-455e-b0ea-d5c853b4078a",
  "payload": {
    "app": "sample-sdk-app",
    "version": "1.0.0",
    "helm": {
      "pullType": "chart",
      "url": null,
      "credentials": {
        "username": null,
        "password": null,
        "token": null
      }
    },
    "maven": {
      "url": null
    }
  }
}

---

App Upgrade

App Upgrade

Sequence Diagram

@startuml upgrade message

title SDK2.0 App Upgrade Message Flow

inboundchannel -> messagesorter: Upgrade Message
messagesorter  -> serviceregistry: Upgrade Message

serviceregistry -> gatewaymanager: Upgrade Message
gatewaymanager --> serviceregistry: Upgrade Message Response
@enduml

Upgrade Message[Json]

{
  "messageId": "3cff7fd9-a629-4c25-954b-7cc7611ca6ab",
  "messageVersion": "2.0.0",
  "appIntegrationId": "0bc95e12-ac99-427b-bf48-2235f198d970",
  "referenceId": "cce5d149-d09e-42b8-9b0a-b4da951cce59",
  "app": "AppController",
  "module": "App",
  "subtype": "Core",
  "action": "Update",
  "managementProfileId": "b4a64f28-e531-455e-b0ea-d5c853b4078a",
  "payload": {
    "app": "sample-sdk-app",
    "version": "1.1.0",
    "helm": {
      "pullType": "chart",
      "url": null,
      "credentials": {
        "username": null,
        "password": null,
        "token": null
      }
    },
    "maven": {
      "url": null
    }
  }
}

---

App Uninstall

App Uninstall

Sequence Diagram

@startuml Uninstall message

title SDK2.0 App Uninstall Message Flow

inboundchannel -> messagesorter: Uninstall Message
messagesorter  -> serviceregistry: Uninstall Message

serviceregistry -> gatewaymanager: Uninstall Message
gatewaymanager --> serviceregistry: Uninstall Message Response
@enduml

Uninstall Message[Json]

{
  "messageId": "b660d3ba-8f23-4f10-92ac-753fc5253e9e",
  "messageVersion": "2.0.0",
  "appIntegrationId": "0bc95e12-ac99-427b-bf48-2235f198d970",
  "referenceId": "2cc4cd9e-dde4-48e9-8936-77d553da1526",
  "app": "AppController",
  "module": "App",
  "subtype": "Core",
  "action": "Uninstall",
  "managementProfileId": "b4a64f28-e531-455e-b0ea-d5c853b4078a",
  "payload": {
    "app": "sample-sdk-app"
  }
}

---

Discovery Configuration Update

Discovery Configuration

Sequence Diagram

@startuml Uninstall message

title SDK2.0 App Discovery Message Flow

inboundchannel -> messagesorter: Discovery Configuration
messagesorter  -> schedulerservice: Discovery Scheduled Message

messagesorter  -> App: Discovery on-demand Message
schedulerservice  -> App: Discovery Scheduled Message
App -> outboundchannel : Resource Data
App -> outboundchannel : Relationship Data

@enduml

Discovery Configuration [Json]

{
  "messageId": "e92fbcce-91a1-4a90-97dd-f90be627cdc9",
  "messageVersion": "2.0.0",
  "appIntegrationId": "INTG-c7afb76c-a74e-4c40-bfab-3bffd5223a2f",
  "managementProfileId": "9d3f3eec-28f9-4696-9b8b-1d801692e036",
  "gateway": "9d3f3eec-28f9-4696-9b8b-1d801692e036",
  "module": "Discovery",
  "subtype": "Configuration",
  "app": "mock-vcenter-tested",
  "action": "Update",
  "configurationId": "ADAPTER-MANIFEST-65a5e123-65ad-41bc-8247-e8b12b11c09c",
  "configurationName": "vCenterTest1",
  "payload": {
    "data": {
      "port": "45000",
      "ipAddress": "172.25.252.193",
      "vcenterName": "vcenter1",
      "protocol": "http",
      "credentialId": [
        "6tAMNkXh5mSgVKUUVyNyTeWv"
      ]
    },
    "nativeTypes": {
      "vm": {
        "resourceType": "Server"
      },
      "host": {
        "resourceType": "Server"
      }
    }
  },
  "requireAck": false,
  "sha": "b87430a5051dec140907ead5a7a0c4bd0ef6a15e104d1300c0e00d58c3a720a6"
}

---

Discovery Configuration Delete

Discovery Configuration Delete

Sequence Diagram

@startuml Uninstall message

title SDK2.0 App Uninstall Message Flow

inboundchannel -> messagesorter: Discovery Configuration
messagesorter  -> schedulerservice: Discovery Scheduled Delete Message

@enduml

Discovery Configuration Delete[Json]

{
  "messageId": "461e8c70-fae6-4178-a085-d4097d98b862",
  "messageVersion": "2.0.0",
  "appIntegrationId": "INTG-e195bc0d-1bd7-4392-b87a-86a2d5304a04",
  "managementProfileId": "9d3f3eec-28f9-4696-9b8b-1d801692e036",
  "gateway": "9d3f3eec-28f9-4696-9b8b-1d801692e036",
  "module": "Discovery",
  "subtype": "Configuration",
  "app": "mock-vcenter-tested",
  "action": "Delete",
  "configurationId": "ADAPTER-MANIFEST-3c53e214-49fd-4755-85fe-883e6d6a0bfe",
  "configurationName": "vCenterTest",
  "payload": {
    "data": {
      "port": "45000",
      "protocol": "http",
      "ipAddress": "172.25.252.193",
      "vcenterName": "vcenter1",
      "credentialId": [
        "6tAMNkXh5mSgVKUUVyNyTeWv"
      ]
    },
    "nativeTypes": {
      "vm": {
        "resourceType": "Server"
      },
      "host": {
        "resourceType": "Server"
      }
    }
  },
  "requireAck": false
}

---

Monitoring Configuration Update

Monitoring Configuration Update

Sequence Diagram

@startuml Monitoring Configuration Update

title SDK2.0 App Monitoring Configuration Message Flow

inboundchannel -> messagesorter: Monitoring Configuration
messagesorter  -> schedulerservice: Monitoring Configuration

@enduml

Monitoring Configuration [Json]

{
  "messageId": "73f8ad5a-2619-443e-9034-0b8b80f08ab1",
  "messageVersion": "2.0.0",
  "app": "mock-vcenter-tested",
  "module": "Monitoring",
  "subtype": "Configuration",
  "action": "Update",
  "payload": {
    "templateId": "2ff1793f-edbc-426d-ada1-1cd30af71c55",
    "nativeType": "host",
    "monitors": {
      "Performance Monitor mock-vcenter-tested host ": {
        "name": "Performance Monitor mock-vcenter-tested host ",
        "uuid": "1cec604c-3362-438a-8f8d-adcb9d23b400",
        "frequency": 5,
        "metrics": {
          "system_cpu_usage_utilization": {
            "availibityMetric": true,
            "units": "%",
            "graph": {
              "graphPoint": true
            },
            "notification": {
              "raiseAlert": true,
              "alertOn": "Static",
              "warn": {
                "operator": "GREATER_THAN",
                "value": "50",
                "repeat": 1
              },
              "critical": {
                "operator": "GREATER_THAN",
                "value": "70",
                "repeat": 1
              }
            },
            "formatPlottedValue": false
          }
        }
      }
    },
    "templateCustomization": {
      "customComponentThresholds": []
    }
  }
}

---

Monitoring Configuration Delete

Monitoring Configuration Delete

Sequence Diagram

@startuml Monitoring Configuration Delete

title SDK2.0 App Monitoring Configuration Delete Message Flow

inboundchannel -> messagesorter: Monitoring Configuration
messagesorter  -> schedulerservice: Monitoring Configuration

@enduml

Monitoring Configuration [Json]

---

App Flow

App Flow

Sequence Diagram

@startuml App message flow

title App message flow

platform.or.content.core <-- app.core
app.core <- app: Bootstrap and intialization
platform.or.content.core <- app.core : Cache and message publisher init
app -> app.core : Register action handlers
app ->  app.core : Register resource type handlers
app ->  app.core : Register debug handlers
app ->  app.core : Register log handler
platform.or.content.core -> app.core : Discovery message
app.core -> app : Processed discovery message
app -> target : Discover resources and its relationships
target -> app : Construct discovery payload
app -> app.core : Filtering resources
app -> app.core : Filtering relationships
app -> app.core : Resource update
app -> app.core : Resource delete
app -> app.core : Chunking resources
app.core -> platform.or.content.core : Resource publisher
app -> app.core : Relationship acknowledge sender
app -> app.core : Relationship delete
app -> app.core : Chunking relationships
app.core -> platform.or.content.core : Relationship publisher
platform.or.content.core -> app.core : monitoring message
app.core -> app : Processed monitoring message
app -> target : Monitor resources
target -> app : Construct monitoring payload
app -> app.core : Metric and alert processing
app.core -> platform.or.content.core : Metric publisher
app.core -> platform.or.content.core : Alert publisher

@enduml