Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8,497 changes: 8,497 additions & 0 deletions docs/modules/spec/attachments/api-reference/2.0.0/index.html

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions docs/modules/spec/attachments/api-reference/2.0.0/main.css

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4,650 changes: 4,650 additions & 0 deletions docs/modules/spec/attachments/api-reference/next/index.html

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions docs/modules/spec/attachments/api-reference/next/main.css

Large diffs are not rendered by default.

Large diffs are not rendered by default.

8,497 changes: 8,497 additions & 0 deletions docs/modules/spec/attachments/api-reference/stable/index.html

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions docs/modules/spec/attachments/api-reference/stable/main.css

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/modules/spec/examples/api-reference/2.0.0/body.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

<a href="_attachments/jsonschemas/2.0.0/devfile.json">Download current the JSON Schema</a>
<iframe src="../_attachments/api-reference/2.0.0/index.html" style="border:none;width: 100%;min-height:50em;height:-webkit-fill-available;"></iframe>

4 changes: 4 additions & 0 deletions docs/modules/spec/examples/api-reference/next/body.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

<a href="_attachments/jsonschemas/next/devfile.json">Download current the JSON Schema</a>
<iframe src="../_attachments/api-reference/next/index.html" style="border:none;width: 100%;min-height:50em;height:-webkit-fill-available;"></iframe>

4 changes: 4 additions & 0 deletions docs/modules/spec/examples/api-reference/stable/body.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

<a href="_attachments/jsonschemas/stable/devfile.json">Download current the JSON Schema</a>
<iframe src="../_attachments/api-reference/stable/index.html" style="border:none;width: 100%;min-height:50em;height:-webkit-fill-available;"></iframe>

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:description: Refering to a parent devfile in a devfile
:navtitle: Refering to a parent
:keywords: authoring, stack, refering, parent
:page-aliases:

include::partial$proc_referring-to-a-parent-devfile-in-a-devfile.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -1411,6 +1411,7 @@
}
},
"registryUrl": {
"description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `regsitryURL` when `Id` is used.",
"type": "string"
},
"starterProjects": {
Expand Down Expand Up @@ -1532,7 +1533,7 @@
}
},
"uri": {
"description": "Uri of a Devfile yaml file",
"description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.",
"type": "string"
},
"variables": {
Expand Down
1 change: 1 addition & 0 deletions docs/modules/user-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
* xref:index.adoc[]
* xref:devfile-properties.adoc[]

* xref:authoring-stacks.adoc[]
** xref:adding-schema-version-to-a-devfile.adoc[]
Expand Down
6 changes: 6 additions & 0 deletions docs/modules/user-guide/pages/devfile-properties.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:description: Devfile Properties
:navtitle: devfile-properties
:keywords: devfile
// :page-aliases:

include::partial$proc_devfile-properties.adoc[]
258 changes: 258 additions & 0 deletions docs/modules/user-guide/partials/proc_devfile-properties.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
[id="proc_devfile-properties_{context}"]
= Devfile properties

[role="_abstract"]
This page quickly introduces you to devfile properties. The code snippets help you get started developing your own devfile projects. The tables show you what the different devfile properties require if you use these properties. See the following table of contents to go to the devfile property you want to work with:

== SchemaVersion

[source,yaml]
----
v2.0
---
schemaVersion: 2.0.0
----

[cols="1,1"]
|===
|Key
|schemaVersion

|Type
|string

|Required
|yes

|Description
|v2.0.0 of the schema
|===

For more information on the schemaVersion in devfiles, see: xref:migrating-schema-version.adoc[].

== Metadata

[source,yaml]
----
v2.0
---
metadata:
name: devfile-sample
version: 2.0.0
----

[cols="1,1"]
|===
|Key
|metadataObject

|Type
|metadataObject

|Required
|no

|Description
|metadata to be used
|===

For more information on the metadata in devfiles, see: xref:adding-projects-to-a-devfile.adoc[].

== StarterProjects

[source,yaml]
----
v2.0
---
starterProjects:
- name: quarkus-quickstart
description: minimal CRUD app with quarkus
subDir: /getting-started/
git:
location: https://github.com/quarkusio/quarkus-quickstarts
branch: master
startPoint: 1.7.0.Final
----

[cols="1,1"]
|===
|Key
|starterProjectObject

|Type
|starterProjectObject

|Required
|no

|Description
|list of starter projects to be used
|===

This starterProject example uses a Quarkus framework. For more information on the starterProjects in devfiles, see: xref:migrating-projects.adoc[].

== Components

[source,yaml]
----
v2.0
---
components:
- name: appsodyrun
container:
image: 'ajymau/java-openliberty-dev:latest'
memoryLimit: 1512Mi
mountSources: true
endpoints:
- name: 9080/tcp
exposure: public
public: true
protocol: http
targetPort: 9080
env:
- name: MODE2
value: TEST2
- name: myprop2
value: myval2
volumeMounts:
- name: myvol
path: /home/user/myvolpath
- name: myvol
volume:
size: 3Gi
----

[cols="1,1"]
|===
|Key
|componentObject

|Type
|componentObject

|Required
|no

|Description
|list of components to be used
|===

This component example uses an Open Liberty container, For more information on the components in devfiles, see: xref:migrating-components.adoc[].

== Commands

[source,yaml]
----
v2.0
---
commands:
- id: install
exec:
component: runtime
commandLine: npm install
workingDir: ${PROJECTS_ROOT}
group:
kind: build
isDefault: false
- id: mkdir
exec:
component: runtime
commandLine: mkdir /projects/testfolder
workingDir: ${PROJECTS_ROOT}
- id: run
exec:
component: runtime
commandLine: npm start
workingDir: ${PROJECTS_ROOT}
group:
kind: run
isDefault: true
- id: buildAndMkdir
composite:
label: Build and Mkdir
commands:
- mkdir
- install
parallel: false
group:
kind: build
isDefault: true
----

[cols="1,1"]
|===
|Key
|commandObject

|Type
|commandObject

|Required
|no

|Description
|command to be executed in an existing component container
|===

This commands example uses an Open Liberty container. For more information on the commands in devfiles, see: xref:migrating-commands.adoc[].

== Events

[source,yaml]
----
v2.0
---
commands:
- id: copy
exec:
commandLine: "cp /tools/myfile.txt tools.txt"
component: tools
workingDir: /
- id: initCache
exec:
commandLine: "./init_cache.sh"
component: tools
workingDir: /
- id: connectDB
exec:
commandLine: "./connect_db.sh"
component: runtime
workingDir: /
- id: disconnectDB
exec:
commandLine: "./disconnect_db.sh"
component: runtime
workingDir: /
- id: cleanup
exec:
commandLine: "./cleanup.sh"
component: tools
workingDir: /
events:
preStart:
- "connectDB"
postStart:
- "copy"
- "initCache"
preStop:
- "disconnectDB"
postStop:
- "cleanup"
----

[cols="1,1"]
|===
|Key
|eventObject

|Type
|eventObject

|Required
|no

|Description
|events to be executed during a project lifecycle
|===

This events example uses an Open Liberty container. For more information on the events in devfiles, see: xref:adding-event-bindings.adoc[].