Skip to content
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

Reserved folder for storing stack specific resource files #457

Closed
elsony opened this issue May 10, 2021 · 3 comments
Closed

Reserved folder for storing stack specific resource files #457

elsony opened this issue May 10, 2021 · 3 comments
Labels
area/registry Devfile registry for stacks and infrastructure future Items in consideration to be added to future spec levels lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.

Comments

@elsony
Copy link
Contributor

elsony commented May 10, 2021

Background: #421

If a stack contains supporting resources that are required for the function of the stack, e.g. Dockerfiles in the future, the stack can store those supporting files as part of the devfile registry. However, there is currently no reserved location for storing those files. This means that when tools like odo when doing a component create, it may potentially overwrite user application files on a component create.

For example, if a stack contains a file docker/Dockerfiles under the stack folder in a registry, during odo create, it will clone the stack folder. If the user application already contains the same file, this clone may overwrite the user file. In order to avoid file collision between user application and files provided by the stack, we can resolve it by reserving a folder, e.g. .devfile or .stack, that allows a stack to store the stack supporting files.

The registry will look something like this:

stacks
     |- nodejs
     |       |- .devfiles
     |       |          |- docker
     |       |                  |- Dockerfile
     |       |
     ...

Note: If we have that, we can also consider putting the devfile.yaml under the .devfile by default.

@elsony elsony added the area/registry Devfile registry for stacks and infrastructure label May 10, 2021
@elsony
Copy link
Contributor Author

elsony commented May 11, 2021

  • Specify resource location to be fully qualified
  • Change parser to support .devfiles/devfile.yaml, devfile.yaml under project root will be the priority

@elsony elsony added this to the 2.2 milestone Jun 8, 2021
@elsony elsony removed this from the 2.2 milestone Apr 8, 2022
@elsony elsony added the future Items in consideration to be added to future spec levels label Apr 8, 2022
@elsony
Copy link
Contributor Author

elsony commented Apr 8, 2022

Community call discussion 3/28:

  1. Not needed as part of devfile 2.2
  2. Devfile library already loads devfiles from the .devfiles/devfile.yaml.

Copy link

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Jul 22, 2024
@github-actions github-actions bot added the lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. label Sep 21, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/registry Devfile registry for stacks and infrastructure future Items in consideration to be added to future spec levels lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days.
Projects
Status: Done ✅
Development

No branches or pull requests

1 participant