Skip to main content
Version: v3

Troubleshooting

This page documents possible solutions for the most common issues reported by users.

If your issue is not listed here, feel free to reach out to the team in the #odo channel on the Kubernetes Slack. Or you can also file an issue or start a new discussion.

Authentication issues​

odo deploy is failing to push container image components due to 401 errors​

Description​

odo is failing to push the Image component from the Devfile. It looks like it is trying to push images to the docker.io registry.

Example output
$ odo deploy
  __
 /  \__     Running the application in Deploy mode using go Devfile
 \__/  \    Namespace: my-test-project-1
 /  \__/    odo version: v3.9.0
 \__/

↪ Building & Pushing Image: go-image:latest
 •  Building image locally  ...
[...]
Successfully tagged localhost/go-image:latest
62cbfab7488bcb420404a7be564bb9a41dd2550c027e00fc9ca7037ae98cd193
 ✓  Building image locally [4s]
 •  Pushing image to container registry  ...
Getting image source signatures
Error: trying to reuse blob sha256:314640f419c581ddcac8f3618af39342a4571d5dc7a4e1f5b64d60f37e630b49 at destination: checking whether a blob sha256:314640f419c581ddcac8f3618af39342a4571d5dc7a4e1f5b64d60f37e630b49 exists in docker.io/library/go-image: errors:
denied: requested access to the resource is denied
error parsing HTTP 401 response body: unexpected end of JSON input: ""

 ✗  Pushing image to container registry [507ms]
 ✗  error running podman command: exit status 125

This most commonly happens with odo deploy, but might also happen with odo dev if an Image component is included in the Devfile as part of the inner-loop workflow.

Possible Causes​

The most common cause for this issue is that the Image component from the local Devfile is using a relative name in its imageName field. For example:

[...]
components:
- name: image-build
  image:
    imageName: go-image:latest
    dockerfile:
      uri: docker/Dockerfile
      buildContext: .
      rootRequired: false

Note that we recommend using relative image names to keep the Devfile portable.

As of odo v3.11.0, we are handling relative image names as selectors, provided that you locally indicate to odo a registry where to push those relative images. See How odo handles image names for more details.

To fix this issue, use the command below to set your ImageRegistry preference before calling odo deploy.

odo preference set ImageRegistry $registry
Example output
$ odo preference set ImageRegistry quay.io/$USER
 ✓  Value of 'imageregistry' preference was set to 'quay.io/user'

Dev Sessions issues​

The Image Pull Policy of the dev container is Always and I cannot change it​

Description​

When starting odo dev, the image pull policy of the dev container is currently hardcoded to Always, which may not be ideal for all platforms.

The image pull policy can be changed by declaring a container-overrides attribute in the container component in the Devfile, like so:

components:
- name: runtime
  attributes:
    container-overrides:
      imagePullPolicy: IfNotPresent
  container:
    command: ['tail']
    args: ['-f', '/dev/null']
    endpoints:
    - name: http-node
      targetPort: 3000
    image: registry.access.redhat.com/ubi8/nodejs-16:latest
    mountSources: true

I'm getting "Permission denied" errors when odo dev is syncing files​

Description​

When running odo dev against certain clusters, the Syncing files into the container stage fails due to "Permission denied" errors.

Example output
$ odo dev
  __
 /  \__     Developing using the "places" Devfile
 \__/  \    Namespace: default
 /  \__/    odo version: v3.10.0
 \__/

 ⚠  You are using "default" namespace, odo may not work as expected in the default namespace.
 ⚠  You may set a new namespace by running `odo create namespace <name>`, or set an existing one by running `odo set namespace <name>`

↪ Running on the cluster in Dev mode
 •  Waiting for Kubernetes resources  ...
 ⚠  Pod is Pending
 ✓  Pod is Running
 ◐  Syncing files into the container ✗  Command 'tar xf - -C /projects --no-same-owner' in container failed.

 ✗  stdout:

 ✗  stderr: tar: main.go: Cannot open: Permission denied
tar: .gitignore: Cannot open: Permission denied
tar: README.md: Cannot open: Permission denied
tar: devfile.yaml: Cannot open: Permission denied
tar: go.mod: Cannot open: Permission denied
tar: Exiting with failure status due to previous errors


 ✗  err: error while streaming command: command terminated with exit code 2

 ✗  Syncing files into the container [4s]
Error occurred on Push - watch command was unable to push component: failed to sync to component with name places: failed to sync to component with name places: unable push files to pod: error while streaming command: command terminated with exit code 2


