specifying image registries #261

j-c-berger · 2019-12-12T17:49:12Z

New PR for issue 1178: eclipse-archived/codewind#1178

@jopit and/or @tetchel ready for your review. Let me know what more work needs to be done.

Since this doc isn't VS Code, Eclipse, or Che specific, I advise we move out from under 'Codewind for Eclipse Che' and simply give it its own section under Developing with Codewind.

Signed-off-by: Jacob Berger jacob.berger@ibm.com

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

sishida · 2019-12-13T19:50:03Z

docs/_documentations/image-registry-credentials.md

+    - Codewind deployment registry: `docker-registry.default.svc:5000/<project>`
+    - Credentials: OpenShift user name and token
+
+### Specifying Image Registries for Codewind 


I might not have mentioned this before...but for titles we only capitalize the first word of the title and any names that are normally capitalized. Doc titles and section titles are not like book titles. ;) So, for this title, it would just be, "Specifying image registries for Codewind"

jopit · 2019-12-12T18:36:40Z

docs/_documentations/image-registry-credentials.md

+- Dockerhub:
+    - Host: `docker.io`
+    - Codewind deployment registry: `docker.io/<username>`
+    - Credentials: Dockerhub user name and password


We also support tokens for Docker Hub, so Credentials: Docker Hub user name and password or access token

To expand on this: We support tokens for any Docker registry that supports using tokens for authentication (Docker Hub, IBM Container Registry, Quay, GCR, etc)

jopit · 2019-12-12T18:38:07Z

docs/_documentations/image-registry-credentials.md

+
+## Examples:
+The following deployment registries have been tested and verified with Codewind:
+- Dockerhub:


I believe it should be Docker Hub rather than Dockerhub

From https://hub.docker.com/

jopit · 2019-12-12T18:47:38Z

docs/_documentations/image-registry-credentials.md

+    - Credentials: OpenShift user name and token
+
+### Specifying Image Registries for Codewind 
+There are three scenarios in Codewind where you need to specify what image registry to use:


There are three scenarios, but number 2 below is not correct, not all appsody style projects need an image registry. The three scenarios are:

If you run Codewind on a remote Kubernetes cluster (this includes Che) to develop an Appsody style project, and the image registry for the Appsody stack requires credentials, you need to configure Codewind to use the credentials for that specific image registry.

If you run Codewind locally to develop an Appsody style project, and the the image registry for the Appsody stack requires credentials, you need to docker login to the registry from the command line before you create the Appsody project.

If you run Codewind on a remote Kubernetes cluster (this includes Che) to develop a Codewind style project, you need to configure Codewind with an image registry to push the application's image to.

@sghung @makandre keep me honest here.

I missed this. Looks like what @jopit put is correct and the doc is already edited to reflect this.

Only a minor nit: "the image registry for the Appsody stack requires..." sounds weird to me and maybe better to say "the image registry where the Appsody stack image resides requires..."

jopit · 2019-12-12T18:52:00Z

docs/_documentations/image-registry-credentials.md

+
+If you do not develop any Codewind style projects,and you use an image registry that does not require credentials, then you do not need to specify an image registry. 
+
+### Instructions specific to IBM Cloud Private


@johnmcollier @elsony Does it make any sense to talk about Codewind and IBM Cloud Private at this point, or should this section be removed?

@jopit It does not in my opinion.

So I vote to remove it

maysunfaisal · 2019-12-13T22:27:07Z

docs/_documentations/image-registry-credentials.md

+## Examples:
+The following deployment registries have been tested and verified with Codewind:
+- Dockerhub:
+    - Host: `docker.io`


These keys have also changed. The new Codewind UI has no such fields.

They are address, username, password and namespace.

Another question is, should we provide a screenshot of the Image Registries UI with this doc? It'll make things easier for anyone reading it.

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

j-c-berger · 2019-12-16T16:39:19Z

@jopit, @maysunfaisal, see the new commit "modified" reflecting the discussed changes.

@jopit, I omitted the instructions to IBM Cloud private. If we decided we want to keep it, I can put it back in. We can discuss today at our Plugins. I also thought we could discuss where we want the doc in the TOC (leave it where it is or move it) at today's meeting.

@maysunfaisal, do you have a specific screenshot you want me to use or think we can wait on the screenshot for a later release?

Thanks both for your help--JB

maysunfaisal · 2019-12-16T17:49:47Z

docs/_documentations/image-registry-credentials.md

-    - Host: `docker.io`
+- Docker Hub:
+    - Address: `docker.io`
    - Codewind deployment registry: `docker.io/<username>`


This needs to be Namespace instead of Codewind deployment registry. Value can be <namespace>

You may use this screenshot

I'm wondering if we want to clarify that <namespace> will likely be your username on Docker Hub?

or we can use this above screenshot with doc eclipse-archived/codewind#1488 (comment) since https://www.eclipse.org/codewind/openshiftregistry.html needs to be updated to reflect this PR

And honestly, i think the screenshot being in the other doc sounds better.

@maysunfaisal and @johnmcollier, I'll make these changes and save the screenshot for 1488.

@j-c-berger thx. Maybe in the namespace field, can we add a hint in parenthesis like John suggested?

for Docker Hub the Namespace value is most likely to be the username.

@maysunfaisal, yep, can do!

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

j-c-berger · 2019-12-16T19:17:38Z

