Simplifying the Transition from Docker Compose to Kubernetes with Compose Bridge

26 October 2024

Hey, fellow developers and container enthusiasts! Transitioning applications from Docker Compose to Kubernetes can be a daunting task. The differences in configuration syntax, resource definitions, and deployment models often require significant effort to refactor existing applications. Developers face challenges such as:

• Complex Configuration Changes: Rewriting compose.yml files into multiple Kubernetes manifest files can be time-consuming and error-prone.
• Steep Learning Curve: Understanding Kubernetes concepts like Pods, Deployments, Services, and PersistentVolumeClaims adds complexity.
• Resource Management: Managing numerous YAML files and ensuring they are correctly configured for Kubernetes can be overwhelming.

However, there’s a powerful tool that bridges this gap: Compose Bridge. In this article, we’ll explore how Compose Bridge can streamline your migration to Kubernetes, making the process more efficient and less error-prone.

Compose Bridge lets you transform your Docker Compose configuration files into Kubernetes manifests effortlessly. It simplifies the deployment process by converting familiar Compose configurations into formats that Kubernetes understands. This allows you to leverage the robust orchestration capabilities of Kubernetes while maintaining the simplicity and efficiency of Docker Compose.

How Compose Bridge Works

At its core, Compose Bridge uses transformations to convert a Docker Compose model into another form—in this case, Kubernetes manifests. These transformations are packaged as Docker images that take your fully resolved Compose file as input and generate the corresponding Kubernetes configuration files under an /out directory.

Compose Bridge provides its own transformation for Kubernetes using Go templates, making it easy to customize by modifying or extending the templates to suit your specific project needs.

Setting Up Compose Bridge

To get started with Compose Bridge, you’ll need the following:

• Docker Desktop Version 4.33 or Later: Ensure you have the latest version of Docker Desktop installed on your machine.
• Docker Account: Sign in to your Docker account within Docker Desktop.
• Enable Experimental Features and Compose Bridge:
  • Open Docker Desktop and navigate to Settings.
  • Go to Features in development > Experimental features.
  • Check the following options:
    • Access experimental features
    • Enable Compose Bridge command line
    • Click Apply & Restart to save your settings.

Using Docker Desktop to Convert Docker Compose to Kubernetes

Compose Bridge integrates seamlessly with Docker Desktop, allowing you to convert and deploy your Docker Compose applications to Kubernetes directly from the Docker Desktop interface. Here’s how to do it:

Step 1: Enable Kubernetes in Docker Desktop:

• Open Docker Desktop and navigate to Settings.
• Go to Kubernetes and check Enable Kubernetes.
• Click Apply & Restart.
• Wait for Kubernetes to start. You’ll see a Kubernetes is running indicator when it’s ready.

Step 2: Verify Your Docker Compose Setup:

• Navigate to the Containers tab in Docker Desktop.

• Ensure that your Docker Compose services are running correctly.
• Check the container logs to confirm there are no errors.

Step 3: Review Your compose.yml File:

• Open the Compose File Viewer in Docker Desktop by selecting your Compose application and clicking View configurations.
• Review the compose.yml file to ensure it defines the services, volumes, and environment variables you want to deploy.
• Confirm that all configurations are correct and complete.

Step 4: Convert and Deploy to Kubernetes:

In the Compose File Viewer, click Convert and Deploy to Kubernetes.

• Docker Desktop will prompt you to Stop current project containers to avoid port conflicts.
  • Click Stop containers and continue to proceed.

• Docker Desktop will convert your Compose file into Kubernetes manifests and deploy them to the Kubernetes cluster.
• You’ll receive a notification indicating that the configuration was successfully converted and deployed.

Step 5: Review the Generated Kubernetes YAML Files:

• After conversion, the Compose File Viewer will display the generated Kubernetes YAML files.
• These files include:
  • Deployments: Defines the desired state and scaling of your application.
  • Services: Exposes your application internally and externally.
  • PersistentVolumeClaims: Manages storage requirements.
• You can review and edit these files to customize your Kubernetes deployment further.

Step 6: Verify the Kubernetes Pods:

• Return to the Containers tab in Docker Desktop.
• Ensure that each service from your Docker Compose file is running as a Kubernetes pod.
• Check the pod logs to confirm that the services are operating correctly without errors.

Using the Compose Bridge Command Line

Alternatively, you can use the Compose Bridge command-line tool to convert your Compose files to Kubernetes manifests.

Step 1: Use the Default Transformation:

• Open your terminal and navigate to the directory containing your compose.yml file.
• Run the conversion command:

compose-bridge convert

• The command processes your Compose file and generates Kubernetes manifests stored in an out directory.

Step 2: Deploy to Kubernetes:

• Ensure Kubernetes is enabled in Docker Desktop.
• Apply the generated manifests using:

kubectl apply -k out/overlays/desktop/

• This command deploys your application to the Kubernetes cluster.

Understanding the Generated Resources

The default transformation of Compose Bridge produces several Kubernetes resources based on your Compose file:

• Namespace: Isolates resources to prevent conflicts between deployments.
• ConfigMaps and Secrets: Manages configuration data and sensitive information.
• Deployments: Ensures that a specified number of replicas of your application are running.
• Services: Defines how to expose your applications internally and externally.
• PersistentVolumeClaims: Handles storage requirements for your services.
• Network Policies: Replicates the networking topology defined in your Compose file.

