[feature request] Add a description field for the provisioners

[mathieu-benoit]

To improve how PEs document their provisioners and expose them to their Devs, it would be better to have a description field in the provisioners files.

Today, if we add this field in the provisioners files, we get this error:

Error: failed to save provisioner 1: invalid provisioners file: 0: cmd://python3#dotenv: failed to parse: yaml: unmarshal errors:
  line 9: field description not found in type cmdprov.Provisioner

Rough list of things to do to implement this:

• Support this field in the cmdprov.Provisioner and templateprov.Provisioner and other places where needed
• Update all the current default provisioners with their description
• Update score-compose provisioners list to display by default this new description field

This field should be optional, to avoid any breaking changes with existing/current provisioners.

Note: here is an example of how this could be used: score-spec/community-provisioners#8

[lekaf974]

@mathieu-benoit I can give this one a try too

[mathieu-benoit]

@mathieu-benoit I can give this one a try too

Oh yes! Please go ahead, and thanks! Much appreciated!

[lekaf974]

did a quick iteration before making thing cleaner

+---------------+-------+------------------+--------------------------------+--------------------------------+
|     TYPE      | CLASS |      PARAMS      |            OUTPUTS             |          DESCRIPTION           |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| amqp          | (any) |                  | host, password, port,          |                                |
|               |       |                  | username, vhost                |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| dns           | (any) |                  | host                           | This provisioner is a          |
|               |       |                  |                                | placeholder for future DNS     |
|               |       |                  |                                | control                        |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| elasticsearch | (any) |                  | host, password, port, username |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| kafka-topic   | (any) |                  | host, name, num_partitions,    |                                |
|               |       |                  | port                           |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| mongodb       | (any) |                  | connection, host, password,    |                                |
|               |       |                  | port, username                 |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| mssql         | (any) |                  | connection, database,          |                                |
|               |       |                  | password, port, server,        |                                |
|               |       |                  | username                       |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| mysql         | (any) |                  | database, host, name,          |                                |
|               |       |                  | password, port, username       |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| postgres      | (any) |                  | database, host, name,          |                                |
|               |       |                  | password, port, username       |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| redis         | (any) |                  | host, password, port, username |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| route         | (any) | host, path, port |                                |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| s3            | (any) |                  | access_key_id,                 |                                |
|               |       |                  | aws_access_key_id,             |                                |
|               |       |                  | aws_secret_key, bucket,        |                                |
|               |       |                  | endpoint, region, secret_key   |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| service-port  | (any) | port, workload   | hostname, port                 |                                |
+---------------+-------+------------------+--------------------------------+--------------------------------+
| volume        | (any) |                  | source, type                   | The default volume provisioner |
|               |       |                  |                                | creates a volume resource that |
|               |       |                  |                                | can be used by other resources |
|               |       |                  |                                | in the project. This volume is |
|               |       |                  |                                | ephemeral and will be deleted  |
|               |       |                  |                                | when the project is removed.   |
|               |       |                  |                                | The volume is created with     |
|               |       |                  |                                | a random name and a label      |
|               |       |                  |                                | that can be used to track the  |
|               |       |                  |                                | volume back to the resource    |
|               |       |                  |                                | that created it.               |
+---------------+-------+------------------+--------------------------------+--------------------------------+

[lekaf974]

Json output

[
  {
    "Type": "service-port",
    "Class": "(any)",
    "Params": [
      "port",
      "workload"
    ],
    "Outputs": [
      "hostname",
      "port"
    ],
    "Description": "This expects a workload and port name and will return the hostname and port required to contact it"
  },
  {
    "Type": "volume",
    "Class": "(any)",
    "Params": [],
    "Outputs": [
      "source",
      "type"
    ],
    "Description": "Creates a volume resource that can be used by other resources in the project\n"
  }
]