From daefcaff3498e91fc37451744a69187b0f39d84f Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Thu, 3 Feb 2022 11:19:11 -0500 Subject: [PATCH 01/13] added volume component and modified other components --- docs/modules/user-guide/nav.adoc | 5 +-- ...ng-a-container-component-to-a-devfile.adoc | 6 ++++ ...s-or-openshift-component-to-a-devfile.adoc | 6 ++++ ...dding-a-volume-component-to-a-devfile.adoc | 6 ++++ ...ding-container-component-to-a-devfile.adoc | 6 ---- ...ing-kubernetes-component-to-a-devfile.adoc | 6 ---- ...g-a-container-component-to-a-devfile.adoc} | 4 +-- ...-or-openshift-component-to-a-devfile.adoc} | 8 ++--- ...dding-a-volume-component-to-a-devfile.adoc | 34 +++++++++++++++++++ .../proc_adding-components-to-a-devfile.adoc | 7 ++-- 10 files changed, 65 insertions(+), 23 deletions(-) create mode 100644 docs/modules/user-guide/pages/adding-a-container-component-to-a-devfile.adoc create mode 100644 docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc create mode 100644 docs/modules/user-guide/pages/adding-a-volume-component-to-a-devfile.adoc delete mode 100644 docs/modules/user-guide/pages/adding-container-component-to-a-devfile.adoc delete mode 100644 docs/modules/user-guide/pages/adding-kubernetes-component-to-a-devfile.adoc rename docs/modules/user-guide/partials/{proc_adding-container-component-to-a-devfile.adoc => proc_adding-a-container-component-to-a-devfile.adoc} (96%) rename docs/modules/user-guide/partials/{proc_adding-kubernetes-component-to-a-devfile.adoc => proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc} (75%) create mode 100644 docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc diff --git a/docs/modules/user-guide/nav.adoc b/docs/modules/user-guide/nav.adoc index ba8d4d70..e6998fad 100644 --- a/docs/modules/user-guide/nav.adoc +++ b/docs/modules/user-guide/nav.adoc @@ -12,8 +12,9 @@ **** xref:adding-exec-commands-to-a-devfile.adoc[] **** xref:adding-composite-commands-to-a-devfile.adoc[] *** xref:adding-components-to-a-devfile.adoc[] -**** xref:adding-kubernetes-component-to-a-devfile.adoc[] -**** xref:adding-container-component-to-a-devfile.adoc[] +**** xref:adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc[] +**** xref:adding-a-container-component-to-a-devfile.adoc[] +**** xref:adding-a-volume-component-to-a-devfile.adoc[] **** xref:specifying-persistent-storage.adoc[] **** xref:limiting-resources-usage.adoc[] **** xref:defining-environment-variables.adoc[] diff --git a/docs/modules/user-guide/pages/adding-a-container-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-a-container-component-to-a-devfile.adoc new file mode 100644 index 00000000..d0779d35 --- /dev/null +++ b/docs/modules/user-guide/pages/adding-a-container-component-to-a-devfile.adoc @@ -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[] diff --git a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc new file mode 100644 index 00000000..c6728638 --- /dev/null +++ b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -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[] diff --git a/docs/modules/user-guide/pages/adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-a-volume-component-to-a-devfile.adoc new file mode 100644 index 00000000..d2612e3f --- /dev/null +++ b/docs/modules/user-guide/pages/adding-a-volume-component-to-a-devfile.adoc @@ -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[] diff --git a/docs/modules/user-guide/pages/adding-container-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-container-component-to-a-devfile.adoc deleted file mode 100644 index 883df733..00000000 --- a/docs/modules/user-guide/pages/adding-container-component-to-a-devfile.adoc +++ /dev/null @@ -1,6 +0,0 @@ -:description: Adding container component to a devfile -:navtitle: Adding container component -:keywords: authoring, stack, components -:page-aliases: - -include::partial$proc_adding-container-component-to-a-devfile.adoc[] diff --git a/docs/modules/user-guide/pages/adding-kubernetes-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-kubernetes-component-to-a-devfile.adoc deleted file mode 100644 index 82841be5..00000000 --- a/docs/modules/user-guide/pages/adding-kubernetes-component-to-a-devfile.adoc +++ /dev/null @@ -1,6 +0,0 @@ -:description: Adding kubernetes component to a devfile -:navtitle: Adding kubernetes component -:keywords: authoring, stack, components -:page-aliases: - -include::partial$proc_adding-kubernetes-component-to-a-devfile.adoc[] diff --git a/docs/modules/user-guide/partials/proc_adding-container-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc similarity index 96% rename from docs/modules/user-guide/partials/proc_adding-container-component-to-a-devfile.adoc rename to docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc index ba2e1868..c85d5ba1 100644 --- a/docs/modules/user-guide/partials/proc_adding-container-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ -[id="proc_adding-container-component-to-a-devfile_{context}"] -= Adding `container` components to a devfile +[id="proc_adding-a-container-component-to-a-devfile_{context}"] += Adding a `container` components to a devfile [role="_abstract"] To incorporate custom tools into the workspace, define an image-based configuration of a container in a workspace. Define this configuration by using the `container` component type. diff --git a/docs/modules/user-guide/partials/proc_adding-kubernetes-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc similarity index 75% rename from docs/modules/user-guide/partials/proc_adding-kubernetes-component-to-a-devfile.adoc rename to docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 35a27e7c..5351f45d 100644 --- a/docs/modules/user-guide/partials/proc_adding-kubernetes-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,8 +1,8 @@ -[id="proc_adding-kubernetes-component-to-a-devfile_{context}"] +[id="proc_adding-a-kubernetes-or-openshift-component-to-a-devfile_{context}"] = Adding a `kubernetes` or `openshift` component to a devfile [role="_abstract"] -This section describes how to add either a `kubernetes` or `openshfit` component to a devfile. You can apply configurations to your devfile with `kubernetes` or `openshift` components. +You can add either a `kubernetes` or `openshift` component to a devfile. Doing so enables you to configure your devfile to your unique development needs. .Prerequisites @@ -12,11 +12,11 @@ This section describes how to add either a `kubernetes` or `openshfit` component .Procedure -. Define a component using the type `kubernetes` or `openshift`. +. Define a component using the `kubernetes` or `openshift` type. . Provide the content through the `uri` or `inlined` property. + -.Adding `openshift` component using the `uri` property +.Adding an `openshift` component using the `uri` property ==== [source,yaml] ---- diff --git a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc new file mode 100644 index 00000000..78459660 --- /dev/null +++ b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc @@ -0,0 +1,34 @@ +[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 easily 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 + +* Define a `volume` component in your devfile. ++ +.A minimal `volume` component +[source,yaml] +---- +schemaVersion: 2.1.0 +metadata: + name: mydevfile +components: + - name: mydevfile + volume: + size: 2Gi +---- + + +[role="_additional-resources"] +.Additional resources + +* xref:api-reference.adoc[] +* xref:devfile-resources.adoc[] diff --git a/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc index aa1850c2..391eb7ef 100644 --- a/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc @@ -135,10 +135,11 @@ Each component in a single devfile must have a unique name and use one of the ob . For each component, define an unique value for the mandatory `name` attribute. -. For each component, define a mandatory type of one of the following types: `kubernetes`, `container` or `volume`. +. For each component, define a mandatory type of one of the following types: `kubernetes`, `container`, `openshift`, or `volume`. -. xref:adding-kubernetes-component-to-a-devfile.adoc[] -. xref:adding-container-component-to-a-devfile.adoc[] +. xref:adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc[] +. xref:adding-a-container-component-to-a-devfile.adoc[] +. xref:adding-a-volume-component-to-a-devfile.adoc[] . xref:specifying-persistent-storage.adoc[] . xref:limiting-resources-usage.adoc[] . xref:defining-environment-variables.adoc[] From f3661a060fe7cc503805a4f8d2ad889e8a5f4509 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Tue, 8 Feb 2022 11:17:38 -0500 Subject: [PATCH 02/13] applied dev feedback and added ephemeral volume component --- ...dding-a-volume-component-to-a-devfile.adoc | 23 ++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc index 78459660..6a3c9eb3 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc @@ -12,7 +12,7 @@ You can use a volume component to share files among container components and col .Procedure -* Define a `volume` component in your devfile. +. Define a `volume` component in your devfile and specify a volume size for it. + .A minimal `volume` component [source,yaml] @@ -26,6 +26,27 @@ components: size: 2Gi ---- +. Store an ephemeral `volume` component for it to be persistent across restarts. ++ +.An ephemeral `volume` component + +[source,yaml] +---- +schemaVersion: 2.1.0 +metadata: + name: mydevfile +components: + - name: mydevfile + volume: + ephemeral: true + size: 200G +---- + +[NOTE] +==== + * Implementing the size of the `volume` component is dependent on the tools you use, and therefore, might be subject to the limitations of the tools. + * For more details, refer to the documentation for your tools. +==== [role="_additional-resources"] .Additional resources From cdc86407e057aeb99325eaa68b7542202d6f4c18 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Tue, 8 Feb 2022 12:06:27 -0500 Subject: [PATCH 03/13] removed minimal component example and made other small changes --- ...ing-a-container-component-to-a-devfile.adoc | 2 +- ...adding-a-volume-component-to-a-devfile.adoc | 18 ++---------------- 2 files changed, 3 insertions(+), 17 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc index c85d5ba1..c8699032 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ [id="proc_adding-a-container-component-to-a-devfile_{context}"] -= Adding a `container` components to a devfile += Adding a `container` component to a devfile [role="_abstract"] To incorporate custom tools into the workspace, define an image-based configuration of a container in a workspace. Define this configuration by using the `container` component type. diff --git a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc index 6a3c9eb3..1416be0b 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc @@ -13,22 +13,9 @@ You can use a volume component to share files among container components and col .Procedure . Define a `volume` component in your devfile and specify a volume size for it. -+ -.A minimal `volume` component -[source,yaml] ----- -schemaVersion: 2.1.0 -metadata: - name: mydevfile -components: - - name: mydevfile - volume: - size: 2Gi ----- - . Store an ephemeral `volume` component for it to be persistent across restarts. + -.An ephemeral `volume` component +.Ephemeral `volume` example [source,yaml] ---- @@ -44,8 +31,7 @@ components: [NOTE] ==== - * Implementing the size of the `volume` component is dependent on the tools you use, and therefore, might be subject to the limitations of the tools. - * For more details, refer to the documentation for your tools. + Specifying the size of the `volume` component is dependent on the tools you use, and therefore, might be subject to the limitations of the tools. For more details, refer to the documentation for your tools. ==== [role="_additional-resources"] From 78307e61cf5cc4b1c8db52f3355ee5feb42b4948 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Fri, 11 Feb 2022 10:57:49 -0500 Subject: [PATCH 04/13] fine tuning of procedure steps and titles --- ...g-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 2 +- .../proc_adding-a-container-component-to-a-devfile.adoc | 2 +- ...g-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 4 ++-- .../proc_adding-a-volume-component-to-a-devfile.adoc | 7 +++---- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index c6728638..856f0df5 100644 --- a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ :description: Adding a kubernetes or openshift component to a devfile -:navtitle: Adding a kubernetes or openshift component +:navtitle: Adding a Kubernetes or Openshift component :keywords: authoring, stack, components :page-aliases: diff --git a/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc index c8699032..6fe65e7d 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ [id="proc_adding-a-container-component-to-a-devfile_{context}"] -= Adding a `container` component to a devfile += Adding a container component to a devfile [role="_abstract"] To incorporate custom tools into the workspace, define an image-based configuration of a container in a workspace. Define this configuration by using the `container` component type. diff --git a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 5351f45d..94680de4 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ [id="proc_adding-a-kubernetes-or-openshift-component-to-a-devfile_{context}"] -= Adding a `kubernetes` or `openshift` component to a devfile += Adding a Kubernetes or Openshift component to a devfile [role="_abstract"] You can add either a `kubernetes` or `openshift` component to a devfile. Doing so enables you to configure your devfile to your unique development needs. @@ -12,7 +12,7 @@ You can add either a `kubernetes` or `openshift` component to a devfile. Doing s .Procedure -. Define a component using the `kubernetes` or `openshift` type. +. Define a component using the `kubernetes` or `openshift` property. . Provide the content through the `uri` or `inlined` property. + diff --git a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc index 1416be0b..264845e6 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc @@ -2,7 +2,7 @@ = Adding a volume component to a devfile [role="_abstract"] -You can use a volume component to share files among container components and collaborate easily with other teams during the development process. +You can use a volume component to share files among container components and collaborate with other teams during the development process. .Prerequisites @@ -12,8 +12,7 @@ You can use a volume component to share files among container components and col .Procedure -. Define a `volume` component in your devfile and specify a volume size for it. -. Store an ephemeral `volume` component for it to be persistent across restarts. +* Store an ephemeral `volume` component for it to be persistent across restarts. + .Ephemeral `volume` example @@ -31,7 +30,7 @@ components: [NOTE] ==== - Specifying the size of the `volume` component is dependent on the tools you use, and therefore, might be subject to the limitations of the tools. For more details, refer to the documentation for your tools. + Specifying the size of a `volume` component is dependent on the tools you use and may be subject to the limitations of the tools. ==== [role="_additional-resources"] From 37ed1aca3fa12387fe35c8e5a76bc5de18e5b36a Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Fri, 11 Feb 2022 11:38:59 -0500 Subject: [PATCH 05/13] doc nitpicks with titling --- ...ding-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 4 ++-- ...ding-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 2 +- .../partials/proc_adding-a-volume-component-to-a-devfile.adoc | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 856f0df5..b2954bc8 100644 --- a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ -:description: Adding a kubernetes or openshift component to a devfile -:navtitle: Adding a Kubernetes or Openshift component +:description: Adding a Kubernetes or OpenShift component to a devfile +:navtitle: Adding a Kubernetes or OpenShift component :keywords: authoring, stack, components :page-aliases: diff --git a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 94680de4..5032b981 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ [id="proc_adding-a-kubernetes-or-openshift-component-to-a-devfile_{context}"] -= Adding a Kubernetes or Openshift component to a devfile += Adding a Kubernetes or OpenShift component to a devfile [role="_abstract"] You can add either a `kubernetes` or `openshift` component to a devfile. Doing so enables you to configure your devfile to your unique development needs. diff --git a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc index 264845e6..5552259f 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc @@ -2,7 +2,7 @@ = 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. +You can use a `volume` component to share files among container components and collaborate with other teams during the development process. .Prerequisites @@ -30,7 +30,7 @@ components: [NOTE] ==== - Specifying the size of a `volume` component is dependent on the tools you use and may be subject to the limitations of the tools. + Specifying the size of a `volume` component is dependent on the tools you use and may be subject to the limitations of the tools. ==== [role="_additional-resources"] From ae4f773ef90b7a68b4d489a8be62ed0f89e3b2b7 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 14 Feb 2022 14:09:47 -0500 Subject: [PATCH 06/13] Update docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 856f0df5..68a4b958 100644 --- a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,4 +1,4 @@ -:description: Adding a kubernetes or openshift component to a devfile +:description: Adding a Kubernetes or OpenShift component to a devfile :navtitle: Adding a Kubernetes or Openshift component :keywords: authoring, stack, components :page-aliases: From 72824ff582af848e49286b2fc0be001fcdcef097 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 14 Feb 2022 14:09:54 -0500 Subject: [PATCH 07/13] Update docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 68a4b958..b2954bc8 100644 --- a/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/pages/adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ :description: Adding a Kubernetes or OpenShift component to a devfile -:navtitle: Adding a Kubernetes or Openshift component +:navtitle: Adding a Kubernetes or OpenShift component :keywords: authoring, stack, components :page-aliases: From 69afb22906913330861584ed4c392fff59731087 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 14 Feb 2022 14:10:00 -0500 Subject: [PATCH 08/13] Update docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 94680de4..5032b981 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -1,5 +1,5 @@ [id="proc_adding-a-kubernetes-or-openshift-component-to-a-devfile_{context}"] -= Adding a Kubernetes or Openshift component to a devfile += Adding a Kubernetes or OpenShift component to a devfile [role="_abstract"] You can add either a `kubernetes` or `openshift` component to a devfile. Doing so enables you to configure your devfile to your unique development needs. From 37f29b9f9c678b6f41724c992f3a011331ee1e99 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 14 Feb 2022 14:10:06 -0500 Subject: [PATCH 09/13] Update docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc index 5032b981..2fea82f0 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc @@ -2,7 +2,7 @@ = Adding a Kubernetes or OpenShift component to a devfile [role="_abstract"] -You can add either a `kubernetes` or `openshift` component to a devfile. Doing so enables you to configure your devfile to your unique development needs. +You can add either a `kubernetes` or `openshift` component to a devfile. .Prerequisites From 93e13a0e1604356259ae1e18d9bcb39628cb572d Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 14 Feb 2022 14:10:13 -0500 Subject: [PATCH 10/13] Update docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- .../partials/proc_adding-components-to-a-devfile.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc index 391eb7ef..f1a4a943 100644 --- a/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc @@ -133,7 +133,7 @@ Each component in a single devfile must have a unique name and use one of the ob . Add a `components` section in the devfile, containing a list of one or more components. -. For each component, define an unique value for the mandatory `name` attribute. +. For each component, define a unique value for the mandatory `name` attribute. . For each component, define a mandatory type of one of the following types: `kubernetes`, `container`, `openshift`, or `volume`. From 83c913ff5ace94e323eacb49cce8e1771f087361 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 14 Feb 2022 14:10:21 -0500 Subject: [PATCH 11/13] Update docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- .../partials/proc_adding-components-to-a-devfile.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc index f1a4a943..9c0a9f63 100644 --- a/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc @@ -135,7 +135,7 @@ Each component in a single devfile must have a unique name and use one of the ob . For each component, define a unique value for the mandatory `name` attribute. -. For each component, define a mandatory type of one of the following types: `kubernetes`, `container`, `openshift`, or `volume`. +. For each component, define one of the following types for the mandatory `type` attribute: `kubernetes`, `container`, `openshift`, or `volume`. . xref:adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc[] . xref:adding-a-container-component-to-a-devfile.adoc[] From 4c4be438e8bc3076843481e807671e8b6b1e0319 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Mon, 14 Feb 2022 14:28:58 -0500 Subject: [PATCH 12/13] changed verb in procedure step --- .../partials/proc_adding-a-volume-component-to-a-devfile.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc index 5552259f..63cb9ff0 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc @@ -12,7 +12,7 @@ You can use a `volume` component to share files among container components and c .Procedure -* Store an ephemeral `volume` component for it to be persistent across restarts. +* Add an ephemeral `volume` component for it to be persistent across restarts. + .Ephemeral `volume` example From b78d8d39789db2ab4343fee863a04134c9a4d75c Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Tue, 15 Feb 2022 15:18:16 -0500 Subject: [PATCH 13/13] corrected ephemeral volume component --- ...dding-a-volume-component-to-a-devfile.adoc | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc index 63cb9ff0..c92fc592 100644 --- a/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc +++ b/docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc @@ -12,7 +12,22 @@ You can use a `volume` component to share files among container components and c .Procedure -* Add an ephemeral `volume` component for it to be persistent across restarts. +. 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 @@ -30,7 +45,7 @@ components: [NOTE] ==== - Specifying the size of a `volume` component is dependent on the tools you use and may be subject to the limitations of the tools. + 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"]