Cybus Documentation
1.0
  • Overview
  • Home Screen
  • Services
    • Structure of the commissioning file
      • version
      • description
      • metadata
      • parameters
      • definitions
      • resources
        • Cybus::Connection
        • Cybus::Endpoint
        • Cybus::Mapping
        • Cybus::Container
        • Cybus::Link
        • Cybus::IngressRoute
        • Cybus::User
        • Cybus::Role
        • Cybus::Volume
        • Cybus::File
        • Rules Objects
        • Cybus::Server
        • Cybus::Node
    • ServiceID
    • Inter-service referencing
    • Deviation
    • Working with Service Commissioning Files
    • Service Details View
    • Sample Service Commissioning Files
    • API Definition
  • Resources
  • User Management
  • Client Registry
  • Certificates
  • Explorer
  • Workbench
  • System
  • Backup and Restore
  • Configuration
  • Agents
  • Industry Protocol Details
  • Connectware Licensing
  • System Requirements
  • Changelog and Upgrade Guide
Cybus Documentation
  • Docs »
  • Services »
  • Structure of the commissioning file »
  • resources »
  • Cybus::Link
  • View page source

Cybus::Link¶

The link resource provides direct access to any web-resource. This resource can be completely external to the Connectware (e.g. https://github.com) or point to a location that is available within a container (when the container internally runs a web-server).

Link resources are typically rendered as buttons and provide a quick access to information (like dashboards, specific documentation, etc.)directly related to the corresponding service.

Note

If the internal HTTP server of a service container requires the button URLs to contain a trailing slash or some specific path on the container, please add that information to href parameter as well.

Properties¶

Property

Type

Required

Default

name

string

Required

href

string

Required

ingressRoute

string

Optional

name¶

Name of the link (label on the button)

  • type: string

    • maximum length: 20 characters

href¶

Href of the button link

  • type: string

ingressRoute¶

Reference to an already declared Cybus::IngressRoute. Use !ref <logicalId>

If this property is used the href property must be defined relative to the ingress route, i.e. only the path of the inner HTTP server must be defined.

  • type: string

Example¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
myDashboardLink:
  type: Cybus::Link
  properties:
    ingressRoute: !ref dashboardRoute
    href: ui/
    name: Dashboard

myExternalLink:
  type: Cybus::Link
  properties:
    href: https://github.com
    name: Github
Next Previous

© Copyright 2021, Cybus GmbH.

Built with Sphinx using a theme provided by Read the Docs.