diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 178883f29f..bfe40e1bae 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -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[] diff --git a/modules/administration-guide/pages/che-devfile-registry.adoc b/modules/administration-guide/pages/che-devfile-registry.adoc new file mode 100644 index 0000000000..c9176db5f1 --- /dev/null +++ b/modules/administration-guide/pages/che-devfile-registry.adoc @@ -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] diff --git a/modules/administration-guide/pages/che-operator.adoc b/modules/administration-guide/pages/che-operator.adoc index 7085616cf6..f8ab47018e 100644 --- a/modules/administration-guide/pages/che-operator.adoc +++ b/modules/administration-guide/pages/che-operator.adoc @@ -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[] diff --git a/modules/administration-guide/pages/dashboard.adoc b/modules/administration-guide/pages/dashboard.adoc index 7e21612342..bc5fed5400 100644 --- a/modules/administration-guide/pages/dashboard.adoc +++ b/modules/administration-guide/pages/dashboard.adoc @@ -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 @@ -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[]. diff --git a/modules/administration-guide/pages/devfile-registries.adoc b/modules/administration-guide/pages/devfile-registries.adoc deleted file mode 100644 index 6381a5fba7..0000000000 --- a/modules/administration-guide/pages/devfile-registries.adoc +++ /dev/null @@ -1,23 +0,0 @@ -:_content-type: ASSEMBLY -:description: Devfile registries -:keywords: administration-guide, architecture, server, devworkspace, devfile, registry -:navtitle: Devfile registries -:page-aliases: - -[id="devfile-registries"] -= Devfile registries - -The {prod-short} devfile registries are services providing a list of sample devfiles to create ready-to-use workspaces. -The xref:dashboard.adoc[] displays the samples list on the *Dashboard* -> *Create Workspace* page. -Each sample includes a Devfile v2. -The {prod-short} deployment starts one devfile registry instance in the `devfile-registry` deployment. - -.Devfile registries interactions with other components -image::architecture/{project-context}-devfile-registry-interactions.png[] - -.Additional resources - -* link:https://devfile.io/docs/2.1.0/overview[Devfile v2 documentation] -* link:https://eclipse-che.github.io/che-devfile-registry/main/devfiles/[devfile registry latest community version online instance] - -include::example$snip_che-devfile-registry-additional-resources.adoc[] diff --git a/modules/administration-guide/pages/gateway.adoc b/modules/administration-guide/pages/gateway.adoc index 194ff7db2d..c357b00720 100644 --- a/modules/administration-guide/pages/gateway.adoc +++ b/modules/administration-guide/pages/gateway.adoc @@ -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[] diff --git a/modules/administration-guide/pages/server-components.adoc b/modules/administration-guide/pages/server-components.adoc index 82e7015e99..bc1109aed7 100644 --- a/modules/administration-guide/pages/server-components.adoc +++ b/modules/administration-guide/pages/server-components.adoc @@ -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[] diff --git a/modules/end-user-guide/pages/devfile-introduction.adoc b/modules/end-user-guide/pages/devfile-introduction.adoc index 07956a2be5..fb0f062728 100644 --- a/modules/end-user-guide/pages/devfile-introduction.adoc +++ b/modules/end-user-guide/pages/devfile-introduction.adoc @@ -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 diff --git a/tools/create_architecture_diagrams.py b/tools/create_architecture_diagrams.py index 3490f23780..51bde98184 100755 --- a/tools/create_architecture_diagrams.py +++ b/tools/create_architecture_diagrams.py @@ -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] @@ -76,12 +75,11 @@ 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, @@ -89,13 +87,12 @@ def architecture_diagrams(prod_short, project_context, orchestrator_name): 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' @@ -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,