Cisco Observability Platform

This documentation and the Cisco Observability Platform functionalities it describes are subject to change. Data saved on the platform may disappear and APIs may change without notice.

Introduction

For an introduction to solution concepts, see Cisco Observability Platform Solutions. This page describes solution structure and naming conventions.

Solution Structure

A solution and all of its components are represented by a .zip file with the following directory structure:

  • A root directory named after the solution.
    • A manifest file. This file is mandatory and must be located in the root directory.
    • (Optional) Knowledge type definition files.
    • (Optional) Knowledge object files.
    • (Optional) Blob properties files.

Solution files can be in JSON or YAML format. Solutions can also use a combination of JSON and YAML files.

Manifest File

The manifest file helps the solution developer understand the structure of the solution, defines the solution's metadata, and describes the solution’s dependencies and components. It contains:

  • Knowledge types defined by the solution.
  • Knowledge objects to be published by the solution. These objects will be created at the SOLUTION layer.
  • Solution dependencies that will determine the sequence of solution installation. If a solution is dependent on other solutions, the Knowledge Store will install those solutions first.
    • Example: Solution 1 depends on Solution 2. Solution 2 depends on Solution 3. When you try to install Solution 1, the Knowledge Store will install the solutions in the following order:
      • Solution 3
      • Solution 2
      • Solution 1

Solution Manifest Attributes

The following table displays the complete list of attributes for a solution manifest:

Attribute Data Type Required Description
manifestVersion String Yes The version number of the manifest file. Accepted values: 1.0.0, 1.1.0.
name String Yes The name of the solution. See Solution Names.
solutionVersion String Yes The version of the solution. Must adhere to semantic versioning specifications. See https://semver.org/.
description String Yes The description of the solution.
contact String Yes The contact information for the lead of the solution.
homepage String No The URL of the solution’s home page.
gitRepoUrl String No The URL of the solution's git repository.
readme String No The URL of the solution's readme file.
dependencies Array of strings No A list of strings representing the list of solutions the solution depends on.
types Array of strings No A list of strings representing the paths for knowledge type definition files within the solution.
objects Array of solution component definitions No An array of solution component definitions. Each solution component definition describes:
  • type: The fully qualified type of the component.
  • objectsFile: The fully qualified path of the component definition files within the solution.
solutionType String No This attribute is only supported for manifestVersion >= 1.1.0.
A string that defines the solution type. If this attribute is not set, it defaults to component. Accepted values:
  • module: Adds to the functionality of applications or modules.
  • component: A building block for modules and applications.
For more information on solution types, see Modules and Components.

Example Manifest File

The following manifest file describes the Space Fleet solution:

