Skip to content

Commit

Permalink
fix: removed devfile registry (#2787)
Browse files Browse the repository at this point in the history
* removed devfile registry

* add devfile.io

* update

* remove devfile registry from diagrams
  • Loading branch information
deerskindoll committed Sep 9, 2024
1 parent 978290e commit 199c477
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 46 deletions.
2 changes: 1 addition & 1 deletion modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
**** xref:devworkspace-operator.adoc[]
**** xref:gateway.adoc[]
**** xref:dashboard.adoc[]
**** xref:devfile-registries.adoc[]
**** xref:che-server.adoc[]
**** xref:che-devfile-registry.adoc[]
**** xref:plugin-registry.adoc[]
*** xref:user-workspaces.adoc[]
** xref:calculating-che-resource-requirements.adoc[]
Expand Down
20 changes: 20 additions & 0 deletions modules/administration-guide/pages/che-devfile-registry.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
:_content-type: CONCEPT
:description: Devfile registry
:keywords: administration-guide, devfile
:navtitle: Devfile registry
:page-aliases:

[id="devfile-registry"]
= Devfile registry

A devfile registry is a service providing a list of sample devfiles.
You can use these samples to create ready-to-use workspaces.

For {prod}, use the devfile registry available link:https://registry.devfile.io/viewer[here].

.Additional resources

* link:https://devfile.io/docs/2.2.2/what-is-a-devfile[What is a devfile]
* link:https://devfile.io/docs/2.2.0/benefits-of-devfile[Benefits of devfile]
* link:https://devfile.io/docs/2.2.2/overview[Devfile customization overview]
* link:https://devfile.io/[Devfile.io]
1 change: 0 additions & 1 deletion modules/administration-guide/pages/che-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ On a cluster with the {prod-short} operator, it is possible to create a `CheClus
* xref:devworkspace-operator.adoc[]
* xref:gateway.adoc[]
* xref:dashboard.adoc[]
* xref:devfile-registries.adoc[]
* xref:che-server.adoc[]
* xref:plugin-registry.adoc[]

Expand Down
2 changes: 0 additions & 2 deletions modules/administration-guide/pages/dashboard.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ The {prod-short} deployment starts it in the `{prod-deployment}-dashboard` Deplo

It needs access to:

* xref:devfile-registries.adoc[]
* xref:che-server.adoc[]
* xref:plugin-registry.adoc[]
* {orch-name} API
Expand All @@ -24,7 +23,6 @@ image::architecture/{project-context}-dashboard-interactions.png[User dashboard

When the user requests the user dashboard to start a workspace, the user dashboard executes this sequence of actions:

. Collects the devfile from the xref:devfile-registries.adoc[], when the user is creating a workspace from a code sample.
. Sends the repository URL to xref:che-server.adoc[] and expects a devfile in return, when the user is creating a workspace from a remote devfile.
. Reads the devfile describing the workspace.
. Collects the additional metadata from the xref:plugin-registry.adoc[].
Expand Down
23 changes: 0 additions & 23 deletions modules/administration-guide/pages/devfile-registries.adoc

This file was deleted.

1 change: 0 additions & 1 deletion modules/administration-guide/pages/gateway.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ The {prod-short} operator manages it as the `che-gateway` Deployment.
It controls access to:

* xref:dashboard.adoc[]
* xref:devfile-registries.adoc[]
* xref:che-server.adoc[]
* xref:plugin-registry.adoc[]
* xref:user-workspaces.adoc[]
Expand Down
2 changes: 0 additions & 2 deletions modules/administration-guide/pages/server-components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ image::architecture/{project-context}-deployments-interacting-with-devworkspace.
.Additional resources

* xref:che-operator.adoc[]
* xref:devworkspace-operator.adoc[]
* xref:gateway.adoc[]
* xref:dashboard.adoc[]
* xref:devfile-registries.adoc[]
* xref:che-server.adoc[]
* xref:plugin-registry.adoc[]
2 changes: 1 addition & 1 deletion modules/end-user-guide/pages/devfile-introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You do not need a devfile to start a workspace. If you do not include a devfile

.Devfile Registry

link:https://registry.devfile.io/viewer[{Devfile Registry] contains ready-to-use community-supported devfiles for different languages and technologies. Devfiles included in the registry should be treated as samples rather than templates.
link:https://registry.devfile.io/viewer[Devfile Registry] contains ready-to-use community-supported devfiles for different languages and technologies. Devfiles included in the registry should be treated as samples rather than templates.


.Additional resources
Expand Down
18 changes: 3 additions & 15 deletions tools/create_architecture_diagrams.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,13 @@ def architecture_diagrams(prod_short, project_context, orchestrator_name):
):
che_dashboard = Custom('User dashboard', icon_path=prod_icon)
che_gateway = Traefik('Gateway')
devfile_registries = SimpleStorageService('Devfile registries')
che_host = Custom(prod_short + ' server', icon_path=prod_icon)
git = Git('Git provider')
plugin_registry = SimpleStorageService('Plug-in registry')
kubernetes_api = APIServer(orchestrator_name + ' API')
user = User('User browser')
user >> che_gateway
che_gateway >> [che_dashboard, devfile_registries, che_host,
che_gateway >> [che_dashboard, che_host,
plugin_registry, kubernetes_api]
che_host >> [git]

Expand All @@ -76,26 +75,24 @@ def architecture_diagrams(prod_short, project_context, orchestrator_name):
user = User('User')
che_gateway = Traefik('Gateway')
che_dashboard = Custom('User dashboard', icon_path=prod_icon)
devfile_registries = SimpleStorageService('Devfile registry')
che_host = Custom(prod_short + ' server', icon_path=prod_icon)
plugin_registry = SimpleStorageService('Plug-in registry')
user_workspace = Compute('User workspaces')
user >> che_gateway >> [
che_dashboard, che_host, devfile_registries, plugin_registry, user_workspace]
che_dashboard, che_host, plugin_registry, user_workspace]

filename = file_path + 'dashboard-interactions'
with Diagram(filename=filename,
show=False,
direction="TB",
graph_attr=graph_attr):
che_dashboard = Custom('User dashboard', icon_path=prod_icon)
devfile_registry = SimpleStorageService('Devfile registries')
che_host = Custom(prod_short + ' server', icon_path=prod_icon)
plugin_registry = SimpleStorageService('Plug-in registry')
crd_workspace = APIServer(orchestrator_name + ' API')
che_dashboard >> che_host,
che_dashboard >> [
devfile_registry, plugin_registry]
plugin_registry]
che_dashboard >> crd_workspace

filename = file_path + 'server-interactions'
Expand All @@ -111,15 +108,6 @@ def architecture_diagrams(prod_short, project_context, orchestrator_name):
che_host >> [git_provider]
che_host >> crd_workspace

filename = file_path + 'devfile-registry-interactions'
with Diagram(filename=filename,
show=False,
direction="TB",
graph_attr=graph_attr):
che_dashboard = Custom('User dashboard', icon_path=prod_icon)
devfile_registry = SimpleStorageService('Devfile registries')
che_dashboard >> devfile_registry

filename = file_path + 'plugin-registry-interactions'
with Diagram(filename=filename,
show=False,
Expand Down

0 comments on commit 199c477

Please sign in to comment.