Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
920e3c6
added devfile registry docs
Jun 2, 2021
6d138be
applied minor changes from SME review
Jun 7, 2021
cbd974c
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 7, 2021
ed135f8
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 7, 2021
97db6e8
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 7, 2021
7d9558a
addressed doc review
Jun 7, 2021
6f5b4d7
addressed doc review
Jun 7, 2021
002a434
removed HEAD message
Jun 7, 2021
a6449a1
minor grammatical and language changes
Jun 8, 2021
fb4ae8e
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 8, 2021
ca74b1b
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
9556145
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
a5014b2
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
631b767
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
9ee1362
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
c62bdfc
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
1b31579
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
ac30434
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
b5c2e31
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
7346bbe
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger Jun 21, 2021
a05c3a8
content tweaks and title changes
Jun 21, 2021
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
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-registry.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-registry.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:description: Devfile Registry
:navtitle: devfile-registry
:keywords: devfile
// :page-aliases:

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

[role="_abstract"]
A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che, and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry.

Each devfile stack corresponds to a specific runtime or framework, such as Node.js, Quarkus, or WildFly. A devfile stack also contains resources like a `devfile.yaml` file, logo, and outer loop resources. Outer loop runs on containers and entails code reviews and integration tests, typically automated by continuous integration/continuous delivery (CI/CD) pipelines. These devfile stacks provide developers with templates to get started developing cloud-native applications.

== Devfile registry components

A devfile registry has two components:

* Devfile index server
* OCI registry server

.Devfile index container

The devfile index container image does the following actions:

* Uses the `index.json` file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume.
* Bootstraps the OCI registry with the devfile stacks.
* Provides an API to interact with the OCI registry and to retrieve devfile stacks.

.OCI registry

The devfile stacks in a devfile registry are stored in an OCI-compatible artifact registry. The artifact registry is based on the reference implementation of an OCI registry.

When a devfile registry is deployed, the stacks belonging to the devfile registry are pushed to the OCI registry as multi-layer artifacts.

== Types of devfile registries

There are multiple types of devfile registries to access devfile stacks and tools.

.Public community registry

The public community registry provides stacks for various community tools to consume, such as Node.js, Quarkus, and Open Liberty.

Locate the source for the stacks in the public community registry in the link:https://github.com/devfile/registry[devfile/registry repository].

.On-cluster devfile registry

Devfile registries can be operated on private Kubernetes clusters, deployed using either the devfile registry Operator or the devfile registry Helm Chart.

The on-cluster devfile registries can be configured with custom devfile stacks suited to the needs of the owner organization.

== Additional resources

* xref:authoring-stacks.adoc[].