Expand
json
yaml
Copy{
    "manifestVersion": "1.0.0",
    "name": "spacefleet",
    "solutionVersion": "0.0.907",
    "dependencies": [
        "dashui",
        "fmm",
        "k8s",
        "zodiac",
        "codex",
        "healthrule",
        "iam"
    ],
    "description": "Space Fleet reference solution",
    "contact": "support@appd.com",
    "gitRepoUrl": "https://bitbucket.corp.appdynamics.com/projects/FSORS/repos/spacefleet-solution",
    "readme": "readme.md",
    "objects": [
        {
            "type": "fmm:namespace",
            "objectsFile": "objects/fmm/topology/namespace.json"
        },
        {
            "type": "fmm:metric",
            "objectsFile": "objects/fmm/metrics/metric-types.json"
        },
        {
            "type": "fmm:metricDerivation",
            "objectsFile": "objects/fmm/metrics/metric-derivations.json"
        },
        {
            "type": "fmm:metricAggregation",
            "objectsFile": "objects/fmm/metrics/metric-aggregations.json"
        },
        {
            "type": "fmm:event",
            "objectsFile": "objects/fmm/events/event-types.json"
        },
        {
            "type": "fmm:entity",
            "objectsFile": "objects/fmm/topology/entity-types.json"
        },
        {
            "type": "fmm:entityPriority",
            "objectsFile": "objects/fmm/topology/entity-priorities.json"
        },
        {
            "type": "fmm:resourceMapping",
            "objectsFile": "objects/fmm/topology/resource-mappings.json"
        },
        {
            "type": "fmm:associationDeclaration",
            "objectsFile": "objects/fmm/topology/association-declarations.json"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/spacecraft"
        },
        {
            "type": "dashui:settingsConfig",
            "objectsDir": "objects/dashui/settings"
        },
        {
            "type": "dashui:form",
            "objectsDir": "objects/dashui/forms"
        },
        {
            "type": "zodiac:function",
            "objectsFile": "objects/zodiac/cloudCollector.json"
        },
        {
            "type": "zodiac:function",
            "objectsFile": "objects/zodiac/datagen.json"
        },
        {
            "type": "zodiac:function",
            "objectsFile": "objects/zodiac/notd.json"
        },
        {
            "type": "zodiac:function",
            "objectsFile": "objects/zodiac/restApiFunction.json"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/rooms"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/shield"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/warpDrive"
        },
        {
            "type": "dashui:entityPage",
            "objectsDir": "objects/dashui/entityPages"
        },
        {
            "type": "codex:workflow",
            "objectsFile": "objects/codex/logTransformation.json"
        },
        {
            "type": "codex:workflow",
            "objectsFile": "objects/codex/criticalShield.json"
        },
        {
            "type": "codex:workflow",
            "objectsFile": "objects/codex/newsfeedEventGenerateMetric.json"
        },
        {
            "type": "codex:workflow",
            "objectsFile": "objects/codex/eventMasking.json"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/general"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/torpedoTube"
        },
        {
            "type": "dashui:entityPresentation",
            "objectsDir": "objects/dashui/entityPresentations"
        },
        {
            "type": "dashui:templatePropsExtension",
            "objectsDir": "objects/dashui/templatePropsExtensions"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/events"
        },
        {
            "type": "healthrule:healthRuleTemplate",
            "objectsFile": "objects/fmm/alerts/health-rule-templates.json"
        },
        {
            "type": "zodiac:subscriptionCronConfig",
            "objectsFile": "objects/zodiac/datagenCron.json"
        },
        {
            "type": "zodiac:subscriptionCronConfig",
            "objectsFile": "objects/zodiac/cloudCollectorCron.json"
        },
        {
            "type": "iam:Role",
            "objectsFile": "objects/iam/roles.json"
        },
        {
            "type": "iam:Permission",
            "objectsFile": "objects/iam/types-permissions.json"
        },
        {
            "type": "iam:Permission",
            "objectsFile": "objects/iam/apis-permissions.json"
        },
        {
            "type": "iam:RoleToPermissionMapping",
            "objectsFile": "objects/iam/role-to-permission-mappings.json"
        },
        {
            "type": "dashui:template",
            "objectsFile": "objects/dashui/templates/dashboards/spacefleetDashboard.json"
        },
        {
            "type": "dashui:template",
            "objectsDir": "objects/dashui/templates/dashboards/widgets"
        },
        {
            "type": "dashui:navPresentation",
            "objectsDir": "objects/dashui/navPresentation"
        },
        {
            "type": "dashui:eventContent",
            "objectsDir": "objects/dashui/eventContents"
        }
    ],
    "types": [
        "types/notd_config.json",
        "types/torpedo_state.json",
        "types/starjournal.json"
    ]
}

CopymanifestVersion: 1.0.0
name: spacefleet
solutionVersion: 0.0.907
dependencies:
- dashui
- fmm
- k8s
- zodiac
- codex
- healthrule
- iam
description: Space Fleet reference solution
contact: support@appd.com
gitRepoUrl: https://bitbucket.corp.appdynamics.com/projects/FSORS/repos/spacefleet-solution
readme: readme.md
objects:
- type: fmm:namespace
  objectsFile: objects/fmm/topology/namespace.json
- type: fmm:metric
  objectsFile: objects/fmm/metrics/metric-types.json
- type: fmm:metricDerivation
  objectsFile: objects/fmm/metrics/metric-derivations.json
- type: fmm:metricAggregation
  objectsFile: objects/fmm/metrics/metric-aggregations.json
- type: fmm:event
  objectsFile: objects/fmm/events/event-types.json
- type: fmm:entity
  objectsFile: objects/fmm/topology/entity-types.json
- type: fmm:entityPriority
  objectsFile: objects/fmm/topology/entity-priorities.json
- type: fmm:resourceMapping
  objectsFile: objects/fmm/topology/resource-mappings.json
- type: fmm:associationDeclaration
  objectsFile: objects/fmm/topology/association-declarations.json
- type: dashui:template
  objectsDir: objects/dashui/templates/spacecraft
- type: dashui:settingsConfig
  objectsDir: objects/dashui/settings
- type: dashui:form
  objectsDir: objects/dashui/forms
