Skip to content

Commit

Permalink
Add image visibility note to deploy doc
Browse files Browse the repository at this point in the history
Signed-off-by: Dharmit Shah <[email protected]>
  • Loading branch information
dharmit committed Oct 6, 2022
1 parent 93d2a86 commit b3db77b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
5 changes: 5 additions & 0 deletions docs/website/docs/_imageregistrynote.mdx
Original file line number Diff line number Diff line change
@@ -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.
:::
8 changes: 7 additions & 1 deletion docs/website/docs/command-reference/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,7 @@ Your Devfile has been successfully deployed

Your application has now been deployed to the Kubernetes cluster with Deployment, Service, and Ingress resources.

:::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.
:::
import Note from '../../../_imageregistrynote.mdx';

<Note />
Test your application by visiting the `DOMAIN_NAME` variable that you had set in the `devfile.yaml`.

0 comments on commit b3db77b

Please sign in to comment.