system_packageSystemPackageSummary - Crosswork Network Controller 7.1 APIs

{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/26ac3d17-3e68-3a52-bd26-162688e83359","info":{"title":"Crosswork System Package Manager API","description":"System Package Manager provides API methods for patching system packages on Crosswork. This includes OS packages, K8S, CRI etc.","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/SYSTEM_PACKAGE/system-package-overview.md"}},"openapi":"3.0.0","servers":[{"url":"/crosswork/platform/v1"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token for API authentication."}}},"spec":{"type":"object","properties":{"package_id":{"type":"string","title":"Package id"},"package_data":{"type":"object","properties":{"package_id":{"type":"string","title":"Immutable Unique package identifier"},"version":{"type":"string","title":"Semantic version of package containing Major.minor.patch"},"summary":{"type":"object","properties":{"name":{"type":"string","title":"Immutable Unique package identifier"},"description":{"type":"string","title":"Description of package"}},"title":"Summary - marketing data","example":{"name":"nginx","description":"Web server"},"$$ref":"#/components/schemas/system_packageSummary"},"identifier_type":{"type":"string","enum":["UNKNOWN_IDENTIFIER_TYPE","COMPOSITE_PACKAGE","OS","CRI","K8S","CROSSWORK","CALICO","ORCHESTRATOR"],"default":"UNKNOWN_IDENTIFIER_TYPE","description":"- COMPOSITE_PACKAGE: Composite package","title":"Identifier type","example":"OS","$$ref":"#/components/schemas/system_packageIdentifierType"},"category":{"type":"string","enum":["UNKNOWN_CATEGORY","SYSTEM_PACKAGE"],"default":"UNKNOWN_CATEGORY","title":"system package Object Category","example":"SYSTEM_PACKAGE","$$ref":"#/components/schemas/system_packageCategory"},"build_information":{"type":"object","properties":{"date_time":{"type":"string","title":"Date on which image was built in RFC339 format"},"publisher":{"type":"string","title":"Publisher information"}},"title":"Build Information","example":{"date_time":"2023-01-01T00:00:00Z","publisher":"Cisco"},"$$ref":"#/components/schemas/system_packageBuildInformation"},"contents":{"type":"array","items":{"type":"object","properties":{"unit_id":{"type":"string","title":"Immutable Unique package identifier"},"version":{"type":"string","title":"Semantic version of package containing Major.minor.patch"},"description":{"type":"string","title":"Description of pod,resource"},"summary":{"type":"object","properties":{"name":{"type":"string","title":"Immutable Unique package identifier"},"description":{"type":"string","title":"Description of package"}},"title":"Summary - marketing data","example":{"name":"nginx","description":"Web server"},"$$ref":"#/components/schemas/system_packageSummary"},"identifier_Type":{"type":"string","enum":["UNKNOWN_IDENTIFIER_TYPE","COMPOSITE_PACKAGE","OS","CRI","K8S","CROSSWORK","CALICO","ORCHESTRATOR"],"default":"UNKNOWN_IDENTIFIER_TYPE","description":"- COMPOSITE_PACKAGE: Composite package","title":"Identifier type","example":"OS","$$ref":"#/components/schemas/system_packageIdentifierType"},"category":{"type":"string","enum":["UNKNOWN_CATEGORY","SYSTEM_PACKAGE"],"default":"UNKNOWN_CATEGORY","title":"system package Object Category","example":"SYSTEM_PACKAGE","$$ref":"#/components/schemas/system_packageCategory"},"dependency_constraints":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"identifier object ,cannot contain only alphabets _"},"identifier_type":{"type":"string","enum":["UNKNOWN_IDENTIFIER_TYPE","COMPOSITE_PACKAGE","OS","CRI","K8S","CROSSWORK","CALICO","ORCHESTRATOR"],"default":"UNKNOWN_IDENTIFIER_TYPE","description":"- COMPOSITE_PACKAGE: Composite package","title":"Identifier type","example":"OS","$$ref":"#/components/schemas/system_packageIdentifierType"},"version_range":{"type":"string","title":"examples of valid range - \"\u003c1.0.0\",\"\u003c=1.0.0\",\"\u003e1.0.0\",\"\u003e=1.0.0\",\"1.0.0\", \"=1.0.0\",\"\u003e=1.0.0 \u003c=2.0.0\" or \"*\" indicating all versions is exceptable"}},"description":"constraint stanza defines rules for how a direct dependency must be incorporated into the dependency graph.","example":{"id":"dependency1","identifier_type":"OS","version_range":"\u003e=1.0.0 \u003c2.0.0"},"$$ref":"#/components/schemas/system_packageConstraint"},"title":"List of Dependencies"},"build_information":{"type":"object","properties":{"date_time":{"type":"string","title":"Date on which image was built in RFC339 format"},"publisher":{"type":"string","title":"Publisher information"}},"title":"Build Information","example":{"date_time":"2023-01-01T00:00:00Z","publisher":"Cisco"},"$$ref":"#/components/schemas/system_packageBuildInformation"},"meta_schema_version":{"type":"string","title":"Schema Spec version"},"order":{"type":"integer","format":"int32","title":"Sequence in which package should be applied"}},"title":"System package deployment units","example":{"unit_id":"unit123","version":"1.0.0","description":"Unit for web server","category":"SYSTEM_PACKAGE","order":1},"$$ref":"#/components/schemas/system_packagePackageUnit"},"title":"List of constituent contents that make up the package"},"dependency_constraints":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"identifier object ,cannot contain only alphabets _"},"identifier_type":{"type":"string","enum":["UNKNOWN_IDENTIFIER_TYPE","COMPOSITE_PACKAGE","OS","CRI","K8S","CROSSWORK","CALICO","ORCHESTRATOR"],"default":"UNKNOWN_IDENTIFIER_TYPE","description":"- COMPOSITE_PACKAGE: Composite package","title":"Identifier type","example":"OS","$$ref":"#/components/schemas/system_packageIdentifierType"},"version_range":{"type":"string","title":"examples of valid range - \"\u003c1.0.0\",\"\u003c=1.0.0\",\"\u003e1.0.0\",\"\u003e=1.0.0\",\"1.0.0\", \"=1.0.0\",\"\u003e=1.0.0 \u003c=2.0.0\" or \"*\" indicating all versions is exceptable"}},"description":"constraint stanza defines rules for how a direct dependency must be incorporated into the dependency graph.","example":{"id":"dependency1","identifier_type":"OS","version_range":"\u003e=1.0.0 \u003c2.0.0"},"$$ref":"#/components/schemas/system_packageConstraint"},"title":"List of Dependencies"},"meta_schema_version":{"type":"string","title":"Schema Spec version"}},"title":"Composite system package data","example":{"package_id":"package123","version":"1.0.0","summary":{"name":"nginx","description":"Web server"},"identifier_type":"OS","category":"SYSTEM_PACKAGE","build_information":{"date_time":"2023-01-01T00:00:00Z","publisher":"Cisco"}},"$$ref":"#/components/schemas/system_packageSystemPackageData"},"package_state":{"type":"object","properties":{"package_id":{"type":"string","title":"Immutable package id"},"version":{"type":"string","title":"Semantic version of package containing Major.minor.patch, will be populated if package is active"},"possible_actions":{"type":"array","items":{"type":"string","enum":["UNKNOWN_ACTION","APPLY","UPDATE","VIEW_PACKAGE_DETAILS"],"default":"UNKNOWN_ACTION","title":"Actions that can be performed on package","example":"APPLY","$$ref":"#/components/schemas/system_packagePackageAction"},"title":"Package actions that can be performed given the current state"},"available_updates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"id","description":"System package identifier.","default":"spack"},"version":{"type":"string","title":"version","description":"Version of the system package."}},"required":["id","version"],"title":"Repo system package identifier","example":{"id":"package123","version":"1.0.0"},"$$ref":"#/components/schemas/system_packagePackageIdentifier"},"title":"list of available updates"},"pending_action":{"type":"object","properties":{"action":{"type":"string","enum":["UNKNOWN_ACTION","APPLY","UPDATE","VIEW_PACKAGE_DETAILS"],"default":"UNKNOWN_ACTION","title":"Actions that can be performed on package","example":"APPLY","$$ref":"#/components/schemas/system_packagePackageAction"},"job_id":{"type":"string","title":"job_id"}},"title":"Pending Action for Package","example":{"action":"APPLY","job_id":"job123"},"$$ref":"#/components/schemas/system_packagePendingPackageAction"},"last_operation_error":{"type":"object","properties":{"message":{"type":"string","title":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI"}},"title":"Error associated with an Object","example":{"message":"An error occurred while processing the request."},"$$ref":"#/components/schemas/common_platformError"},"VMStatus":{"type":"array","items":{"type":"object","properties":{"vmName":{"type":"string","title":"name of vm for which package is applied"},"apply_id":{"type":"string","title":"unique apply id per package"},"status":{"type":"string","enum":["UNKNOWN_STATE","APPLIED","APPLY_FAILED","UPDATE_FAILED","APPLYING","UPDATING","PUSHING","PUSHED"],"default":"UNKNOWN_STATE","title":"System Package status","example":"APPLIED","$$ref":"#/components/schemas/system_packageStatus"},"progress":{"type":"number","format":"float","title":"Progress of transient state, if any"},"vmIp":{"type":"string","title":"ip of the vm"}},"example":{"vmName":"vm1","apply_id":"apply123","status":"APPLIED","progress":100,"vmIp":"192.168.1.10"},"$$ref":"#/components/schemas/system_packageVMStatus"},"title":"status of vm package installations"},"OSPackage":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"description":{"type":"string"},"version_history":{"type":"array","items":{"type":"object","properties":{"package":{"type":"string"},"version":{"type":"string"},"update_time":{"type":"string","format":"int64"}},"example":{"package":"nginx","version":"1.17.0","update_time":"1610000000000"},"$$ref":"#/components/schemas/system_packageOSPackageVersionHistory"}}},"example":{"name":"nginx","version":"1.18.0","description":"Web server"},"$$ref":"#/components/schemas/system_packageOSPackage"},"title":"os package details"},"description":{"type":"string","title":"description of packagestate"},"status":{"type":"string","enum":["UNKNOWN_STATE","APPLIED","APPLY_FAILED","UPDATE_FAILED","APPLYING","UPDATING","PUSHING","PUSHED"],"default":"UNKNOWN_STATE","title":"System Package status","example":"APPLIED","$$ref":"#/components/schemas/system_packageStatus"}},"title":"Notification object\nContext id : robot.orchestrator.systempackage.packagestate.json\nSystem Package current state along with this events","example":{"package_id":"package123","version":"1.0.0","possible_actions":["APPLY","UPDATE"],"status":"APPLIED"},"$$ref":"#/components/schemas/system_packagePackageState"}},"example":{"package_id":"package123","package_data":{"package_id":"package123","version":"1.0.0","summary":{"name":"nginx","description":"Web server"}},"package_state":{"package_id":"package123","version":"1.0.0","status":"APPLIED"}},"$$ref":"#/components/schemas/system_packageSystemPackageSummary","title":"system_packageSystemPackageSummary"}}