Customizing Transformations

Compose Bridge allows you to tailor the transformation process to fit your specific requirements.

Step 1: Modify Default Templates:

compose-bridge transformations create --from docker/compose-bridge-kubernetes my-custom-template

This command creates a directory named my-custom-template containing the templates and a Dockerfile.

Step 2: Customize Template:

• Edit the templates within the directory to modify how resources are generated.
• You can add, remove, or alter templates to produce the desired Kubernetes manifests.

Step 3: Build and Use Your Custom Transformation:

docker build -t mycompany/compose-transform:latest my-custom-template/

Use your custom transformation:

compose-bridge convert --transformations mycompany/compose-transform:latest

Add New Templates

• Create new template files to generate resources not covered by the default templates.
• Use the Go templating language to define how the new resources should be generated.
• Incorporate custom extensions in your Compose file to provide additional data for the templates.

Building Your Own Transformation

If you require a completely different transformation logic, you can build your own transformation from scratch or use other tools like Kompose.

Step 1: Create a Dockerfile for Your Transformation:

FROM alpine

RUN apk add --no-cache curl
ARG VERSION=1.32.0
RUN ARCH=$(uname -m | sed 's/armv7l/arm/g' | sed 's/aarch64/arm64/g' | sed 's/x86_64/amd64/g') && \
   curl -fsL \
   "https://github.com/kubernetes/kompose/releases/download/v${VERSION}/kompose-linux-${ARCH}" \
   -o /usr/bin/kompose
RUN chmod +x /usr/bin/kompose

CMD ["/usr/bin/kompose", "convert", "-f", "/in/compose.yaml", "--out", "/out"]

Step 2: Build and Use Your Transformation:

docker build -t mycompany/custom-transform:latest .

compose-bridge convert --transformations mycompany/custom-transform:latest

Using Compose Bridge as a kubectl Plugin

Compose Bridge can function as a kubectl plugin, integrating seamlessly with your Kubernetes command-line workflows.

Step 1: Install the Plugin:

Ensure the compose-bridge binary is in your system’s PATH and rename it to kubectl-compose_bridge:

mv /path/to/compose-bridge /usr/local/bin/kubectl-compose_bridge

chmod +x /usr/local/bin/kubectl-compose_bridge

Step 2: Verify Installation:

Run plugin list command to confirm that the plugin is recognized:

kubectl plugin list

Step 3: Use the Plugin:

Run Compose Bridge command using kubectl:

kubectl compose-bridge convert

Benefits of Using Compose Bridge

• Simplifies Migration: Converts Compose files to Kubernetes manifests with minimal effort.
• Customizable: Allows for extensive customization to fit your deployment needs.
• Maintains Familiarity: Enables you to continue using Compose configurations while adopting Kubernetes.
• Integrates with Existing Tools: Works with Docker Desktop and can be used as a kubectl plugin.

Conclusion

Transitioning from Docker Compose to Kubernetes doesn’t have to be a complex or time-consuming process. Compose Bridge offers a powerful and flexible solution to convert your existing Compose configurations into Kubernetes manifests, allowing you to harness Kubernetes’ robust orchestration features without starting from scratch.

By simplifying the migration process, Compose Bridge reduces the barriers to adopting Kubernetes, enabling you to scale your applications and take advantage of its advanced capabilities. Whether you’re deploying applications locally using Docker Desktop or planning to scale out to a full Kubernetes cluster, Compose Bridge can help streamline your workflow and reduce the learning curve.

Ready to simplify your Kubernetes deployments? Give Compose Bridge a try and experience a smoother transition from Docker Compose today! We encourage you to experiment with the tool, provide feedback, and contribute to its ongoing development.

For more information and to dive deeper into customization options, check out the official Compose Bridge documentation.

---

My Courses

🎓 Dive into my comprehensive IT courses designed for enthusiasts and professionals alike. Whether you’re looking to master Docker, conquer Kubernetes, or advance your DevOps skills, my courses provide a structured pathway to enhancing your technical prowess.

My Services

💼 Take a look at my service catalog and find out how we can make your technological life better. Whether it’s increasing the efficiency of your IT infrastructure, advancing your career, or expanding your technological horizons — I’m here to help you achieve your goals. From DevOps transformations to building gaming computers — let’s make your technology unparalleled!

Refill My Coffee Supplies

💖 PayPal
🏆 Patreon
💎 GitHub
🥤 BuyMeaCoffee
🍪 Ko-fi

Follow Me

🎬 YouTube
🐦 Twitter
🎨 Instagram
🐘 Mastodon
🧵 Threads
🎸 Facebook
🧊 Bluesky
🎥 TikTok
💻 LinkedIn
📣 daily.dev Squad
🧩 LeetCode
🐈 GitHub

Is this content AI-generated?

Nope! Each article is crafted by me, fueled by a deep passion for Docker and decades of IT expertise. While I employ AI to refine the grammar—ensuring the technical details are conveyed clearly—the insights, strategies, and guidance are purely my own. This approach may occasionally activate AI detectors, but you can be certain that the underlying knowledge and experiences are authentically mine.

Previous post

Install ownCloud Using Docker Compose