From 9126393ecb48611ee4dc4d3a7f9471ae087180e7 Mon Sep 17 00:00:00 2001 From: Pavol Baran Date: Wed, 24 Mar 2021 10:12:19 +0000 Subject: [PATCH 1/6] added documenting procedure Signed-off-by: Pavol Baran --- modules/end-user-guide/nav.adoc | 1 + .../using-private-container-registries.adoc | 7 ++++ .../partials/assembly_navigating-che.adoc | 2 + ...oc_using-private-container-registries.adoc | 37 +++++++++++++++++++ 4 files changed, 47 insertions(+) create mode 100644 modules/end-user-guide/pages/using-private-container-registries.adoc create mode 100644 modules/end-user-guide/partials/proc_using-private-container-registries.adoc diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index 2fdc5e9792..b78e582a53 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -3,6 +3,7 @@ * xref:navigating-che.adoc[] ** xref:navigating-che-using-the-dashboard.adoc[] ** xref:importing-certificates-to-browsers.adoc[] +** xref:using-private-container-registries.adoc[] ** xref:accessing-che-from-openshift-developer-perspective.adoc[] * xref:che-theia-ide-basics.adoc[] diff --git a/modules/end-user-guide/pages/using-private-container-registries.adoc b/modules/end-user-guide/pages/using-private-container-registries.adoc new file mode 100644 index 0000000000..34c5afc8c0 --- /dev/null +++ b/modules/end-user-guide/pages/using-private-container-registries.adoc @@ -0,0 +1,7 @@ +[id="using-private-container-registries"] +// = Using private container registries +:navtitle: Using private container registries +:keywords: end-user-guide, using-private-container-registries +:page-aliases: .:using-private-container-registries + +include::partial$proc_using-private-container-registries.adoc[] \ No newline at end of file diff --git a/modules/end-user-guide/partials/assembly_navigating-che.adoc b/modules/end-user-guide/partials/assembly_navigating-che.adoc index 1ffc358ee2..caefb81699 100644 --- a/modules/end-user-guide/partials/assembly_navigating-che.adoc +++ b/modules/end-user-guide/partials/assembly_navigating-che.adoc @@ -13,6 +13,8 @@ This chapter describes available methods to navigate {prod}. * xref:importing-certificates-to-browsers.adoc[] +* xref:using-private-container-registries.adoc[] + * xref:accessing-che-from-openshift-developer-perspective.adoc[] :context: {parent-context-of-navigating-che} diff --git a/modules/end-user-guide/partials/proc_using-private-container-registries.adoc b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc new file mode 100644 index 0000000000..b0691f18de --- /dev/null +++ b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc @@ -0,0 +1,37 @@ +[id="proc_using-private-container-registries_{context}"] += Using private container registries + +[role="_abstract"] +This section describes the necessery steps to take in order to use container images from private container registries. + +.Prerequisites + +* A running instance of {prod}. To install an instance of {prod}, see xref:installation-guide:installing-che.adoc[]. + +.Procedure + +. Navigate to the {prod-short} Dashboard. See xref:navigating-che-using-the-dashboard.adoc[]. + +. Navigate to *User Preferences*. + +.. Click on your username in the top right corner. + +.. Click the btn:[User Preferences] tab. + +. Click the btn:[Add Container Registry] button in btn:[Container Registries] tab and execute following actions: + +** Enter the container registry domain name in the *Registry* field. + +** Optionally, enter the username of your account at this registry in the *Username* field. + +** Enter the password in the *Password* field in order to authenticate in the container registry. + +. Click the btn:[Add] button. + + +.Verification + +. See, that there is a new entry in the btn:[Container Registries] tab. + +. Create a workspace which uses container image from the specified container registry. See xref:configuring-a-workspace-using-a-devfile.adoc[]. + From b5c2236ea4b04c7f177860cca47bda25fd072002 Mon Sep 17 00:00:00 2001 From: Pavol Baran Date: Wed, 24 Mar 2021 11:55:22 +0000 Subject: [PATCH 2/6] fixing vale errors Signed-off-by: Pavol Baran --- .../partials/proc_using-private-container-registries.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/end-user-guide/partials/proc_using-private-container-registries.adoc b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc index b0691f18de..f4fcdef21e 100644 --- a/modules/end-user-guide/partials/proc_using-private-container-registries.adoc +++ b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc @@ -2,7 +2,7 @@ = Using private container registries [role="_abstract"] -This section describes the necessery steps to take in order to use container images from private container registries. +This section describes the necessary steps to use container images from private container registries. .Prerequisites @@ -24,7 +24,7 @@ This section describes the necessery steps to take in order to use container ima ** Optionally, enter the username of your account at this registry in the *Username* field. -** Enter the password in the *Password* field in order to authenticate in the container registry. +** Enter the password in the *Password* field to authenticate in the container registry. . Click the btn:[Add] button. From 2a145758d106b245f343106a520f697628bd8b9a Mon Sep 17 00:00:00 2001 From: Pavol Baran Date: Thu, 25 Mar 2021 10:08:15 +0000 Subject: [PATCH 3/6] additional resources added Signed-off-by: Pavol Baran --- .../partials/proc_using-private-container-registries.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/modules/end-user-guide/partials/proc_using-private-container-registries.adoc b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc index f4fcdef21e..e8bf4ad3e6 100644 --- a/modules/end-user-guide/partials/proc_using-private-container-registries.adoc +++ b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc @@ -35,3 +35,6 @@ This section describes the necessary steps to use container images from private . Create a workspace which uses container image from the specified container registry. See xref:configuring-a-workspace-using-a-devfile.adoc[]. +.Additional resources + +* link:https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/[Kubernetes documentation: Pull an Image from a Private Registry] \ No newline at end of file From 329644b40e3b05881201720406ede2228acceee0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Mal=C3=A9=C5=99?= <48474054+MichalMaler@users.noreply.github.com> Date: Thu, 25 Mar 2021 16:50:10 +0100 Subject: [PATCH 4/6] Apply suggestions from code review YHontyk's feedback Co-authored-by: Yana Hontyk --- .../partials/proc_using-private-container-registries.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/end-user-guide/partials/proc_using-private-container-registries.adoc b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc index e8bf4ad3e6..3fd467671a 100644 --- a/modules/end-user-guide/partials/proc_using-private-container-registries.adoc +++ b/modules/end-user-guide/partials/proc_using-private-container-registries.adoc @@ -31,10 +31,10 @@ This section describes the necessary steps to use container images from private .Verification -. See, that there is a new entry in the btn:[Container Registries] tab. +. See that there is a new entry in the btn:[Container Registries] tab. -. Create a workspace which uses container image from the specified container registry. See xref:configuring-a-workspace-using-a-devfile.adoc[]. +. Create a workspace that uses a container image from the specified container registry. See xref:configuring-a-workspace-using-a-devfile.adoc[]. .Additional resources -* link:https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/[Kubernetes documentation: Pull an Image from a Private Registry] \ No newline at end of file +* link:https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/[Kubernetes documentation: Pull an Image from a Private Registry] From 99baa633216824c968e92ebf7e2612d0821357be Mon Sep 17 00:00:00 2001 From: Pavol Baran Date: Thu, 25 Mar 2021 17:01:54 +0000 Subject: [PATCH 5/6] changed the section location Signed-off-by: Pavol Baran --- modules/end-user-guide/nav.adoc | 2 +- .../partials/assembly_customizing-developer-environments.adoc | 1 + modules/end-user-guide/partials/assembly_navigating-che.adoc | 2 -- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index b78e582a53..811abb829c 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -3,7 +3,6 @@ * xref:navigating-che.adoc[] ** xref:navigating-che-using-the-dashboard.adoc[] ** xref:importing-certificates-to-browsers.adoc[] -** xref:using-private-container-registries.adoc[] ** xref:accessing-che-from-openshift-developer-perspective.adoc[] * xref:che-theia-ide-basics.adoc[] @@ -35,6 +34,7 @@ **** xref:using-jetbrains-webstorm.adoc[] **** xref:provisioning-jetbrains-activation-code-for-offline-use.adoc[] ** xref:adding-tools-to-che-after-creating-a-workspace.adoc[] +** xref:using-private-container-registries.adoc[] * xref:using-artifact-repositories-in-a-restricted-environment.adoc[] ** xref:using-maven-artifact-repositories.adoc[] ** xref:using-gradle-artifact-repositories.adoc[] diff --git a/modules/end-user-guide/partials/assembly_customizing-developer-environments.adoc b/modules/end-user-guide/partials/assembly_customizing-developer-environments.adoc index a849d11789..536962444f 100644 --- a/modules/end-user-guide/partials/assembly_customizing-developer-environments.adoc +++ b/modules/end-user-guide/partials/assembly_customizing-developer-environments.adoc @@ -25,5 +25,6 @@ A user can extend {prod-short} by using `self-hosted` mode, which {prod-short} p * xref:what-is-a-che-theia-plug-in.adoc[] * xref:using-alternative-ides-in-che.adoc[] * xref:adding-a-vs-code-extension-to-a-workspace.adoc[] +* xref:using-private-container-registries.adoc[] :context: {parent-context-of-customizing-developer-environments} diff --git a/modules/end-user-guide/partials/assembly_navigating-che.adoc b/modules/end-user-guide/partials/assembly_navigating-che.adoc index caefb81699..1ffc358ee2 100644 --- a/modules/end-user-guide/partials/assembly_navigating-che.adoc +++ b/modules/end-user-guide/partials/assembly_navigating-che.adoc @@ -13,8 +13,6 @@ This chapter describes available methods to navigate {prod}. * xref:importing-certificates-to-browsers.adoc[] -* xref:using-private-container-registries.adoc[] - * xref:accessing-che-from-openshift-developer-perspective.adoc[] :context: {parent-context-of-navigating-che} From 2bbaf21b32dd8f16c45a6aa753dd4c4a74cb7ab5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Fri, 26 Mar 2021 11:25:35 +0100 Subject: [PATCH 6/6] Fix htmltest errors --- .htmltest.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.htmltest.yml b/.htmltest.yml index f0c4e4c7dd..48c12c8423 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -18,3 +18,5 @@ CacheExpires: "12h" # Default is 2 weeks. IgnoreURLs: - https://cse.google.com/cse.js - https://marketplace.visualstudio.com + - https://github.com/eclipse/che-docs/edit/master/ + - https://www.eclipse.org/che/docs/che-7/