containers / podman-desktop

Podman Desktop - A graphical tool for developing on containers and Kubernetes

Podman Desktop - A graphical tool for developing on containers and Kubernetes

Documentation

• Overview
• Download
• Features
• Join Our Early Adopter Program (Optional)
• Roadmap
• Contributing
• Communication
• Code of Conduct
• License

Overview

Podman Desktop is a graphical interface that enables application developers to seamlessly work with containers and Kubernetes.

Podman Desktop installs, configures, and keeps Podman up to date on your local environment. It provides a system tray, to check status and interact with your container engine without losing focus from other tasks. The desktop application provides a dashboard to interact with containers, images, pods, and volumes but also configures your environment with your OCI registries and network settings. Podman Desktop also provides capabilities to connect and deploy pods to Kubernetes environments.

Podman Desktop also supports multiple container engines, pick your favourite one and use the tool!

Download

Check the downloads page on podman-desktop.io/downloads.

Features

Containers and pods dashboard

• Build, run, manage, and debug both containers and pods
• Run Pods on your container engine or with Kubernetes
• Convert your Pods to be running on Kubernetes
• Manage multiple container engines

Multiple container engine support

• Podman container engine
• crc
• Lima: Linux Machines
• Docker container engine

Podman engine update support

• Keep podman up-to-date on your PC by having Podman Desktop automatically install the newest version

System tray support

• Manage your Container engine
• Define your Kubernetes context

Enterprise capabilities

• Proxy Support
• OCI Image registries management

Bridge between local and remote environments

• Connect and deploy to both local or remote Kubernetes environments
• Change your Kubernetes context and pick your deployment environment

Join our early adopter program! (optional)

We are seeking developers who are interested in improving Podman Desktop!

Register your interest to join our Early Adopter Program by filling this form.

This is totally optional and does not change any Podman Desktop features.

Roadmap

All upcoming features are tracked with GitHub milestones.

Check out all our future features!

Contributing

Interested in fixing issues or contributing to Podman Desktop?

• 🐛 File bugs or feature requests on GitHub
• 🏁 Read our contributing guide
• 👌 Review or contribute a pull request

Communication

For all bug and feature requests please file a GitHub issue.

Discussions are done using GitHub Discussions.

Chatting

General questions & development:

• #podman-desktop on the Podman Discord
• #[email protected] on IRC
• #[email protected] on Matrix

Note: All channels are bridged. Chat on either Discord, IRC, or Matrix, and your messages will appear on all three platforms!

Kubernetes questions & development:

• #podman-desktop on the Kubernetes Slack

Adopters

Check out the list of companies already using Podman Desktop.

Code of Conduct

This project uses the Containers Community Code of Conduct.

Testing

License

Licensed under Apache 2.0.

podman-desktop's Issues

Support for Windows 10+

Description

The solution should be available to windows users starting with Windows 10 and above.

Acceptance criteria

• Container Desktop is starting on windows 10 and all its components (tray and dashboard) are properly integrated:
  • The tray is properly integrated in the windows toolbar
  • The dashboard is running as an application natively integrated
• CI is setup, configured to test the tool on windows 10

Display list of providers and allow start/stop of container VM from the dashboard

Description

As a user, I should be able to get the list of all the different "container providers" I'm using and start/stop their VM.

Acceptance criteria

• On the dashboard, a new tab should be available to display the list of provider
• For each of the providers, we will display the name of the provider and its status.
• Buttons will allow the user to either start or stop the VM of the "container provider"

Display actions on containers and images list only on hover

Is your feature request related to a problem? Please describe

The UI of the list is heavy and keeps repeating the same actions for each items

Describe the solution you'd like

In order to make the UX and UI simpler and lighter, we should display the actions on each of the list items (containers, images) only on hover

Describe alternatives you've considered

No response

Additional context

No response

Nit: Icon doesn't change to match container status

Describe the bug
If you start and stop containers the icon doesn't change even though status changes to 'running' and 'exited', but if you switch to another page and come back you see that the icon has a running (coloured) and stopped (grey) states.

To Reproduce
Start and stop containers, see the status label change but not the icon. Leave it in the opposite state as it was when you started, then switch to another tab and back to see the icon change.

Expected behavior
A clear and concise description of what you expected to happen.

Desktop (please complete the following information):

• OS: MacOS M1

Ability to list all images from the dashboard

Description

As a user, I should be able to get the list of my pulled images from my different container engines.

Acceptance criteria

• The list must display images pulled by each different container engines
• For each images:
  • we display the image's source, the image ID
  • a tag indicating which container engines used to pull the image
• If no images pulled, then the list is displaying an empty state with a message indicating a sample image to pull.

Simplify/shorten podman-machine-podman-machine-default

Is your feature request related to a problem? Please describe.
I sincerely hope "podman-machine-podman-machine-default" is a typo or oversight on someone's part and will be shortened :) , but I assume that would only be improved to something like "podman-machine-default", which is still a mouthful and not a great string for container desktop to use in menu items, titles, and labels.

Describe the solution you'd like
Most users will only have one podman machine, or usually only one container engine/provider. Ideally I'd like to do two things:

• Use a shorter alias when there is only one Podman machine with the default name, i.e. the equivalent of replacing "podman-machine-podman-machine-default" with "Podman" everywhere.
• If there is only one provider, do we even need to use the provider label everywhere? On Containers and Images pages we could remove them (i.e. only show provider label when there is more than one provider).

Describe alternatives you've considered
We could have a default provider name and allow the user to customize it, but that adds extra UI and I think it's unnecessary for the foreseeable future.

Introduce Preferences screen

Description

In order to allow the user configure certain behaviors for the tool, we would like to introduce a new tab for preferences.

In this initial epic, we would like to focus on the main settings and those which are going to enable configuration of Podman machines.

Application Preferences Section

Resources

In this screen, the user will have the ability to manage the resources used by the different engines. For some providers, it'd be possible to configure the machines, for some, there will be only one and that one will be configuration.

definition to be refined

Ability to view a basic list of all containers from the dashboard

Description

As a user, I should be able to get the list of my containers running with my different container engines.

Acceptance criteria

• The list must display containers running with each different container engines
• For each containers:
  • a small icon is displaying the status of the container
  • we display the name of the container, its image's source
  • a tag with the status of the container

RFE: Provide a Podman Desktop for Linux, Windows and Mac

Is this a BUG REPORT or FEATURE REQUEST? (leave only one on its own line)

/kind feature

Description

Several requests have been received via Twitter, IRC, email, and other sources, to provide a Podman Desktop application similar to the one that Docker provides.

This Desktop application should look and feel the same as much as possible across all three environments and should provide the ability to run Podman on the host it resides upon. For first-pass versions of Podman Desktop, it may be acceptable to run Podman on a specified Linux host, while running the Desktop on another host, whether it be Linux, macOS or Windows.

We plan to talk further about this at the Thursday September 16, 2021, Podman Community Cabal meeting at 10:00 a.m. EDT (UTC-4)
Video Conference. The meeting is open to all and is free to attend.

If you have further requests or ideas for this part of the project, please feel free to reply to this issue and/or attend the meeting. I will reply to this issue with further updates as they arise.

Ability to remove a container from containers list

Is your feature request related to a problem? Please describe

As a user, I'd like to be able to remove a container from the list of containers

Describe the solution you'd like

Getting a small icon to remove a container would be the simplest solution

Describe alternatives you've considered

No response

Additional context

No response

Improve message on empty screen when no images

Is your enhancement related to a problem? Please describe

Empty screen for the images does not provide indication on how to get started

Describe the solution you'd like

As done for "Containers", it would be nice to get a message to show to the user the command to start pulling an image.

Describe alternatives you've considered

No response

Additional context

No response

Desktop doesn't work with newly rolled out OS / Browser / Networking stack in some areas (near RedHat Israel location)

Bug description

After installation using downloaded from Github Windows installer Desktop does nothing

Operating system

Win 11 recent insider preview + Fedora34 WSL2 distro + Chrome v 100.0 dev with Privacy sandbox

Version

next (development version)

Steps to reproduce

1. Download and installer of Container-desktop from github
2. Ru installed desktop
3. Try to list images

Relevant log output

journalctl from inside seems shows nothing relevant except my own Theia backend container unit. 
Does another log mechanism exists?

Additional context

1. Chrome 100 breaks 50% of sites due to 3th party cookies block by the default
2. Chrome 100 breaks 100% of sites with business analytics due to problematic DNS name resolution. Windows ns lookup doesn't resolve IPV6 addresses but resolvectl query from inside WSL VM works correctly. Do not trust in Windows name resolution. IPV6 from the WSL VM doesn't work but issue is opened. Please, support this requirement
3. Possibly, Podman 4 re-installation is needed triggered by Desktop installer.
4. My own Podman service Unit starts OK
5. My Fedora 34 Distro uses systemd / genie
6. My own Podman systemd service unit starts OK.

Happy to see Florent Benoit on the board

Ability to start/stop/restart a container from the list of containers

Description

As a user, I should be able to start/stop/restart a container from the list of containers.

Acceptance criteria

• On hover on one of the container, we'll display a list of actions: Stop, Start, Restart.
• If the container is running, it's not possible to start
• If the container is stopped, it's not possible to click on stop or restart
• When hovering on an action, there is a small tooltip displayed to indicate what the action is

Error after closing main window

Describe the bug
If I open container desktop and then close the window immediately, I get a popup window with "A JavaScript error occurred in the main process":

Uncaught Exception:
TypeError: Object has been destroyed
at Timeout._onTimeout (/Applications/container-desktop.app/Contents/Resources/app.asar/packages/main/dist/index.cjs:1:1973)
at listOnTimeout (node:internal/timers:557:17)
at processTimers (node:internal/timers:500:7)

To Reproduce
Steps to reproduce the behavior:

1. Launch container-desktop.
2. Click on the red X to close the window.
3. Wait 3-4s and notice the popup.

Desktop (please complete the following information):

• OS: MacOS
• Browser: Safari
• Version: 12.2.1

Rework Provider Api plug-in model

Model

Provider model API was designed for a simpler task and now it's reaching the limit.
For example provider could create machines, and not only start and stop some 'machine', etc.
Also sometimes only one machine can be in running state.

Proposal

provider.createProvider(ProviderOptions): Provider method in provider namesapce
It returns a Provider object.

ProviderOptions:
- name/string: name of the provider

- initialStatus being among : 
`INSTALLED`: provider is installed and ready to create some machines for example
`ACTIVE`: at least one connection is established (kubernetes/container)

On Provider object we can call other methods like

registerProviderConnection(connection: ContainerProviderConnection | KubernetesProviderConnection);

ContainerProviderConnection
  name: string;
  endpoint: ContainerProviderConnectionEndpoint
  status: ProviderConnectionStatus

ContainerProviderConnectionEndpoint
  socketPath: string

KubernetesProviderConnection
  name: string;
  endpoint: KubernetesApiEndpoint
  status: ProviderConnectionStatus

KubernetesApiEndpoint
  apiURL: string

ProviderConnectionStatus = 'started' | 'stopped' | 'starting' | 'stopping' | 'unknown';

On a Provider, we should be able to add lifecycle/CRUD operation

like : init or create(Preferences), start, stop update and delete

TrayIcon component:
if one connection, display the name of connection like CRC is running or Podman is running

Handle multiple connections for a provider: depends if there is a flag like 'only one machine at a time'
In that case, we can toggle the current active connection. (for example stop other podman machine or crc machine)

Ability to browse logs of containers and execute commands through a terminal inside the container

Is your feature request related to a problem? Please describe

For now we can list containers but not really interact with them or browse logs

Describe the solution you'd like

browse logs and execute actions in a terminal

Describe alternatives you've considered

No response

Additional context

No response

Blinking screens on images/containers list

Bug description

As a user, when on "Images" or "Containers", I can see the screen blinking and quickly displaying the "empty state"

Operating system

macOS monterey 12.2.1 - Intel

Version

next (development version)

Steps to reproduce

1. Start podman machine
2. Start a container
3. Go into the application on screen "Images" or "Containers"
4. Wait 10s

--> You'll see the screen blinking and quickly displaying the "empty" state before the list of images/containers is getting refreshed.

Relevant log output

No response

Additional context

No response

System tray menu to open window

Is your feature request related to a problem? Please describe.
If I close the window it's still on the Mac dock, and the only way to get it open again is to click on that icon. Ideally I'd like to close the window entirely and open it back from the system tray.

Describe the solution you'd like
Short term, a menu item in the tray to open the window would be nice.
Longer term it would be nice to be able to close the window entirely (so the only way to open it again is via the tray).

Update application's topbar icon

Is your enhancement related to a problem? Please describe

Update application's topbar icon

Describe the solution you'd like

Update application's topbar icon

Screen 1 Container Desktop (9).zip

Describe alternatives you've considered

No response

Additional context

No response

Display Container Port in modal to create a container

Is your enhancement related to a problem? Please describe

It would be handy if we were displaying the port mapping with more information.

Describe the solution you'd like

It would be nice to show the container port along with the localhost port which will be used for the mapping.

Describe alternatives you've considered

No response

Additional context

No response

Can't close Container dialog

Bug description

When you click on the Create container button you can't close it until you pick one of the options, should have an X.

Operating system

macOS 12.3.1 M1

Version

next (development version)

Steps to reproduce

No response

Relevant log output

No response

Additional context

No response

Start container from the images list

Description

As a user, I should be start a container from the list of images, provide an image and port mapping information.

Acceptance criteria

• On hover on one of the image, we'll display an icon allowing to Start a container from that image
• When the user clicks on the "Start" Button, a small popup is displayed to allow the user to provide a name for the container as well as the port mapping information

Change color of action button in the create container modal

Is your enhancement related to a problem? Please describe

inconsistent color in the "create container" modal

Describe the solution you'd like

Use "purple" from the "create container" from the list of containers

Describe alternatives you've considered

No response

Additional context

No response

New application icon

Is your enhancement related to a problem? Please describe

Created a new application icon.

Describe the solution you'd like

Update the app icon ;)

Describe alternatives you've considered

No response

Additional context

No response

Build Dockerfiles with any name

Is your feature request related to a problem? Please describe.
Most dockerfiles have the default name of Dockerfile, but some don't. Need to add support for building files like build.Dockerfile or myproject.Dockerfile.

Describe the solution you'd like
The current UI and defaulting to simple case is good, it just needs a way to override and select a specific file.

Update tray icon

Is your enhancement related to a problem? Please describe

Just update the tray icon

Describe the solution you'd like

new tray icon

Describe alternatives you've considered

No response

Additional context

No response

Support for Mac OS 10.15+ (Intel)

Description

The solution should be available to mac users starting with OSX 10.15 or newer.
(For Mac with Intel chip)

Acceptance criteria

• Container Desktop is starting on OSX 10.15+ and all its components (tray and dashboard) are properly integrated:
  • The tray is properly integrated in the mac toolbar
  • The dashboard is running as an application natively integrated
• CI is setup, configured to test the tool on the target OS

New system tray icon

Is your feature request related to a problem? Please describe

consistency with other system tray icons on mac

Describe the solution you'd like

Describe alternatives you've considered

No response

Additional context

No response

Macos build is not signed

Bug description

My testing stopped right after the download.

Operating system

macOS any

Version

0.0.1

Steps to reproduce

No response

Relevant log output

No response

Additional context

No response

Tray does not show Podman in the list, while it is started

Bug description

Tray does not show Podman in the list, while it is started:

Operating system

macOS 12.3

Version

next (development version)

Steps to reproduce

No response

Relevant log output

No response

Additional context

No response

Can you add a proper README describing this projects, along with images showing the GUI.

Onboarding experience with Podman

Description

When a user downloaded and uses Podman for the first time, the user will not have any machine configured with podman.
The tools should provide the ability for end-users to quickly get a podman-machine up and running so that the end-user can start using containers.

Acceptance criteria

• If podman-machine is not started, then the user has the ability to start the podman-machine
• If podman does not have a machine initialized, the system tray allows the user to create and start a podman-machine
• If the user has multiple podman machines, the user has the ability to switch to a different machine. It will stop one of the machine and start the selected one

Display container engine(s) status in system tray

Description

As a user, I should be able to easily get access to the status of my container engines from the system tray.

Acceptance criteria

• When no container engines are installed/configured, a message is displayed in the system tray's menu
• When the user clicks on the system tray, for each detected container engines (and their VMs) there is an entry in the menu. An icon is showing the state of the VM, if it's running or not.

Provide the ability to auto-fill port mapping

Is your feature request related to a problem? Please describe

We could simplify the experience of defining the port mapping for the end-user

Describe the solution you'd like

It would be nice if the tool is determining and proposing a port to be mapped to the ones exposed in a container.
The detection would check the exposed port and propose one (which is not already used) as a default.
The user would keep the ability to override (or remove) the port mapping.

Describe alternatives you've considered

We could consider that this will be an option that the end-user could configure in the preferences.

Additional context

No response

Impossible to start a podman-machine

Bug description

The tool hangs when trying to start a podman machine

Operating system

macOS 12.2.1 Intel

Version

0.0.1

Steps to reproduce

Pre-Req:

• Make sure you have a podman machine already initialized but not running

Steps:

1. Start the tool
2. Try to start the podman-machine from either the system tray or the list of providers
   --> nothing happens, the tool hangs

Relevant log output

No response

Additional context

No response

Kubernetes integration

Kubernetes integration

We should be able to connect to Kubernetes/OpenShift clusters and optionally be able to handle lifecycle like start/stop for some local providers (minikube, crc, kind, etc)

• #30
• Ability to manage lifecycle of a Kubernetes provider
• List Pods of a Kubernetes provider
• Ability to switch Kubernetes context

Compatibility with podman 4.x and above

Is your feature request related to a problem? Please describe

For the time being, the tool is compatible only with Podman 4.x and above.

Describe the solution you'd like

When starting, the tool should pre-check the version of podman.
If the version detected is older than 4.0, we should display a notification to the end-user and provide instructions on how to upgrade podman.
Ideally, we would also display the latest version number available for podman.

Describe alternatives you've considered

Eventually, we could also display a "Provider update status" in the system tray.
We could display to the end user that a new version is available and could be installed.

Additional context

No response

External container deletion not detected

Bug description

To test issue #33 I tried to delete my existing container and then image externally. The container deletion wasn't picked up (still exists in desktop but not on podman cli) but the image deletion was.

Operating system

macOS 12.2.1 on M1

Version

next (development version)

Steps to reproduce

Create an image and container externally and see them picked up. Delete both externally, image is gone but not container.

Relevant log output

Didn't see any errors in the log.

Additional context

No response

Build an image from local dockerfile

Description

As a user, I should be provide a dockerfile and build it from the list of containers.

Acceptance criteria

• On the list of containers, the user has a button that allows to create a new container.
• When clicked, it gives the option to the user to provide a dockerfile
• The user can select a dockerfile from is local environment and provide a name for the image
• The user can select which container engine to use to build the image.
• When building the image, the user will get access to the outputs.

How do I build an install this package on a Linux box so that I can play with it?

Detect external image changes

Describe the bug
If you build new images from a terminal window they are not detected until you restart container desktop.

To Reproduce
Steps to reproduce the behavior:

1. Open container desktop
2. Open terminal window.
3. Run 'podman build -t something .'.
4. Run 'podman run ... something'.5.
5. Go back to container desktop. The running container is listed but not the new image.

Expected behavior
At least one new image and container appear in container desktop

Desktop (please complete the following information):

• OS: MacOS
• Browser: Safari
• Version 12.2.1

Display image size and creation date

Is your enhancement related to a problem? Please describe

It is not possible to see the size and creation date of an image from the UI.

Describe the solution you'd like

Size and date are displayed on the images tab

Describe alternatives you've considered

No response

Additional context

No response

Odd placement/sizing of container details pane

Bug description

Short summary: I'm picky and the current pane showing logs and terminal isn't working for me. :)

• I didn't know this pane existed until I clicked on a container. Clicking made the left tabs (Containers, Images) shrink, and moved the Create container button half way off screen with no way to scroll it back (see image below). These things 'outside' of the container section shouldn't move.
• The details pane itself doesn't fit in the default window size and no way to scroll right. Yes, I can make the window bigger, but maybe I don't want to or don't realize there are buttons hiding off to the right.
• IMHO we don't need a terminal button since I can click on the tab at the bottom.
• The container name and image are duplicated from what was in the tab already (see comment below).
• The Command column is too narrow and wrapped (and Port in another case), should use more of the pane width for the table.
• "Logs of wizardly_roentgen will appear there if any..." is a bit wordy, maybe just "Log output will appear here..."
• It wasn't clear to me how to close the pane, clicking on white-space didn't work (i.e. clicking on the container on the left again wasn't obvious enough).
• If containers have a detail pane I expect images would have it too. This may be in plan, just saying it should be consistent.

I'd prefer it if the details pane took up the entire size of the container tab (ie replace the containers list), with a back button to the left of the container image (or close button at top right). This would make better use of space and avoid many of the issues above.

Operating system

masOC 12.3.1 M1

Version

next (development version)

Steps to reproduce

No response

Relevant log output

No response

Additional context

No response

Typo when no tags exist for image`<node>`

@gorkem @benoitf shouldn't this be <none>?

https://github.com/containers/desktop/blob/c1250988bffd9623afa441b10be16399af3d5e4f/packages/renderer/src/lib/ImagesList.svelte#L106

Originally posted by @gbraad in #18 (comment)

RFE: Provide a Podman Desktop for Linux, Windows and Mac

Is this a BUG REPORT or FEATURE REQUEST? (leave only one on its own line)

/kind feature

Description

Several requests have been received via Twitter, IRC, email, and other sources, to provide a Podman Desktop application similar to the one that Docker provides.

This Desktop application should look and feel the same as much as possible across all three environments and should provide the ability to run Podman on the host it resides upon. For first-pass versions of Podman Desktop, it may be acceptable to run Podman on a specified Linux host, while running the Desktop on another host, whether it be Linux, macOS or Windows.

We plan to talk further about this at the Thursday September 16, 2021, Podman Community Cabal meeting at 10:00 a.m. EDT (UTC-4)
Video Conference. The meeting is open to all and is free to attend.

If you have further requests or ideas for this part of the project, please feel free to reply to this issue and/or attend the meeting. I will reply to this issue with further updates as they arise.

Provide ability to access logs of the provider

Is your feature request related to a problem? Please describe

When something is going wrong with the podman-machine, it's tedious to understand what's going on.

Describe the solution you'd like

It should be possible from the provider list to access to the logs of the podman-machine (or the other container engine)

Describe alternatives you've considered

No response

Additional context

No response

Start/Stop container engine's VM from the system tray

Description

As a user, I should be able to Start/Stop the VMs of my container engines from the system tray.

Acceptance criteria

• When the user clicks on the system tray, for each detected container engines (and their VMs) there is an entry in the menu.
  • if the VM is running, the user gets a menu entry that allows to stop the VM
  • if the VM is stopped, the user gets a menu entry that allows to start the VM
• When the VM is starting, a small indicator is visible in the system tray which indicates the VM is starting
• If there is an error when starting the VM, then
  • an error indicator is visible in the system tray menu
  • an alert message is getting displayed, showing the details of the error
  • if the user clicks on the VM (with the error indicator), the alert with details about the error is getting displayed

Support for Mac with Silicon chips (Apple)

Description

The solution should be available to mac users with silicon/apple based chip.

Acceptance criteria

• Container Desktop is starting and all its components (tray and dashboard) are properly integrated:
  • The tray is properly integrated in the mac toolbar
  • The dashboard is running as an application natively integrated
• CI is setup, configured to test the tool on the target OS

Refine the left sidebar menu UI

Is your enhancement related to a problem? Please describe

--

Describe the solution you'd like

• Decrease the height of each tabs
• Remove the separator between each tabs
• Selected state to be:
  • purple line (same as primary color) + gray (white, alpha 20%)
• background color: #1C131C
• font style semi-bold (if possible) --pf-global--FontSize--md

Describe alternatives you've considered

No response

Additional context

No response

Ability to register Kubernetes provider

Is your feature request related to a problem? Please describe.
As we register container engines, we should be able to register kubernetes provider.

A kubernetes provider is a Kubernetes/OpenShift endpoint where we have access to the k8s API
Can be a local or remote endpoint

Describe the solution you'd like
Plug-ins can register kubernetes endpoint

Framework can list the endpoints