Container file source and contents properties revised - Githubissues

score-spec / score-go

Reference library for parsing and loading Score files

Apache License 2.0

26 stars 6 forks source link

Container file source and contents properties revised #16

Closed ghen closed 1 year ago

ghen commented 1 year ago

Revised support for container files contents definitions:

source property defines the path to a file. Can't be used with content property at the same time.
content property is now a string. Array of strings can still be used, but marked as deprecated.
noExpand property if set to true, the placeholder expansion will not occur in the content or the file.

Score file example with the source file reference:

apiVersion: score.dev/v1b1
metadata:
  name: example
service:
  containers:
    my-container:
      image: busybox:latest
      files:
      - target: /my-dir/my-file
        mode: "0664"
        source: ./files/my-file
resources:
  env:
    type: environment

Score file example with inline string content and noExpand:

apiVersion: score.dev/v1b1
metadata:
  name: example
service:
  containers:
    my-container:
      image: busybox:latest
      files:
      - target: /my-dir/my-file
        mode: "0664"
        content: |
          line one VALUE_OF_MY_VAR
          line two  ${do.not.expand}
        noExpand: true
resources:
  env:
    type: environment

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] New chore (expected functionality to be implemented)

Checklist:

[x] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
[x] I've signed off with an email address that matches the commit author.