Skip to content

Commit 11f90ad

Browse files
committed
Update to 2.2.0, add deploy kind, add event to nav
Signed-off-by: Maysun J Faisal <[email protected]>
1 parent 8d43490 commit 11f90ad

17 files changed

+78
-24
lines changed

docs/modules/user-guide/partials/assembly_authoring-devfiles.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ endif::[]
1414
[role="_abstract"]
1515
A devfile is a `yaml` file. After you include it in your local environment, the devfile provides ways to automate your processes. Tools like `odo` run the devfile and apply its guidelines to your environment. You can configure the devfile based on your unique development needs. See the following documents to help you author a devfile based on your development needs:
1616

17-
* xref:adding-schema-version-to-a-devfile.adoc[]
18-
* xref:adding-a-name-to-a-devfile.adoc[]
1917
* xref:adding-schema-version-to-a-devfile.adoc[]
2018
* xref:adding-a-name-to-a-devfile.adoc[]
2119
* xref:adding-projects-to-a-devfile.adoc[]
2220
* xref:adding-commands-to-a-devfile.adoc[]
2321
* xref:adding-components-to-a-devfile.adoc[]
2422
* xref:adding-attributes-to-a-devfile.adoc[]
23+
* xref:adding-event-bindings.adoc[]
2524
* xref:referring-to-a-parent-devfile-in-a-devfile.adoc[]
2625
2726
// [role="_additional-resources"]

docs/modules/user-guide/partials/proc_adding-a-command-group-to-a-devfile.adoc

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Create command groups to help automate your devfile.
1919
* `run`
2020
* `test`
2121
* `debug`
22+
* `deploy`
2223
+
2324
. At most, there can only be one default command for each group kind. Set the default command by specifying a `true` value for `isDefault`.
2425
+
@@ -54,3 +55,46 @@ commands:
5455
kind: build
5556
isDefault: true
5657
----
58+
+
59+
. Use the `deploy` kind to reference a deploy command for an outerloop scenario.
60+
+
61+
[source,yaml]
62+
----
63+
schemaVersion: 2.2.0
64+
metadata:
65+
name: python
66+
version: 1.0.0
67+
provider: Red Hat
68+
supportUrl: https://github.com/devfile-samples/devfile-support#support-information
69+
attributes:
70+
alpha.dockerimage-port: 8081
71+
parent:
72+
id: python
73+
registryUrl: "https://registry.devfile.io"
74+
components:
75+
- name: outerloop-build
76+
image:
77+
imageName: python-image:latest
78+
dockerfile:
79+
uri: docker/Dockerfile
80+
buildContext: .
81+
rootRequired: false
82+
- name: outerloop-deploy
83+
kubernetes:
84+
uri: outerloop-deploy.yaml
85+
commands:
86+
- id: build-image
87+
apply:
88+
component: outerloop-build
89+
- id: deployk8s
90+
apply:
91+
component: outerloop-deploy
92+
- id: deploy
93+
composite:
94+
commands:
95+
- build-image
96+
- deployk8s
97+
group:
98+
kind: deploy
99+
isDefault: true
100+
----

docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ A devfile can contain one or more components of the `container` type. The `compo
4646
.A minimal `container` component
4747
[source,yaml]
4848
----
49-
schemaVersion: 2.1.0
49+
schemaVersion: 2.2.0
5050
metadata:
5151
name: mydevfile
5252
components:
@@ -67,7 +67,7 @@ For the `container` component to have access to the project sources, you must se
6767
+
6868
[source,yaml]
6969
----
70-
schemaVersion: 2.1.0
70+
schemaVersion: 2.2.0
7171
metadata:
7272
name: mydevfile
7373
components:

docs/modules/user-guide/partials/proc_adding-a-name-to-a-devfile.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Adding a name to a devfile is mandatory. Use the `name` attribute to define the
3131

3232
[source,yaml]
3333
----
34-
schemaVersion: 2.1.0
34+
schemaVersion: 2.2.0
3535
metadata:
3636
name: devfile-sample
3737
version: 2.0.0

docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can use a `volume` component to share files among container components and c
1818

1919
[source,yaml]
2020
----
21-
schemaVersion: 2.1.0
21+
schemaVersion: 2.2.0
2222
metadata:
2323
name: mydevfile
2424
components:
@@ -33,7 +33,7 @@ components:
3333

3434
[source,yaml]
3535
----
36-
schemaVersion: 2.1.0
36+
schemaVersion: 2.2.0
3737
metadata:
3838
name: mydevfile
3939
components:

docs/modules/user-guide/partials/proc_adding-apply-commands-to-a-devfile.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ Use the the `apply` command to apply a given component definition, usually a `ku
88
+
99
[source,yaml]
1010
----
11+
schemaVersion: 2.2.0
12+
metadata:
13+
name: python
14+
version: 1.0.0
15+
provider: Red Hat
16+
supportUrl: https://github.com/devfile-samples/devfile-support#support-information
17+
attributes:
18+
alpha.dockerimage-port: 8081
19+
parent:
20+
id: python
21+
registryUrl: "https://registry.devfile.io"
1122
components:
1223
- name: outerloop-build
1324
image:

docs/modules/user-guide/partials/proc_adding-attributes-to-a-devfile.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ When no editor is specified, a default editor is provided. To represent this use
2727
====
2828
[source,yaml]
2929
----
30-
schemaVersion: 2.1.0
30+
schemaVersion: 2.2.0
3131
metadata:
3232
name: petclinic-dev-environment
3333
attributes:

docs/modules/user-guide/partials/proc_adding-composite-commands-to-a-devfile.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Connect multiple commands together by defining a composite command.
1818
+
1919
[source,yaml]
2020
----
21-
schemaVersion: 2.1.0
21+
schemaVersion: 2.2.0
2222
metadata:
2323
name: mydevfile
2424
projects:

docs/modules/user-guide/partials/proc_adding-exec-commands-to-a-devfile.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Use the the `exec` command to automate the container actions.
1111
+
1212
[source,yaml]
1313
----
14-
schemaVersion: 2.1.0
14+
schemaVersion: 2.2.0
1515
metadata:
1616
name: mydevfile
1717
projects:

docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This section describes how to add one or more projects to a devfile. Each starte
6868
====
6969
[source,yaml]
7070
----
71-
schemaVersion: 2.1.0
71+
schemaVersion: 2.2.0
7272
metadata:
7373
name: petclinic-dev-environment
7474
version: 1.0.0
@@ -86,7 +86,7 @@ projects:
8686
====
8787
[source,yaml]
8888
----
89-
schemaVersion: 2.1.0
89+
schemaVersion: 2.2.0
9090
metadata:
9191
name: example-devfile
9292
version: 1.0.0
@@ -143,7 +143,7 @@ source:
143143
====
144144
[source,yaml]
145145
----
146-
schemaVersion: 2.1.0
146+
schemaVersion: 2.2.0
147147
metadata:
148148
name: my-project-dev
149149
version: 2.0.0

docs/modules/user-guide/partials/proc_adding-schema-version-to-a-devfile.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The `schemaVersion` attribute is mandatory in a devfile. See the following table
2424
----
2525
v2.1
2626
---
27-
schemaVersion: 2.1.0
27+
schemaVersion: 2.2.0
2828
metadata:
2929
name: devfile-sample
3030
version: 2.1.0

docs/modules/user-guide/partials/proc_defining-endpoints.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This section describes how to define endpoints and specify their properties.
1212
====
1313
[source,yaml]
1414
----
15-
schemaVersion: 2.1.0
15+
schemaVersion: 2.2.0
1616
metadata:
1717
name: mydevfile
1818
projects:
@@ -71,7 +71,7 @@ WARNING: Listening on any other interface than the local loopback poses a securi
7171

7272
[source,yaml]
7373
----
74-
schemaVersion: 2.1.0
74+
schemaVersion: 2.2.0
7575
metadata:
7676
name: mydevfile
7777
components:

docs/modules/user-guide/partials/proc_defining-environment-variables.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Environment variables are supported by the `container` component and the `exec`
1212
====
1313
[source,yaml]
1414
----
15-
schemaVersion: 2.1.0
15+
schemaVersion: 2.2.0
1616
metadata:
1717
name: mydevfile
1818
components:

docs/modules/user-guide/partials/proc_defining-kubernetes-resources.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following component references a file that is relative to the location of th
3030

3131
[source,yaml]
3232
----
33-
schemaVersion: 2.1.0
33+
schemaVersion: 2.2.0
3434
metadata:
3535
name: mydevfile
3636
projects:

docs/modules/user-guide/partials/proc_migrating-schema-version.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This section describes how to migrate the existing schema version to a v2.x devf
66

77
.Procedure
88

9-
. To migrate a schema version from a v1.x devfile to a v2.x devfile, replace `apiVersion: 1.0.0` with `schemaVersion: 2.1.0`:
9+
. To migrate a schema version from a v1.x devfile to a v2.x devfile, replace `apiVersion: 1.0.0` with `schemaVersion: 2.2.0`:
1010
+
1111
[cols="1a,1a"]
1212
|====
@@ -24,7 +24,7 @@ metadata:
2424
----
2525
v2.0
2626
---
27-
schemaVersion: 2.1.0
27+
schemaVersion: 2.2.0
2828
metadata:
2929
name: devfile-sample
3030
----

docs/modules/user-guide/partials/proc_referring-to-a-parent-devfile-in-a-devfile.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Using the `id` when published in a registry.
2525
2626
[source,yaml]
2727
----
28-
schemaVersion: 2.1.0
28+
schemaVersion: 2.2.0
2929
metadata:
3030
name: my-project-dev
3131
parent:
@@ -40,7 +40,7 @@ Using the URI when published on a static HTTP server, such as GitHub Gist or Pas
4040
4141
[source,yaml]
4242
----
43-
schemaVersion: 2.1.0
43+
schemaVersion: 2.2.0
4444
metadata:
4545
name: my-project-dev
4646
parent:
@@ -54,7 +54,7 @@ Using a Kubernetes resource name and namespace if it has been deployed on a Kube
5454
5555
[source,yaml]
5656
----
57-
schemaVersion: 2.1.0
57+
schemaVersion: 2.2.0
5858
metadata:
5959
name: my-project-dev
6060
parent:

docs/modules/user-guide/partials/proc_specifying-persistent-storage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Use a `container` component to specify the volumes to be mounted on specific loc
1212
====
1313
[source,yaml]
1414
----
15-
schemaVersion: 2.1.0
15+
schemaVersion: 2.2.0
1616
metadata:
1717
name: mydevfile
1818
components:

0 commit comments

Comments
 (0)