8000 [feature request] `supported_params` and `expected_outputs` for `cmd` provisioners · Issue #279 · score-spec/score-compose · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[feature request] supported_params and expected_outputs for cmd provisioners #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lekaf974 opened this issue Mar 18, 2025 · 10 comments · Fixed by score-spec/community-provisioners#19
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lekaf974
Copy link
Contributor
lekaf974 commented Mar 18, 2025

Currently when we are doing

score-compose init --provisioners https://raw.githubusercontent.com/score-spec/community-provisioners/refs/heads/main/score-k8s/10-redis-helm-upgrade.provisioners.yaml

the score-compose provisioners list don't display outputs because it is not supported

+-------+-------+--------+---------+-------------+
| TYPE  | CLASS | PARAMS | OUTPUTS | DESCRIPTION |
+-------+-------+--------+---------+-------------+
| redis |       |        |         |             |
+-------+-------+--------+---------+-------------+

Leaving this one to anyone who would like to take the opportunity to tackle a good first issue and help wanted issue. The goal is to back port what was done in score-k8s there: score-spec/score-k8s#156, in this repo here.

@lekaf974 lekaf974 added the enhancement New feature or request label Mar 18, 2025
@lekaf974
Copy link
Contributor Author

@mathieu-benoit started to work on it

@lekaf974
Copy link
Contributor Author
lekaf974 commented Mar 18, 2025

@astromechza @mathieu-benoit need some insight here

I tested this locally based on main without any changes

start a init

go run cmd/score-compose/main.go init --provisioners https://raw.githubusercontent.com/score-spec/community-provisioners/refs/heads/main/score-compose/10-redis-dapr-pubsub.provisioners.yaml

then

go run cmd/score-compose/main.go provisioners list

+---------------+---------+------------------+--------------------------------+--------------------------------+
|     TYPE      |  CLASS  |      PARAMS      |            OUTPUTS             |          DESCRIPTION           |
+---------------+---------+------------------+--------------------------------+--------------------------------+
...
+---------------+---------+------------------+--------------------------------+--------------------------------+
| dapr-pubsub   | default |                  | name                           | Generates a Redis Service      |
|               |         |                  |                                | and a Dapr PubSub Component    |
|               |         |                  |                                | pointing to this Redis         |
|               |         |                  |                                | Service.                       |
+---------------+---------+------------------+--------------------------------+--------------------------------+
......

in the file shared in slack https://raw.githubusercontent.com/score-spec/community-provisioners/refs/heads/main/score-k8s/10-redis-helm-upgrade.provisioners.yaml there is only one row to help determine what are the expected outputs

OUTPUTS='{"resource_outputs":{"host":"%s-master", "port":"6379", "username":"", "password":"🔐💬%s_redis-password💬🔐"},"manifests":[]}'

what would be the best approach to have expected_outputs ?

@mathieu-benoit
Copy link
Contributor

Yup, exactly, what about adding the expected_outputs in the cmd like we have with the template, like this below?

- uri: template://...
  description: ...
  type: ....
  class: ...
  init:...
  state: ...
  outputs:...
  expected_outputs:...
- uri: cmd://...
  type:...
  args:...
  expected_outputs:...

@mathieu-benoit mathieu-benoit added contribfest Backlog of the ContribFest at KubeCon good first issue Good for newcomers help wanted Extra attention is needed labels Mar 29, 2025
@mathieu-benoit
Copy link
Contributor

Hey @lekaf974, have you started anything here? If not, I would love to see if someone during the ContribFest at KubeCon this week would be able to take this one. Do you mind? If nobody, I'll reassign to you after this week?

@lekaf974
Copy link
Contributor Author

Not yet, feel free to assigned to someone else. Busy on my end currently

@mathieu-benoit
Copy link
Contributor

Leaving this one to anyone who would like to take the opportunity to tackle a good first issue and help wanted issue. The goal is to back port what was done in score-k8s there: score-spec/score-k8s#156, in this repo here.

@mathieu-benoit mathieu-benoit changed the title [feature request] add expected_output in cmd provisioner [feature request] supported_params and expected_outputs for cmd provisioners Apr 17, 2025
@mathieu-benoit mathieu-benoit changed the title [feature request] supported_params and expected_outputs for cmd provisioners [feature request] supported_params and expected_outputs for cmd provisioners Apr 17, 2025
@mageshwaransekar
Copy link

Hi, I'd like to take up this issue

@mathieu-benoit
Copy link
Contributor

Sure thing, @mageshwaransekar, thanks for raising your hand on this one!

Please do let us know if you have any questions. This should provide you already great guidance:

The goal is to back port what was done in score-k8s there: score-spec/score-k8s#156, in this repo here.

@mathieu-benoit
Copy link
Contributor
mathieu-benoit commented May 31, 2025

Hi @mageshwaransekar, is there anything we can help you with to get started on this? Just making sure you have all the information needed ;)

Note: this will allow to support this https://github.com/score-spec/community-provisioners/blob/main/dns/score-compose/10-dns-in-codespace.provisioners.yaml#L13-L15.

@mageshwaransekar
Copy link

Hi @mathieu-benoit, I'll start working on it this week as I was busy last week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
0