-
Notifications
You must be signed in to change notification settings - Fork 32
added volume component and modified other components #135
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
Merged
rkratky
merged 14 commits into
devfile:master
from
jc-berger:jcberger_devfilecomponents
Feb 24, 2022
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
daefcaf
added volume component and modified other components
f3661a0
applied dev feedback and added ephemeral volume component
cdc8640
removed minimal component example and made other small changes
78307e6
fine tuning of procedure steps and titles
37ed1ac
doc nitpicks with titling
ae4f773
Update docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift…
jc-berger 72824ff
Update docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift…
jc-berger 69afb22
Update docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-o…
jc-berger 37f29b9
Update docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-o…
jc-berger 93e13a0
Update docs/modules/user-guide/partials/proc_adding-components-to-a-d…
jc-berger 83c913f
Update docs/modules/user-guide/partials/proc_adding-components-to-a-d…
jc-berger f67359d
Merge remote-tracking branch 'origin/jcberger_devfilecomponents' into…
4c4be43
changed verb in procedure step
b78d8d3
corrected ephemeral volume component
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
docs/modules/user-guide/pages/adding-a-container-component-to-a-devfile.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
:description: Adding a container component to a devfile | ||
:navtitle: Adding a container component | ||
:keywords: authoring, stack, components | ||
:page-aliases: | ||
|
||
include::partial$proc_adding-a-container-component-to-a-devfile.adoc[] |
6 changes: 6 additions & 0 deletions
6
...s/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
:description: Adding a Kubernetes or OpenShift component to a devfile | ||
:navtitle: Adding a Kubernetes or OpenShift component | ||
:keywords: authoring, stack, components | ||
:page-aliases: | ||
|
||
include::partial$proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc[] |
6 changes: 6 additions & 0 deletions
6
docs/modules/user-guide/pages/adding-a-volume-component-to-a-devfile.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
:description: Adding a volume component to a devfile | ||
:navtitle: Adding a volume component | ||
:keywords: authoring, stack, components, volume | ||
|
||
|
||
include::partial$proc_adding-a-volume-component-to-a-devfile.adoc[] |
6 changes: 0 additions & 6 deletions
6
docs/modules/user-guide/pages/adding-container-component-to-a-devfile.adoc
This file was deleted.
Oops, something went wrong.
6 changes: 0 additions & 6 deletions
6
docs/modules/user-guide/pages/adding-kubernetes-component-to-a-devfile.adoc
This file was deleted.
Oops, something went wrong.
4 changes: 2 additions & 2 deletions
4
...ing-container-component-to-a-devfile.adoc → ...g-a-container-component-to-a-devfile.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
[id="proc_adding-a-volume-component-to-a-devfile_{context}"] | ||
= Adding a volume component to a devfile | ||
|
||
[role="_abstract"] | ||
You can use a `volume` component to share files among container components and collaborate with other teams during the development process. | ||
|
||
.Prerequisites | ||
|
||
* xref:adding-schema-version-to-a-devfile.adoc[] | ||
* xref:adding-a-name-to-a-devfile.adoc[] | ||
* xref:adding-components-to-a-devfile.adoc[] | ||
|
||
.Procedure | ||
|
||
. Add a `volume` component and specify the size of it. | ||
+ | ||
.Minimal `volume` example | ||
|
||
[source,yaml] | ||
---- | ||
schemaVersion: 2.1.0 | ||
metadata: | ||
name: mydevfile | ||
components: | ||
- name: mydevfile | ||
volume: | ||
size: 200G | ||
---- | ||
|
||
. If you do not want your `volume` component to persist across restarts, specify it as ephemeral. | ||
+ | ||
.Ephemeral `volume` example | ||
|
||
[source,yaml] | ||
---- | ||
schemaVersion: 2.1.0 | ||
metadata: | ||
name: mydevfile | ||
components: | ||
- name: mydevfile | ||
volume: | ||
ephemeral: true | ||
size: 200G | ||
---- | ||
|
||
[NOTE] | ||
==== | ||
Specifying the size of a `volume` component is dependent on the tools you use and might be subject to the limitations of the tools. | ||
==== | ||
|
||
[role="_additional-resources"] | ||
.Additional resources | ||
|
||
* xref:api-reference.adoc[] | ||
* xref:devfile-resources.adoc[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.