-
Notifications
You must be signed in to change notification settings - Fork 31
Added devfile registry docs #73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
rkratky
merged 21 commits into
devfile:master
from
jc-berger:jcberger_191_devfileregistry
Jun 24, 2021
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
920e3c6
added devfile registry docs
6d138be
applied minor changes from SME review
cbd974c
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger ed135f8
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger 97db6e8
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger 7d9558a
addressed doc review
6f5b4d7
addressed doc review
002a434
removed HEAD message
a6449a1
minor grammatical and language changes
fb4ae8e
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger ca74b1b
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger 9556145
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger a5014b2
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger 631b767
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger 9ee1362
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger c62bdfc
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger 1b31579
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger ac30434
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger b5c2e31
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger 7346bbe
Update docs/modules/user-guide/partials/proc_devfile-registry.adoc
jc-berger a05c3a8
content tweaks and title changes
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
48
docs/modules/user-guide/partials/con_devfile-registry.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
jc-berger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| == 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[]. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.