From 0a58c0e7e9e4b3fa3d7ac44b426c2d7808ae260e Mon Sep 17 00:00:00 2001 From: Jordan Dubrick Date: Thu, 29 Feb 2024 14:49:32 -0500 Subject: [PATCH 1/2] update readme links Signed-off-by: Jordan Dubrick --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cc25f4f0..a7fa9cbd 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,16 @@ Before you begin creating an application with this `devfile` code sample, it's helpful to understand the relationship between the `devfile` and `Dockerfile` and how they contribute to your build. You can find these files at the following URLs: -- [Spring Boot `devfile.yaml`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/main/devfile.yaml) -- [Spring Boot `Dockerfile`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/main/docker/Dockerfile) +- [Sample Spring Boot `devfile.yaml`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/devfile.yaml) +- [Sample Spring Boot `Dockerfile`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/docker/Dockerfile) +- [Parent Spring Boot `devfile.yaml`](https://github.com/devfile/registry/blob/main/stacks/java-springboot/2.1.0/devfile.yaml) -1. The `devfile.yaml` file has an [`image-build` component](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/main/devfile.yaml#L21-L27) that points to your `Dockerfile`. -2. The [`docker/Dockerfile`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/main/docker/Dockerfile) contains the instructions you need to build the code sample as a container image. -3. The `devfile.yaml` [`kubernetes-deploy` component](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/main/devfile.yaml#L28-L41) points to a `deploy.yaml` file that contains instructions for deploying the built container image. -4. The `devfile.yaml` [`deploy` command](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/main/devfile.yaml#L43-L56) completes the [outerloop](https://devfile.io/docs/2.2.0/innerloop-vs-outerloop) deployment phase by pointing to the `image-build` and `kubernetes-deploy` components to create your application. +This code sample has a parent devfile where it inherits most of the components and commands. The devfile contained in this repository is responsible for overwriting pieces of the parent devfile. + +1. The parent `devfile.yaml` file has a [`build` component](https://github.com/devfile/registry/blob/main/stacks/java-springboot/2.1.0/devfile.yaml#L41-L47) that points to your `Dockerfile`. +2. The [`docker/Dockerfile`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/docker/Dockerfile) contains the instructions you need to build the code sample as a container image. +3. The `devfile.yaml` [`deploy` component](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/devfile.yaml#L22-L34) overwrites the parent `deploy` and points to a `deploy.yaml` file that contains instructions for deploying the built container image. +4. The parent `devfile.yaml` [`deploy` command](https://github.com/devfile/registry/blob/main/stacks/java-springboot/2.1.0/devfile.yaml#L85-L92) completes the [outerloop](https://devfile.io/docs/2.2.0/innerloop-vs-outerloop) deployment phase by pointing to the `build` and `deploy` components to create your application. ### Additional resources From 861a08bfc260b045cbbeccd02318173fe03d3275 Mon Sep 17 00:00:00 2001 From: Jordan Dubrick Date: Thu, 29 Feb 2024 15:36:24 -0500 Subject: [PATCH 2/2] address review Signed-off-by: Jordan Dubrick --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a7fa9cbd..1c55fbb1 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ Before you begin creating an application with this `devfile` code sample, it's helpful to understand the relationship between the `devfile` and `Dockerfile` and how they contribute to your build. You can find these files at the following URLs: -- [Sample Spring Boot `devfile.yaml`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/devfile.yaml) -- [Sample Spring Boot `Dockerfile`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/docker/Dockerfile) -- [Parent Spring Boot `devfile.yaml`](https://github.com/devfile/registry/blob/main/stacks/java-springboot/2.1.0/devfile.yaml) +- [Spring Boot Sample `devfile.yaml`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/devfile.yaml) +- [Spring Boot Sample `Dockerfile`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/docker/Dockerfile) +- [Parent Spring Boot Stack `devfile.yaml`](https://github.com/devfile/registry/blob/main/stacks/java-springboot/2.1.0/devfile.yaml) -This code sample has a parent devfile where it inherits most of the components and commands. The devfile contained in this repository is responsible for overwriting pieces of the parent devfile. +This code sample inherits the components and commands of the specified parent devfile. The sample devfile overrides and extends parts of the parent devfile, in this case parts of the `deploy` component. 1. The parent `devfile.yaml` file has a [`build` component](https://github.com/devfile/registry/blob/main/stacks/java-springboot/2.1.0/devfile.yaml#L41-L47) that points to your `Dockerfile`. 2. The [`docker/Dockerfile`](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/docker/Dockerfile) contains the instructions you need to build the code sample as a container image. -3. The `devfile.yaml` [`deploy` component](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/devfile.yaml#L22-L34) overwrites the parent `deploy` and points to a `deploy.yaml` file that contains instructions for deploying the built container image. +3. The `devfile.yaml` [`deploy` component](https://github.com/devfile-samples/devfile-sample-java-springboot-basic/blob/v2.0.0/devfile.yaml#L22-L34) overrides the parent `deploy` and points to a `deploy.yaml` file that contains instructions for deploying the built container image. 4. The parent `devfile.yaml` [`deploy` command](https://github.com/devfile/registry/blob/main/stacks/java-springboot/2.1.0/devfile.yaml#L85-L92) completes the [outerloop](https://devfile.io/docs/2.2.0/innerloop-vs-outerloop) deployment phase by pointing to the `build` and `deploy` components to create your application. ### Additional resources