Cheat Sheet

Using nivio's proprietary YAML format

    items:
    - identifier: blog-server
      name: Demo Blog
      type: webservice
      # assign to a group via the group identifier
      group: content
      icon: https://s.w.org/style/images/about/WordPress-logotype-wmark.png
      version: 1.0
      software: Wordpress
      owner: Marketing
      description: Company blog
      team: alphateam
      contact: [email protected]
      # add a map/dictionary of links. github/gitlab have a special meaning and are parsed
      links:
        homepage: https://acme.io
        gitlab: https://gitlab.com/foo/blog-server
        github: https://github.com/foo/blog-server
      visibility: public
      tags:
      - CMS
      - UI
      networks:
      - content
      scale: 5
      hostType: docker
      note: to be replaced
      lifecycle: EOL
      statuses:
        - label: security
          status: red
          message: uses outdated version
      # relations to other services
      relations:
      - description: hourly push KPI data
        target: kpi-dashboard
        format: json
        type: dataflow
      # same as relations, but points to identifiers of items this one is dependend of
      providedBy:
      - wordpress-web
      - wordpress-mariadb
      - wordpress-redis

Use labels on docker/k8s containers

Nivio can use k8s and docker-compose files as input source. Prepend container labels with "nivio." in order to assign the values to item properties and make sure to surround urls with double quotes.

 services:
      foo:
        labels:
          nivio.name: A nice name
          nivio.providedBy: "bar, baz"
          nivio.relations: "atarget, anotherTarget"
          nivio.link.github: "https://github.com/foo/bar"