Skip to content

Prerequisites

This project uses Devbox to manage the development environment. Devbox provides a consistent, isolated environment with all the necessary tools pre-installed.

System Requirements

  • CPU: 2+ cores recommended
  • Memory: 4GB+ RAM recommended
  • Disk Space: 10GB+ free space
  • Operating System: Linux, macOS, or Windows with WSL2

Network Requirements

  • Outbound internet access for downloading container images
  • Available local ports:
  • 8080: ArgoCD UI
  • 6443: Kubernetes API server

Required Tools

  1. install Docker
  2. Follow the installation instructions for your operating system

The rest of the tools are installed using devbox

  1. Install Devbox

  2. Follow the installation instructions for your operating system

  3. Clone the Repository 

    git clone https://github.com/sean-njela/argocd-demo.git
cd argocd-demo

  4. Start the Devbox Environment and poetry environment 

    devbox shell # Start the devbox environment
poetry install # Install dependencies
poetry env activate # use the output to activate the poetry environment
mkdocs serve # Start the mkdocs server http://127.0.0.1:8000/argocd-demo/

    Note - The first time you run devbox shell, it will take a few minutes to install the necessary tools. But after that it will be much faster.

This concludes all the prerequisites for this project. (Yes, really.)

Optional Tools

These tools are not required for the project to run but can enhance your experience. They are also included in the devbox environment:

  • k9s: Terminal-based UI for Kubernetes
  • Lens: Kubernetes IDE for simplified cluster management
  • kubectx/kubens: Tools for switching between contexts and namespaces

Next Steps

Once you've confirmed all prerequisites are met, proceed to the Getting Started to set up the ArgoCD demonstration environment.