↪ Dev mode
 Status:
 Watching for changes in the current directory /tmp/go-app

 Keyboard Commands:
[Ctrl+c] - Exit and delete resources from the cluster
     [p] - Manually apply local changes to the application on the cluster

Possible Causes​

Various factors are responsible for this:

  • Storage Provisioner used for the cluster
  • User set by the container image
  • Location on the container where the files are to be synced
  • Using Ephemeral vs Non-Ephemeral Volumes

Please refer to Troubleshoot Storage Permission issues on managed cloud providers clusters for possible solutions to fix this.

Orphan Devstate files​

An odo dev session creates a .odo/devstate.<PID>.json file when the session starts, and deletes it at the end of the session.

If the session terminates abrupty, the state file won't be deleted, and will remain in the .odo directory.

You can delete such orphan devstate files using the command odo delete component.

Example output
$ odo delete component
Searching resources to delete, please wait...
This will delete "go" from podman.
 •  The following pods and associated volumes will get deleted from podman:
 •      - go-app

This will delete the following files and directories:
    - /home/user/projects/go/.odo/devstate.83932.json
    - /home/user/projects/go/.odo/devstate.json

Podman Issues​

odo says it cannot access Podman​

Description​

odo dev --platform podman fails to start with the following error:

✗  unable to access podman.Do you have podman client installed and configured correctly?
cause: executable "podman" not recognized as podman client

This seems flaky however, because sometimes it works.

Possible Causes​

When initializing our connector to Podman, we have a default timeout of 1 second for the Podman executable to respond. For some reason, odo sometimes might not be able to get a response from Podman during this short period of time.

First make sure the podman version -f json command returns in a timely manner on your system. If the podman command cannot be found, please make sure Podman is installed correctly and available on your system path. Or you can set the PODMAN_CMD environment variable to indicate where odo can find the podman executable, for example:

export PODMAN_CMD=/absolute/path/to/podman

If the podman executable is available, you can increase the timeout using the PODMAN_CMD_INIT_TIMEOUT environment variable. You can increase this timeout before running odo and this should hopefully fix the issue, for example:

export PODMAN_CMD_INIT_TIMEOUT=10s

Please file an issue if the problem persists.

I am using the remote Podman client and I am unable to reach the ports forwarded by odo​

Description​

Your local Podman is configured as a remote client, interacting with another Podman Backend node via SSH. For example, you are using the podman-remote binary, or are calling Podman with the --remote option.

The Podman remote client works fine, and you can start an odo Dev session leveraging it, e.g.:

$ odo dev --platform podman

[...]
 ✓  Waiting for the application to be ready [1s]
 -  Forwarding from 127.0.0.1:20001 -> 3000

↪ Dev mode
 Status:
 Watching for changes in the current directory /path/to/project

Web console accessible at http://localhost:20000/

Keyboard Commands:
[Ctrl+c] - Exit and delete resources from podman
     [p] - Manually apply local changes to the application on podman

However, the port forwarded by odo dev seems unreachable, e.g.:

$ curl http://127.0.0.1:20001

curl: (7) Failed to connect to localhost port 20001 after 0 ms: Connection refused

Possible causes​

Podman provides the ability to use a local client interacting with a Podman backend node through an SSH connection. However, as explained in this discussion, all resources are only created on the backend node. This includes any ports that might need to be forwarded.

Since you have already configured the SSH connection between the Podman remote client and the backend node, one possible workaround could be to manually open up an SSH tunnel (using the same credentials) right after starting the odo dev session. This way, SSH will do the work of forwarding ports between the machine running odo dev (along with the Podman remote client) and the Podman backend node.

Example:

$ ssh -v -i /path/to/ssh/key -NL 20001:127.0.0.1:20001 -l $user $podman_backend_host

Right after creating the SSH Tunnel in a separate terminal , you will be able to reach the port displayed by odo for port forwarding.

More details on SSH Tunneling.

I have an image component in my Devfile and odo dev on Podman errors out with requested access to the resource is denied​

Description​

You are iterating locally with Podman and have a Devfile more or less similar to the one below, in which you are building a local container image and starting a container component based on the image built.

components:
- image:
    autoBuild: true
    dockerfile:
      buildContext: .
      rootRequired: false
      uri: Containerfile-web
    imageName: web
  name: webimage
- container:
    image: web
  name: web
metadata:
  name: helloworld
schemaVersion: 2.2.0

Running odo dev --platform=podman would error out with the following error message:

