Note regarding image visibility for odo deploy (#6191)

* Note regarding image visibility for odo deploy Signed-off-by: Dharmit Shah <[email protected]> * Update docs/website/docs/user-guides/advanced/deploy/_running_deploy.mdx Co-authored-by: Charlie Drage <[email protected]> * Update docs/website/docs/user-guides/advanced/deploy/_running_deploy.mdx Co-authored-by: Charlie Drage <[email protected]> * Update docs/website/docs/user-guides/advanced/deploy/_running_deploy.mdx Co-authored-by: Charlie Drage <[email protected]> * Add image visibility note to deploy doc Signed-off-by: Dharmit Shah <[email protected]> Signed-off-by: Dharmit Shah <[email protected]> Co-authored-by: Charlie Drage <[email protected]>
redhat-developer · Oct 6, 2022 · 4d82c4d · 4d82c4d
1 parent 49fdd17
commit 4d82c4d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/docs/website/docs/_imageregistrynote.mdx b/docs/website/docs/_imageregistrynote.mdx
@@ -0,0 +1,5 @@
+:::note
+Depending upon the container registry specified in the `devfile.yaml`, the access for container image
+pushed by `odo deploy` may be private by default. For example: images pushed to [Quay.io](https://quay.io). Change the
+image visibility appropriately in order to run `odo deploy` successfully.
+:::
diff --git a/docs/website/docs/command-reference/deploy.md b/docs/website/docs/command-reference/deploy.md
@@ -65,7 +65,13 @@ components:
                   image: {{CONTAINER_IMAGE}}
 ```
 
-Note that the `uri` for the Dockerfile could also be an HTTP or HTTPS URL.
+:::note
+The `uri` for the Dockerfile could also be an HTTP or HTTPS URL.
+:::
+
+import Note from '../_imageregistrynote.mdx';
+
+<Note />
 
 ### Running the command
 ```shell

diff --git a/docs/website/docs/user-guides/advanced/deploy/_running_deploy.mdx b/docs/website/docs/user-guides/advanced/deploy/_running_deploy.mdx
@@ -39,4 +39,7 @@ Your Devfile has been successfully deployed
 
 Your application has now been deployed to the Kubernetes cluster with Deployment, Service, and Ingress resources.
 
+import Note from '../../../_imageregistrynote.mdx';
+
+<Note />
 Test your application by visiting the `DOMAIN_NAME` variable that you had set in the `devfile.yaml`.