{"id":15161359,"url":"https://github.com/flanksource/konfigadm","last_synced_at":"2025-09-30T13:32:21.799Z","repository":{"id":49577160,"uuid":"182728467","full_name":"flanksource/konfigadm","owner":"flanksource","description":"konfigadm is a declarative configuration management tool and image builder focused on bootstrapping nodes for container-based environments.","archived":true,"fork":false,"pushed_at":"2023-06-14T06:53:58.000Z","size":2270,"stargazers_count":24,"open_issues_count":21,"forks_count":14,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-01-15T05:26:28.944Z","etag":null,"topics":["cloud-init","containerd","containers","docker","kubeadm","kubernetes"],"latest_commit_sha":null,"homepage":"https://konfigadm.docs.flanksource.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flanksource.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-22T09:32:41.000Z","updated_at":"2023-12-28T10:41:14.000Z","dependencies_parsed_at":"2024-06-18T16:55:26.754Z","dependency_job_id":"482423d2-d2f6-427e-b0cc-6e827b194817","html_url":"https://github.com/flanksource/konfigadm","commit_stats":null,"previous_names":[],"tags_count":81,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanksource%2Fkonfigadm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanksource%2Fkonfigadm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanksource%2Fkonfigadm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flanksource%2Fkonfigadm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flanksource","download_url":"https://codeload.github.com/flanksource/konfigadm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234744628,"owners_count":18879955,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-init","containerd","containers","docker","kubeadm","kubernetes"],"created_at":"2024-09-27T00:04:56.543Z","updated_at":"2025-09-30T13:32:16.431Z","avatar_url":"https://github.com/flanksource.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href=\"https://circleci.com/gh/flanksource/konfigadm\"\u003e\u003cimg src=\"https://circleci.com/gh/flanksource/konfigadm.svg?style=svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://codecov.io/gh/flanksource/konfigadm\"\u003e\u003cimg src=\"https://codecov.io/gh/flanksource/konfigadm/branch/master/graph/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://goreportcard.com/report/github.com/flanksource/konfigadm\"\u003e\u003cimg src=\"https://goreportcard.com/badge/github.com/flanksource/konfigadm\"\u003e\u003c/a\u003e\n\u003cimg src=\"https://img.shields.io/badge/OS-ubuntu%20%7C%20debian%20%7C%20centos%20%7C%20redhat%20%7C%20fedora-lightgrey.svg\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e •\n  \u003ca href=\"#installing-kubernetes\"\u003eKubernetes\u003c/a\u003e •\n  \u003ca href=\"#features\"\u003eKey Features\u003c/a\u003e •\n  \u003ca href=\"#compatibility\"\u003eCompatibility\u003c/a\u003e •\n  \u003ca href=\"DESIGN.md\"\u003eDesign\u003c/a\u003e •\n  \u003ca href=\"https://github.com/moshloop/konfigadm-images/releases\"\u003ePrebuilt Images\u003c/a\u003e •\n  \u003ca href=\"https://konfigadm.docs.flanksource.com/\"\u003e Full Documentation \u003c/a\u003e\n\u003c/p\u003e\n\n`konfigadm` is a declarative configuration management tool and image builder focused on bootstrapping nodes for container based environments.\n\n## Usage\n\n```\nUsage:\n  konfigadm [command]\n\nAvailable Commands:\n  apply       Apply the configuration to the local machine\n  build-image Build a new image using the specified image and konfig\n  cloud-init  Exports the configuration in cloud-init format\n  help        Help about any command\n  minify      Resolve all lookups and dependencies and export a single config file\n  verify      Verify that the configuration has been applied and is in a healthy state\n  version     Print the version of konfigadm\n\nFlags:\n  -c, --config strings   Config files in YAML or JSON format\n  -d, --detect           Detect tags to use\n  -h, --help             help for konfigadm\n  -v, --loglevel count   Increase logging level\n  -t, --tag strings      Runtime tags to use, valid tags: debian,ubuntu,redhat,rhel,fedora,redhat-like,debian-like,centos,aws,vmware\n  -e, --var strings      Extra Variables to in key=value format\n```\n\n## Installation\n\n\n### Binary\n\n```bash\nwget -O /usr/bin/konfigadm https://github.com/flanksource/konfigadm/releases/latest/download/konfigadm \u0026\u0026 chmod +x /usr/bin/konfigadm\n```\n\n## Getting Started\n\n### Installing Kubernetes on the local machine\n\n```bash\nsudo konfigadm apply -c - \u003c\u003c-EOF\nkubernetes:\n  version: 1.21.2\ncontainer_runtime:\n  type: docker\ncommands:\n  - kubeadm init\nEOF\n```\n\n[![asciicast](https://asciinema.org/a/250079.png)](https://asciinema.org/a/250079)\n\n### Building a kubernetes image\n\n```bash\nsudo konfigadm images build --image ubuntu1804 -c - \u003c\u003c-EOF\nkubernetes:\n  version: 1.21.2\ncontainer_runtime:\n  type: docker\ncleanup: true\nEOF\n```\n\nCloud Images are downloaded and then configured with `--build-driver` 2 drivers are supported:\n\n1. `qemu` (default) - Launches the image with KVM and attaches a cloud-init ISO to configure on boot\n2. `libguestfs` - Uses virt-customize to launch an appliance and chroot into the disk, does not require cloud-init in the image, but also cannot test/verify systemd based services due to the chroot.\n\n[![asciicast](https://asciinema.org/a/252399.svg)](https://asciinema.org/a/252399)\n\n## Features\n\n* **Dependency Free** and easily embeddable into an image builder.\n* **Declarative**, The order of operations cannot be changed, there are no implicit or explicit dependencies between items, no conditionals (besides for os/cloud tags) or control flows\n* **Typed**, can validate the configuration (e.g. docker image name is valid, systemd.unit file only includes valid keys, and the values are typed correctly)\n* Has built-in higher-order abstractions for kubernetes, containers, cri, cni, etc.\n* Supports multiple operating systems and package managers\n* Abstractions and many of the built-in elements are easily unit-testable due to the use of virtual filesystem and command execution list.\n* Automatic testing / verification based on intent, not just command success code\n* Generate cloud-init or shell scripts to be used by other systems\n\n## Compatibility\n\nCompatibility is tested via the docker systemd images created by [jrei](https://github.com/j8r/dockerfiles/tree/master/systemd), All example fixtures are first verified as false, applied, and then verified as true.\n\nTo run integration tests:\n\n```bash\nmake ubuntu\n```\n\n## TODO\n\n* Incremental mode\n* Merge duplicate command dependencies (e.g. installing curl)\n* Support templating everywhere (currently only supported in files)\n* Packer/QEMU/VirtualBox/Fusion drivers for building images\n* AMI/OVA Image upload\n* Multi-OS cleanup scripts for building images\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflanksource%2Fkonfigadm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflanksource%2Fkonfigadm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflanksource%2Fkonfigadm/lists"}