@jopit see new commit modified--changes to namespace I didn't see @makandre 's comment about an hour ago regarding "image registry" language. I can make that change but wanted to see if there's anything else you may spot, or if you think it's ready to merge!

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

j-c-berger · 2019-12-16T19:39:19Z

@jopit, per the Plugin meeting's conversation, I've made a new commit (see above) regarding the doc's new position in the TOC.

jopit · 2019-12-16T19:33:21Z

docs/_documentations/image-registry-credentials.md

+The following deployment registries have been tested and verified with Codewind:
+- Docker Hub:
+    - Address: `docker.io`
+    - Namespace: `docker.io/<username>`


Should be Namespace: '<namespace>'

jopit · 2019-12-16T19:34:20Z

docs/_documentations/image-registry-credentials.md

+    - Credentials: Docker Hub username and password or token access
+- Quay.io:
+    - Address: `https://quay.io`
+    - Namespace: `https://quay.io/<username>`


Should be Namespace: '<namespace>'

jopit · 2019-12-16T19:34:30Z

docs/_documentations/image-registry-credentials.md

+    - Credentials: Quay.io user name and encrpyted password
+- Artifactory
+    - Address: `<artifactory-hostname>`
+    - Namespace: `<artifactory-hostname>/<username>`


Should be Namespace: '<namespace>'

jopit · 2019-12-16T19:34:53Z

docs/_documentations/image-registry-credentials.md

+    - Credentials: Artifactory user name and token
+- OpenShift Registry
+    - Address: `docker-registry.default.svc:5000`
+    - Namespace: `docker-registry.default.svc:5000/<project>`


Should be Namespace: '<project>'

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

j-c-berger · 2019-12-16T20:41:22Z

@jopit changes made, thanks! See changes in new commit, "changes to namespace"

jopit · 2019-12-16T21:32:11Z

docs/_documentations/image-registry-credentials.md

+order: 1
+---
+# Codewind Docker registry guidance
+When you run Codewind on Kubernetes, Codewind uses [`buildah`](https://github.com/containers/buildah) to build container images from Dockerfiles and to push the images to an image registry that you specify. You can use the `Image Registry Manager` in your Codewind IDE to configure the registry to use. 


Just spotted this, I think we need to clarify by changing ...on Kubernetes, Codewind uses.. to something like ..on Kubernetes, for Codewind style projects, Codewind uses...

This is because for non-codewind style projects, there is no pushing of images, and so no need to specify a push registry.

Agreed with @jopit. This doc was originally written before Codewind on Kube supported Appsody and Odo projects.

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

j-c-berger · 2019-12-17T18:41:32Z

@jopit and/or @johnmcollier made the changes. Slowly, yet surely, we're rounding this bugger out!

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

* specifying image registries Signed-off-by: Jacob Berger <jacob.berger@ibm.com> * modified Signed-off-by: Jacob Berger <jacob.berger@ibm.com> * modified--changes to namespace Signed-off-by: Jacob Berger <jacob.berger@ibm.com> * changed location of image-registry-credentials.md in the TOC Signed-off-by: Jacob Berger <jacob.berger@ibm.com> * changes to namespace Signed-off-by: Jacob Berger <jacob.berger@ibm.com> * codewind style projectds on kubernetes Signed-off-by: Jacob Berger <jacob.berger@ibm.com> * removed my changes from TOC in order to resolve merge conflict Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

specifying image registries

0bd518d

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

sishida assigned j-c-berger Dec 12, 2019

micgibso mentioned this pull request Dec 13, 2019

new doc on container registries for Codewind #251

Closed

sishida requested a review from jopit December 13, 2019 19:42

sishida reviewed Dec 13, 2019

View reviewed changes

jopit suggested changes Dec 13, 2019

View reviewed changes

maysunfaisal suggested changes Dec 13, 2019

View reviewed changes

modified

ab77abd

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

maysunfaisal suggested changes Dec 16, 2019

View reviewed changes

maysunfaisal mentioned this pull request Dec 16, 2019

SVT:[0.7.0]:Need doc updates for che install. eclipse-archived/codewind#1488

Closed

modified--changes to namespace

de58881

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

changed location of image-registry-credentials.md in the TOC

288c5ac

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

jopit suggested changes Dec 16, 2019

View reviewed changes

changes to namespace

d13b79e

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

jopit reviewed Dec 16, 2019

View reviewed changes

codewind style projectds on kubernetes

8910af5

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

jopit approved these changes Dec 17, 2019

View reviewed changes

removed my changes from TOC in order to resolve merge conflict

dca09c6

Signed-off-by: Jacob Berger <jacob.berger@ibm.com>

sishida merged commit 048f79a into eclipse-archived:master Dec 17, 2019

micgibso mentioned this pull request Dec 18, 2019

Move docker registry topic eclipse-archived/codewind#1585

Closed


		If you do not develop any Codewind style projects,and you use an image registry that does not require credentials, then you do not need to specify an image registry.

		### Instructions specific to IBM Cloud Private

specifying image registries #261

specifying image registries #261

Uh oh!

Conversation

j-c-berger commented Dec 12, 2019

Uh oh!

sishida Dec 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j-c-berger commented Dec 16, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maysunfaisal Dec 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j-c-berger commented Dec 16, 2019

Uh oh!

j-c-berger commented Dec 16, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j-c-berger commented Dec 16, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j-c-berger commented Dec 17, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sishida Dec 13, 2019 •

edited

Loading

maysunfaisal Dec 16, 2019 •

edited

Loading