cleanstart/k8s-sidecar repository overview

⁠Container Documentation for K8S-Sidecar Documentation

The CleanStart K8S-Sidecar image provides a production-ready, security-hardened container optimized for enterprise environments. Built on a minimal base OS with comprehensive security hardening, this image delivers reliable application execution with advanced security features.

📌 Base Foundation: Production-ready container from cleanstart.

Image Path: cleanstart/k8s-sidecar

Registry: cleanstart Registry

⁠Pull Latest Image

Download the container image from the registry

docker pull cleanstart/k8s-sidecar:latest

docker pull cleanstart/k8s-sidecar:latest-dev

Note: cleanstart/k8s-sidecar:latest is a Python-based Kubernetes sidecar that watches ConfigMaps and Secrets cluster-wide (via NAMESPACE=ALL) and syncs their data as files into a shared volume; it requires both the FOLDER_ANNOTATION env var and a matching annotation on each ConfigMap/Secret to specify the target directory, and with UNIQUE_FILENAMES=true writes files as namespace_._. to prevent cross-namespace collisions.

⁠Basic Run

Run the container with basic configuration

docker run -it --name k8s-sidecar cleanstart/k8s-sidecar:latest

⁠Production Deployment

Deploy with production security settings

docker run -d --name k8s-sidecar-prod \
  --security-opt=no-new-privileges \
  --user 1000:1000 \
  --restart unless-stopped \
  cleanstart/k8s-sidecar:latest

Volume Mount Mount local directory for persistent data

docker run -v /app:/app cleanstart/k8s-sidecar:latest

Port Forwarding Run with custom port mappings

docker run -p 8080:8080 cleanstart/k8s-sidecar:latest

⁠Kubernetes Security Context

Recommended security context for Kubernetes deployments

securityContext:
  allowPrivilegeEscalation: false
  capabilities:
    drop:
    - ALL
  readOnlyRootFilesystem: true
  runAsUser: 1000
  runAsGroup: 1000

⁠Documentation Resources

Essential links and resources for further information

• Container Registry: https://www.cleanstart.com/⁠
• CleanStart Community Images: https://hub.docker.com/u/cleanstart⁠
• How-to-Run CleanStart images & sample projects: https://github.com/cleanstart-containers⁠
  • How to run sample projects using Dockerfile
  • How to deploy via Kubernetes YAML
  • How to migrate from public images to CleanStart images

Vulnerability Disclaimer

CleanStart offers Docker images that include third-party open-source libraries and packages maintained by independent contributors. While CleanStart maintains these images and applies industry-standard security practices, it cannot guarantee the security or integrity of upstream components beyond its control.

Users acknowledge and agree that open-source software may contain undiscovered vulnerabilities or introduce new risks through updates. CleanStart shall not be liable for security issues originating from third-party libraries, including but not limited to zero-day exploits, supply chain attacks, or contributor-introduced risks.

Security remains a shared responsibility: CleanStart provides updated images and guidance where possible, while users are responsible for evaluating deployments and implementing appropriate controls.