$ odo dev --platform=podman

[...]
↪ Building & Pushing Image: webimage                                                         
 •  Building image locally  ... 
[...]
 ✓  Building image locally [23s]
 •  Pushing image to container registry  ...
[...]
Error: writing blob: initiating layer upload to /v2/library/webimage/blobs/uploads/
  in registry-1.docker.io: requested access to the resource is denied
[...]

Possible causes​

In the example above, the webimage image component has autoBuild set to true, which means that it will be built automatically at start time. And when handling an image component, odo dev will try to build it and push it. In this case, because it is a relative image name (imageName: web), by default, the container engine tries to push it to docker.io. Therefore, we will need to:

  • either instruct odo dev not to push images built,
  • or set an ImageRegistry preference indicating where to push the images.

If you instruct odo dev not to push images, odo might still fail when trying to create the pod on Podman, with an error similar to the following:

 ✗  Deploying pod [462ms]
Error occurred on Push - exit status 125: 
Complete Podman output:
Trying to pull localhost/web:latest...
Error: initializing source docker://localhost/web:latest:
  pinging container registry localhost:
    Get "https://localhost/v2/":
      tls: failed to verify certificate:
        x509: certificate is valid for *.apps-crc.testing, not localhost

This is because the imagePullPolicy is Always by default; Podman will try to pull the image, and uses localhost as the default search registry for relative image names.

  1. If the Container component in the Devfile uses the image built from an Image component, you'll need to override the Image Pull Policy, as depicted in The Image Pull Policy of the dev container is Always and I cannot change it. From the example Devfile above, this would mean adding the following container-overrides attributes to the Container component:
components:
- image:
    autoBuild: true
    dockerfile:
      buildContext: .
      rootRequired: false
      uri: Containerfile-web
    imageName: web
  name: webimage
- container:
    image: web
  name: web
  attributes:
    container-overrides:
      imagePullPolicy: IfNotPresent
metadata:
  name: helloworld
schemaVersion: 2.2.0
  1. The second step depends on whether you want to push the images built or not.
If you do not want to push images or do not have access to a registry​

You need to instruct odo dev not to push image components since you don't have access to a registry. This can be done by setting the ODO_PUSH_IMAGES environment variable to false. See Environment variables controlling odo behavior.

ODO_PUSH_IMAGES=false odo dev --platform podman
Example Output
$ ODO_PUSH_IMAGES=false odo dev --platform podman
  __
 /  \__     Developing using the "helloworld" Devfile
 \__/  \    Platform: podman
 /  \__/    odo version: v3.16.1 (b403a1bfb)
 \__/

↪ Running on podman in Dev mode
 ✓  Web console accessible at http://localhost:20000/ 
 ✓  API Server started at http://localhost:20000/api/v1 
 ✓  API documentation accessible at http://localhost:20000/swagger-ui/ 

↪ Building Image: web
 •  Building image locally  ...
STEP 1/8: FROM python:3.12
STEP 2/8: ENV PYTHONUNBUFFERED 1
--> Using cache 380bc9cde8e1ea3af6511d1555288e5771e11eab7cafc508e62eb65a0c283a4c
--> 380bc9cde8e1
STEP 3/8: WORKDIR /app
--> Using cache 3b9fdb6786929f522c70bc75af33ef97cd53e56fbfadd7df70ffb283249a9180
--> 3b9fdb678692
STEP 4/8: COPY requirements.txt /app/
--> Using cache b35333848f81df494194f23be0540f308033d2a002db004e06fa7b349650af11
--> b35333848f81
STEP 5/8: RUN pip install -r requirements.txt
--> Using cache a55bb417c97be3072d923b59001f918554ffe5d4e46982a524f246c3d951c8fc
--> a55bb417c97b
STEP 6/8: COPY ./helloworld /app/
--> Using cache be5ec312ad362a4932c32b12db084c9b90450cd95ad58ccd8b92f6c8f48e625b
--> be5ec312ad36
STEP 7/8: RUN python3 manage.py makemigrations polls
--> Using cache 15cc24d28d245e4ef3e1055b7cfe8bae1ac6c784fcbb66c8d04063e45b2a8ed4
--> 15cc24d28d24
STEP 8/8: CMD ["sh", "-c", "python manage.py migrate && python manage.py runserver 0.0.0.0:8000"]
--> Using cache 1af836519aea46df4787526fc2a8aed578ae48dca0f2f5cf8d83641923ce098e
COMMIT web
--> 1af836519aea
Successfully tagged localhost/web:latest
1af836519aea46df4787526fc2a8aed578ae48dca0f2f5cf8d83641923ce098e
 ✓  Building image locally [572ms]
 ✓  Deploying pod [629ms]
 ✓  Syncing files into the container [416ms]
================================
⚠  Missing default run command
================================

↪ Dev mode
 Status:
 Watching for changes in the current directory /tmp/odo-test/podman-django-template

Web console accessible at http://localhost:20000/

Keyboard Commands:
[Ctrl+c] - Exit and delete resources from podman
     [p] - Manually apply local changes to the application on podman
If you want to push images to a registry​

You can set the ImageRegistry preference to a registry where you have access. See How odo handles image names for further details.

Note that Podman will need to be able to pull images from that location.

odo preference set ImageRegistry quay.io/$USER

Now running odo dev --platform=podman should work by pushing and pulling the images built from that location.

Example Output
$ odo dev --platform podman
  __
 /  \__     Developing using the "helloworld" Devfile
 \__/  \    Platform: podman
 /  \__/    odo version: v3.16.1 (b403a1bfb)
 \__/

↪ Running on podman in Dev mode
 ✓  Web console accessible at http://localhost:20000/ 
 ✓  API Server started at http://localhost:20000/api/v1 
 ✓  API documentation accessible at http://localhost:20000/swagger-ui/ 

↪ Building & Pushing Image: quay.io/user/helloworld-web:1624742
 •  Building image locally  ...
STEP 1/8: FROM python:3.12
STEP 2/8: ENV PYTHONUNBUFFERED 1
--> Using cache d14586395ed0e0dc42f172ed1ca62b37a210f0e668221c9343d9b63afc819e80
--> d14586395ed0
STEP 3/8: WORKDIR /app
--> Using cache 3185ec931b843857a9cfe8aa367fb77d1cfe39ef6c96fde6e0acd9a5c0975673
--> 3185ec931b84
STEP 4/8: COPY requirements.txt /app/
--> Using cache d5f0e542165e77a59fac49dc0fa418dc759e56e17153c2c9ccbc2d8043872046
--> d5f0e542165e
STEP 5/8: RUN pip install -r requirements.txt
--> Using cache b8e2815a4ef279cfd40f180c8c94e24b60adf934e17ba94bb398c556979054b7
--> b8e2815a4ef2
STEP 6/8: COPY ./helloworld /app/
--> Using cache df77575d7573f24812772e5e99172735c0536ea0109e3050a3c2923875f14dac
--> df77575d7573
STEP 7/8: RUN python3 manage.py makemigrations polls
--> Using cache d347f04dc1b05561c0816d2c649bd0d5fabbf87c3074d4d403ba7e98c83cbdaa
--> d347f04dc1b0
STEP 8/8: CMD ["sh", "-c", "python manage.py migrate && python manage.py runserver 0.0.0.0:8000"]
--> Using cache 7a942a913e712f51370d50470bef4b6445b68fbc72d5fae1cfe0934dc0487f02
COMMIT quay.io/user/helloworld-web:1624742
--> 7a942a913e71
Successfully tagged quay.io/user/helloworld-web:1624742
Successfully tagged localhost/web:latest
7a942a913e712f51370d50470bef4b6445b68fbc72d5fae1cfe0934dc0487f02
 ✓  Building image locally [596ms]
 •  Pushing image to container registry  ...
Getting image source signatures
Copying blob 84f540ade319 done   | 
Copying blob a07a24a37470 done   | 
Copying blob 9fe4e8a1862c done   | 
Copying blob f3f47b3309ca done   | 
Copying blob 909275a3eaaa done   | 
Copying blob 1a5fc1184c48 done   | 
Copying blob 349b0b22a493 done   | 
Copying blob 3dd1a7b3caf3 done   | 
Copying blob c5873de99713 done   | 
Copying blob 4769db4ebaab done   | 
Copying blob 08b88032f3bc done   | 
Copying blob 614964f5ff0f done   | 
Copying config 7a942a913e done   | 
Writing manifest to image destination
 ✓  Pushing image to container registry [2m]
 ✓  Deploying pod [745ms]
 ✓  Syncing files into the container [335ms]
================================
⚠  Missing default run command
================================

↪ Dev mode
 Status:
 Watching for changes in the current directory /tmp/odo-test/podman-django-template

Web console accessible at http://localhost:20000/

Keyboard Commands:
[Ctrl+c] - Exit and delete resources from podman
     [p] - Manually apply local changes to the application on podman