role_missing_metadata

Category

Documentation

Severity

Error

What It Does

Checks all v2 roles if the metadata file is present.

Why Is This Bad

For documentation purposes the metadata file should be present.

How To Fix

Create a metadata.yaml file in the role folder with the content specified in http://saltdocs.tcs.trv.cloud/master/docs/rfcs/salt1-role_metadata.html.

Example metadata.yaml from role.loadbalancer_datacenter
name: loadbalancer_datacenter
description: Role for the loadbalancers in SFO, DCA and HKG. They take HTTP
  traffic and route/forward them to the webservers and take HTTPs traffic and
  forward them to the `ssl_terminators`.
maintainers:
  - alexander.thaller@trivago.com
  - florian.kruschel@trivago.com
  - marc.peters@trivago.com

Known Problems

None

Example

states/role/elasticsearch_master
└── init.sls

0 directories, 1 file

[source,lintoutput]

Error: role elasticsearch_master does not have a metadata file at the expected path file: "/home/athaller/code/work/salt/saltstack/states/role/elasticsearch_master/metadata.yaml" quickfix: create an file under "/home/athaller/code/work/salt/saltstack/states/role/elasticsearch_master/metadata.yaml" specified in http://saltdocs.tcs.trv.cloud/master/docs/rfcs/salt1-role_metadata.html category: Documentation help: for more information see http://saltdocs.tcs.trv.cloud/master/lints.html#_role_missing_metadata


results matching ""

    No results matching ""