- type: zodiac:function
  objectsFile: objects/zodiac/cloudCollector.json
- type: zodiac:function
  objectsFile: objects/zodiac/datagen.json
- type: zodiac:function
  objectsFile: objects/zodiac/notd.json
- type: zodiac:function
  objectsFile: objects/zodiac/restApiFunction.json
- type: dashui:template
  objectsDir: objects/dashui/templates/rooms
- type: dashui:template
  objectsDir: objects/dashui/templates/shield
- type: dashui:template
  objectsDir: objects/dashui/templates/warpDrive
- type: dashui:entityPage
  objectsDir: objects/dashui/entityPages
- type: codex:workflow
  objectsFile: objects/codex/logTransformation.json
- type: codex:workflow
  objectsFile: objects/codex/criticalShield.json
- type: codex:workflow
  objectsFile: objects/codex/newsfeedEventGenerateMetric.json
- type: codex:workflow
  objectsFile: objects/codex/eventMasking.json
- type: dashui:template
  objectsDir: objects/dashui/templates/general
- type: dashui:template
  objectsDir: objects/dashui/templates/torpedoTube
- type: dashui:entityPresentation
  objectsDir: objects/dashui/entityPresentations
- type: dashui:templatePropsExtension
  objectsDir: objects/dashui/templatePropsExtensions
- type: dashui:template
  objectsDir: objects/dashui/templates/events
- type: healthrule:healthRuleTemplate
  objectsFile: objects/fmm/alerts/health-rule-templates.json
- type: zodiac:subscriptionCronConfig
  objectsFile: objects/zodiac/datagenCron.json
- type: zodiac:subscriptionCronConfig
  objectsFile: objects/zodiac/cloudCollectorCron.json
- type: iam:Role
  objectsFile: objects/iam/roles.json
- type: iam:Permission
  objectsFile: objects/iam/types-permissions.json
- type: iam:Permission
  objectsFile: objects/iam/apis-permissions.json
- type: iam:RoleToPermissionMapping
  objectsFile: objects/iam/role-to-permission-mappings.json
- type: dashui:template
  objectsFile: objects/dashui/templates/dashboards/spacefleetDashboard.json
- type: dashui:template
  objectsDir: objects/dashui/templates/dashboards/widgets
- type: dashui:navPresentation
  objectsDir: objects/dashui/navPresentation
- type: dashui:eventContent
  objectsDir: objects/dashui/eventContents
types:
- types/notd_config.json
- types/torpedo_state.json
- types/starjournal.json

Knowledge Object Files

A solution may contain knowledge object files that represent each of the different knowledge objects listed in the manifest file. In the example manifest file for Space Fleet, the knowledge objects are listed in the following section:

json
yaml
Copy"objects": [
        {
            "type": "fmm:namespace",
            "objectsFile": "objects/fmm/topology/namespace.json"
        },
        {
            "type": "fmm:metric",
            "objectsFile": "objects/fmm/metrics/metric-types.json"
        }
        ...
        ...
]

Copyobjects:
- type: fmm:namespace
  objectsFile: objects/fmm/topology/namespace.json
- type: fmm:metric
  objectsFile: objects/fmm/metrics/metric-types.json
...
...

For more information on knowledge objects, see Define a Knowledge Object.

The Knowledge Store can create knowledge objects of knowledge types that are not part of your solution .zip. For example, the Space Fleet solution has an fmm solution dependency listed in the dependencies section of the above example manifest file. Because the fmm solution is listed as a dependency, the Space Fleet solution can create knowledge objects of the fmm:metric type.

Knowledge Type Definition Files

A solution may contain knowledge type definition files that represent each of the different solution types listed in the manifest file. In the example manifest file for Space Fleet, the knowledge types are listed in the following section:

json
yaml
Copy"types": [
    "types/notd_config.json",
    "types/torpedo_state.json",
    "types/starjournal.json"
]

Copytypes:
- types/notd_config.json
- types/torpedo_state.json
- types/starjournal.json

For more information on knowledge types, see Define a Knowledge Type.

Solution Naming Conventions

Solution Names

The solution name is the name of your original solution. This value is defined using the name attribute in the manifest file. See Solution Manifest Attributes.

A solution name is a string that:

  • Adheres to the regular expression syntax of ^[a-z][a-z0-9_]*$.
    • Note: Underscores (_) are only supported in solution names for solutions that do not contain solution services functions.
  • Can be a maximum length of 25 characters.
Next