Skip to content
This repository has been archived by the owner on Mar 16, 2024. It is now read-only.

adding "class" to volume docs #487

Merged
merged 1 commit into from Aug 9, 2022
Merged

Conversation

clemenko
Copy link
Contributor

@clemenko clemenko commented Aug 8, 2022

adding a doc section for storage classes in the volume reference.

Signed-off-by: Andy Clemenko clemenko@users.noreply.github.com

adding a doc section for storage classes in the volume reference.

Signed-off-by: Andy Clemenko <clemenko@users.noreply.github.com>
@ibuildthecloud
Copy link
Member

This currently isn't documented because we were going to remove it from the Acornfile. Let me know if you disagree. The reason is that "class" is a deployment specific parameter and by putting it in the acorn it will tie your application to a specific infrastructure implementation.

Instead of putting the class in the Acornfile you can specify it during the run by doing acorn run -v "data,class=longhorn" my-acorn. More info here: https://docs.acorn.io/running/volumes

@clemenko
Copy link
Contributor Author

clemenko commented Aug 8, 2022

This makes it problematic for sharing and documenting. The less in the command line the better. I know it is similar to how docker does things. But I would rather document in the Acornfile rather than adding a "how to run" section for the app.

I guess you could add notes to the Acornfile on how to run. OH, Will labels be added to the Acornfile? aka dockerfile labels?

@cjellick cjellick added the kind/documentation Improvements or additions to documentation label Aug 9, 2022
@cjellick cjellick added this to the v0.2.0 milestone Aug 9, 2022
@cjellick
Copy link
Member

cjellick commented Aug 9, 2022

Adding this to our project planning to make sure we come to a conclusion on it and it doesnt just sit

@ibuildthecloud
Copy link
Member

@clemenko I'm might revert my position on this. I'm thinking a lot :) Definitely don't want you to have do document how to run your app with big long CLI args.

@clemenko
Copy link
Contributor Author

clemenko commented Aug 9, 2022

Cool. To me, having as much in the acornfile is better due to the infra as code approach now a days. aka keep acorn run -f Acornfile as clean as possible.

@ibuildthecloud
Copy link
Member

ibuildthecloud commented Aug 9, 2022

Okay, changed my mind :) Thanks for the docs and making me think about this more. I'll merge once all the CI is green.

@clemenko
Copy link
Contributor Author

clemenko commented Aug 9, 2022

huzzah!

@ibuildthecloud ibuildthecloud merged commit 8d04fca into acorn-io:main Aug 9, 2022
@cjellick cjellick removed this from the v0.2.0 milestone Aug 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants