Supercharge Your Container Development in VS Code with Podman and Podman Desktop
Developing containerized applications can sometimes feel complex, but with the right tools, it can be a smooth and efficient process. In this blog post, we'll explore how to leverage the power of Visual Studio Code (VS Code) together with Podman and Podman Desktop to streamline your container development workflow. We'll cover setting up and using two VS Code extensions that integrate with Podman.
VS Code: Your IDE for Container Development
VS Code is a popular and versatile code editor that can be extended to enhance its functionality. For container development, several excellent extensions integrate seamlessly with Podman.
Prerequisites
Before we begin, ensure you have the following installed:
- Podman: Follow the installation instructions on the official website.
- Podman Desktop: Download and install Podman Desktop from the official website.
- Visual Studio Code: Download and install VS Code from the official website.
VS Code Extensions
To integrate VS Code with Podman, we have 2 extensions as options:
- Microsoft’s Container Tools extension: The "Container Tools" extension provides excellent support for container-related tasks, including building images, managing containers, and working with Containerfiles and Dockerfiles. Microsoft recently announced that they will be evolving the Docker extension into the Container Tools extension to support other tools like Podman!
- Pod Manager: This extension was created by one of the members of our community and is completely open source. It is designed to help you manage Podman containers, images, volumes, and networks directly from the VS Code interface.
While it's unlikely that you would use both extensions simultaneously, comparing them will help you understand the strengths and weaknesses of each, ultimately making it easier to select the one that best fits your needs. So for this blog post, we'll install them one by one.
Option 1: Microsoft’s Container Tools extension
To install the extension:
- Open VS Code.
- Click on the Extensions icon in the Activity Bar (or press
Ctrl+Shift+XorCmd+Shift+X). - Search for "Container Tools" and install the extension by Microsoft.
Configuring VS Code for Podman
The Container Tools extension usually automatically detects Podman if Docker isn't running, by looking at the DOCKER_HOST environment variable. In Podman Desktop navigate to Settings > Docker Compatibility > Third-Party Tool Compatibility and make sure the option is enabled. Learn more about the Docker Compatibility in our documentation.
Option 2: Pod Manager
To install the extension:
- Open VS Code.
- Click on the Extensions icon in the Activity Bar (or press
Ctrl+Shift+XorCmd+Shift+X). - Search for "Pod Manager" and install the extension by dreamcatcher45.
Using the VS Code Extensions
Now that we have the extensions installed and configured, let's see how to use them.
Working with Containerfiles and Dockerfiles
Both extensions provide syntax highlighting, code completion, and linting for Containerfiles and Dockerfiles. Open a Containerfile in VS Code, and you'll immediately benefit from these features.
You can also build images directly from VS Code:
- Right-click on the Containerfile in the Explorer view.
- Select "Build Image".
- VS Code will prompt you for an image name and tag.
- The extension will then build the image using Podman.
- After that you will see the built image in the sidebar.
If you are using the CLI commands to build images, you will also see them here.
Managing Containers
The extensions also allow you to manage containers directly from VS Code. You can start, stop, restart, and remove containers, as well as view their logs and inspect their configuration.
To view the container logs:
- Click on the Container icon in the Activity Bar.
- You'll see a list of your containers, images, and networks.
- Right-click on a container to perform actions.
Similarly using the Pod manager extension we can visually inspect containers, images, and volumes.
- Click on the Pod manager icon in the Activity Bar.
- You'll see a list of your containers, images, and networks.
and manage the container lifecycle.
and of course troubleshoot issues with a visual interface.
Conclusion
In comparison, both extensions provide a nearly identical set of features, so it is really up to you which UI you prefer. Personally I will stick with the Pod Manager because the logo is a seal 🦭. Remember if you encounter any issues using these tools or with Podman Desktop let us know by starting a discussion or creating an issue.
By combining the power of VS Code, Podman, and Podman Desktop, you can create a streamlined and efficient container development workflow. The VS Code extensions provide excellent integration with Podman, allowing you to manage containers, build images, and work with Containerfiles directly from your code editor. We are excited to see that Microsoft is embracing Podman and building support into their ecosystem. Podman Desktop complements this with a visual interface for managing your container environment and will help to move from your development environment to a production Kubernetes environment. Embrace these tools and elevate your container development experience!
Otherwise, you do not see the option.
