[feature request] Add a new score-compose provisioners list command

[mathieu-benoit]

Add a new score-compose provisioners list command generating in the output this table or a more advanced/detailed version with -o json: https://docs.score.dev/docs/score-implementation/score-compose/resources-provisioners/.

• It's not something in score-go as it's specific to each implementation.
• This should list the overriden provisioners imported via the score-compose init --provisioners command

[astromechza]

Can I rather recommend we use score-compose provisioners list instead and look at moving the --provisioners flag over to score-compose provisioners add in future?

[mathieu-benoit]

score-compose provisioners list is better, updating this ticket accordingly.

Fo score-compose provisioners add, good idea, but it will be another dedicated ticket.

[lekaf974]

@mathieu-benoit I could give it a try

[mathieu-benoit]

That would be awesome! If you have any questions while implementing this, please do let us know. There is a #score-dev channel in the CNCF Slack for this purpose.

[lekaf974]

Have a question related to array to display, currently after running score-compose init --provisioners <rprovisioners source> --project <project name> I am seeing the Z-xxx.xxxx.provisioners.yaml is created.
The array have 4 headers type, class, params, output

From this file I can easily extract type and output, I see that params will need a little more work but nothing reallay hard. Finally it is for the class header I am not sure where it is defined and I did not found any documentation that describe this field. Could you give me some guidance here ?

[mathieu-benoit]

Good question, it's not yet well documented for this part, I'll add a note to this one score-spec/docs#121 to make sure we'll document this properly.

In the meantime, here is the tl,dr about class:

• The default class if ommited in the provisioner is default.
• You can have multiple provisioners with the same type if their class is different. Example: dns with class: internal or class: public, etc. Example here with dapr-state-store: https://github.com/score-spec/community-provisioners/blob/main/score-compose/00-redis-dapr-state-store.provisioners.yaml#L3C3-L3C15.
• class can be used like illustrated below in the Score file, good way for the PEs to expose well supported golden paths and for the Devs to provide more context around their request: "I want a public DNS".
• All the default provisioners coming with score-compose init don't have a class defined, meaning default: https://docs.score.dev/docs/score-implementation/score-compose/resources-provisioners/
• You can also query the list of resources once score-compose generate has been executed, like this: score-compose resources get-outputs dns.default#my-workload.dns (default being the class).

apiVersion: score.dev/v1b1
metadata:
  name: my-workload
containers:
  my-container:
    image: .
resources:
  dns:
    type: dns
    class: public # optional, default if omitted
  route:
    type: route
    params:
      host: ${resources.dns.host}
      path: /
      port: 8080
service:
  ports:
    tcp:
      port: 8080
      targetPort: 8080

Hope this helps for more context?

[lekaf974]

Think I got it so basically if the field class is not specified I can assume it is default ?

[astromechza]

@lekaf974 @mathieu-benoit actually a small clarrification!

If the provisioner doesn't specify a class, it will match ALL classes. Same with the id parameter.

So a provisioner for type: postgres, class: "", will still be able to provision a resource with type: postgres, class: advanced.

[astromechza]

See https://github.com/score-spec/score-compose/blob/main/internal/provisioners/templateprov/template.go#L100.

[mathieu-benoit]

If the provisioner doesn't specify a class, it will match ALL classes.

Thanks for the clarification, @astromechza. But just to make sure about that:

Think I got it so basically if the field class is not specified I can assume it is default ?

So score-compose provisioners list will display default if no class has been provided in the provisioner, right?

[lekaf974]

Thanks you for feedback to you.

Having a look deeper in the code, did not found existing code that I can reuse or I missed something @astromechza could you give an advice ?

My first idea is to loop on all Z-xx.xxx.providers.yaml files in .score-compose does it make sense ?

[mathieu-benoit]

What about LoadProvisioners in there?
https://github.com/score-spec/score-compose/blob/main/internal/provisioners/loader/load.go

Used here as an example: https://github.com/score-spec/score-compose/blob/main/internal/command/generate.go#L216

[lekaf974]

What about LoadProvisioners in there? https://github.com/score-spec/score-compose/blob/main/internal/provisioners/loader/load.go

Used here as an example: https://github.com/score-spec/score-compose/blob/main/internal/command/generate.go#L216

Tried this way but it returns this interface which does not expose the required information

score-compose/internal/provisioners/core.go

Line 100 in ab1f356

type Provisioner interface {

From what I have seen looks this struct contains the required data

score-compose/internal/provisioners/core.go

Line 38 in ab1f356

type Input struct {

but did not yet find how I can do it

[astromechza]

@lekaf974 modify the interface to expose the type, class, id as well.

@mathieu-benoit no the class should be displayed as "*" or "any" rather than "default" if it is blank or not specified.

[mathieu-benoit]

no the class should be displayed as "*" or "any" rather than "default" if it is blank or not specified.

Gotcha, makes sense with (any) like we have (none) for the params, updating the docs accordingly for consistency:

• class (any) by default for provisioners docs#153
• class (any) by default for provisioners community-provisioners#5

[lekaf974]

thanks will update interface