[FEATURE] Shorthand way to define `files` and `volumes`

[mathieu-benoit]

Detailed description

Score is designed for developers to quickly and easily define what their workloads need to run. Following the principals of incrementally repealing complexity and focusing on developer experience, there are a number of properties that could have short hand versions.

This PR will focus on files and volumes.

A shorthand for:

files:
  /usr/local/conf/app:
    content: "Hello world"

Could be:

files:
  /usr/local/conf/app: "Hello world"

Same for volumes.

Context

This is part of the broader iniative to move at some point the Score spec from v1b1 to v1.

Possible implementation

• Update the files and volumes part of the spec to support this 3rd options for end users to define files and volumes
  • feat: add support for additional file and volume definitions in score schema #198
• In score-go use this open PR's branch to support this part there
• In score-compose use this open score-compose's PR's branch to support this part alongside still supporting the 2 other existing ways.
• Same as right above for score-k8s
• Once everything is validated and tested above, let's approve all the PR and do the release in cascade accordingly

Additional information

Take similar approach as what was done in the past with this exact same files and volumes part of the Spec: #123.

[mathieu-benoit]

Like discussed, @lekaf974 you want to work on this, right?

[lekaf974]

@mathieu-benoit yep

[chris-stephenson]

Please note that there is a little bit of complexity in that there is a legacy way of definitng files that was to put them in an array. This structure will be removed for the v1 release, but still needs to be supported for v1b1. Note that the legacy array version should not be changed to support the shorthand version.

[mathieu-benoit]

Please note that there is a little bit of complexity in that there is a legacy way of defining files that was to put them in an array. This structure will be removed for the v1 release, but still needs to be supported for v1b1. Note that the legacy array version should not be changed to support the shorthand version.

Yes exactly, the goal is to still support the 3 ways to define files (same story with volumes):

Option 1:

apiVersion: score.dev/v1b1
metadata:
  name: hello-world
containers:
  hello:
    image: .
    files:
      - target: /fileB.txt
        content: |
          I am ${metadata.name}
    volumes:
      - target: /data
        source: ${resources.data}
resources:
  data:
    type: volume

Option 2:

apiVersion: score.dev/v1b1
metadata:
  name: hello-world
containers:
  hello:
    image: .
    files:
      "/fileB.txt":
        content: |
          I am ${metadata.name}
    volumes:
      "/data":
        source: ${resources.data}
resources:
  data:
    type: volume

(New) Option 3:

apiVersion: score.dev/v1b1
metadata:
  name: hello-world
containers:
  hello:
    image: .
    files:
      "/fileB.txt": "I am ${metadata.name}"
    volumes:
      "/data": ${resources.data}
resources:
  data:
    type: volume

[lekaf974]

✋ Perfect I will keep in mind to keep existing behavior. I started to analyze this and have one question, do we want to keep this changes in v1b1 or it needs a v1b2 ?

[chris-stephenson]

This is a backwards compatible change so can stay in v1b1