{"id":19871844,"url":"https://github.com/saltstack-formulas/kubernetes-formula","last_synced_at":"2025-08-16T16:07:52.097Z","repository":{"id":39618011,"uuid":"195738726","full_name":"saltstack-formulas/kubernetes-formula","owner":"saltstack-formulas","description":"Salt formula to manage kubernetes","archived":false,"fork":false,"pushed_at":"2025-04-07T20:01:40.000Z","size":491,"stargazers_count":20,"open_issues_count":13,"forks_count":25,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-05-02T09:48:44.736Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/saltstack-formulas/kubernetes-formula","language":"SaltStack","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saltstack-formulas.png","metadata":{"files":{"readme":"docs/README.rst","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING_DOCS.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-07-08T04:52:45.000Z","updated_at":"2024-02-01T09:54:45.000Z","dependencies_parsed_at":"2025-05-02T09:39:00.204Z","dependency_job_id":"8c8eed88-6986-4fe1-bf98-7517a1f6b142","html_url":"https://github.com/saltstack-formulas/kubernetes-formula","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/saltstack-formulas/kubernetes-formula","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fkubernetes-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fkubernetes-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fkubernetes-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fkubernetes-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack-formulas","download_url":"https://codeload.github.com/saltstack-formulas/kubernetes-formula/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Fkubernetes-formula/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270735047,"owners_count":24636289,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-12T16:13:47.450Z","updated_at":"2025-08-16T16:07:52.076Z","avatar_url":"https://github.com/saltstack-formulas.png","language":"SaltStack","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _readme:\n\nkubernetes-formula\n==================\n\nExtensible formula to install kubernetes on MacOS, Windows, and GNU/Linux. Support for:\n\n* `server` (https://kubernetes.io) [Linux OS]\n* `node` (https://kubernetes.io) [all OS]\n* `client`  (https://kubernetes.io, aliases) [all OS]\n* `operator` (sdk, etc)\n* `operators` (https://operatorhub.io)  [all OS]\n* `devtools` (extensive collection of tools, kubectx, kubens, cue, attr2rbac, dive, stern, etc)  [all OS]\n* `devlibs`  (kubernetes clients, source software)  [all OS]\n* `sigs`  (https://github.com/kubernetes-sigs, special interest groups)  [all OS]\n* `crimgr` (cri-resource-manager, etc) [linux]\n\n\nThe default `kubernetes.sigs` state includes the following:\n\n* `kind` (https://github.com/kubernetes-sigs/kind)  [all OS]\n* `krew` (https://github.com/kubernetes-sigs/krew)  [linux, darwin]?\n* `kubebuilder` (https://github.com/kubernetes-sigs/kubebuilder  [linux, darwin]?\n\n\nThe default `kubernetes.devtools` state includes the following:\n\n* `audit2rbac` (https://github.com/liggitt/audit2rbac) [all OS]\n* `devspace`  (https://devspace.sh)   [all OS]\n* `dive` (https://github.com/wagoodman/dive)  [all OS]\n* `cue` (https://github.com/cuelang/cue) [all OS]\n* `istio`  (https://istio.io) [all OS]\n* `k3s`   (https://k3s.io)  [all OS)\n* `kudo`   (https://kudo.dev)  [darwin, linux]?\n* `kubectx` (https://github.com/ahmetb/kubectx)  [all OS]\n* `kubens` (https://github.com/ahmetb/kubens)  [all OS]\n* `linkerd2`  (https://linkerd.io)  [all OS]\n* `minikube`  (https://github.com/kubernetes/minikube)  [all OS]\n* `octant`    (https://github.com/vmware-tanzu/octant)  [all OS]\n* `skaffold`  (https://skaffold.dev)  [all OS]\n* `stern`  (https://github.com/wercker/stern)  [all OS]\n\n\nThe default `kubernetes.operator` state includes:\n\n* `operator-sdk` (https://sdk.operatorframework.io/)  [darwin, linux]\n* `helm-operator` (https://sdk.operatorframework.io/)  [darwin, linux]\n* `ansible-operator` (https://sdk.operatorframework.io/)  [darwin, linux]\n\n\nThe default `kubernetes.operators` state [all OS] includes (from https://operatorhub.io):\n\n* `akka-cluster` (https://github.com/lightbend/akka-cluster-operator)  [all OS]\n* `grafana` (https://github.com/integr8ly/grafana-operator)  [all OS]\n* `prometheus` (https://github.com/coreos/prometheus-operator)  [all OS]\n* `istio` (https://github.com/banzaicloud/istio-operator)  [all OS]\n* `shell-operator` (https://github.com/flant/shell-operator)  [all OS]\n\n\nThe default `kubernetes.devlibs` state includes [all OS]:\n\n* `Java client library for kubernetes` (https://github.com/kubernetes-client/java)\n* `Python client library for kubernetes` (https://github.com/kubernetes-client/python)\n* `Csharp client library for kubernetes` (https://github.com/kubernetes-client/csharp)\n* `Javascript client library for kubernetes` (https://github.com/kubernetes-client/javascript)\n* `Python kubernetes-operator library` (https://github.com/zalando-incubator/kopf)\n* `Simple kubernetes Go client` (https://github.com/ericchiang/k8s)\n\nThe default `kubernetes.crimgr` state includes (linux):\n\n* `cri` CRI Resource Manager (https://github.com/intel/cri-resource-manager)\n\n\n|img_travis| |img_sr|\n\n.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/kubernetes-formula.svg?branch=master\n   :alt: Travis CI Build Status\n   :scale: 100%\n   :target: https://travis-ci.com/saltstack-formulas/kubernetes-formula\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n\nA SaltStack formula for kubernetes on MacOS, GNU/Linux and Windows.\n\n.. contents:: **Table of Contents**\n   :depth: 1\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html\u003e`_.  If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_. If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, which contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.  See `Formula Versioning Section \u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nContributing to this repo\n-------------------------\n\n**Commit message formatting is significant!!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\nAvailable Meta states\n----------------------\n\n.. contents::\n   :local:\n\n``kubernetes``\n^^^^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nThis state installs the kubernetes solution (see https://kubernetes.io)\n\n``kubernetes.clean``\n^^^^^^^^^^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nThis state removes the kubernetes solution.\n\n``kubernetes.package.repo``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubernetes package repository only (see https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-using-native-package-management)\n\n``kubernetes.package.repo.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state removes kubernetes package repository only.\n\n``kubernetes.client``\n^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubernetes cli and libraries only  (see https://kubernetes.io/docs/reference/kubectl, (https://kubernetes.io/docs/setup/release/notes/#client-binaries, and https://kubernetes.io/docs/reference/using-api/client-libraries)\n\n``kubernetes.client.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubernetes cli and libraries only.\n\n``kubernetes.server``\n^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubernetes server GNU/Linux only (see https://kubernetes.io and https://kubernetes.io/docs/setup/release/notes/#server-binaries)\n\n``kubernetes.server.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubernetes server GNU/Linux only.\n\n``kubernetes.node``\n^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubernetes node on Windows/MacOS/Linux only (see https://kubernetes.io/docs/concepts/architecture/nodes)\n\n``kubernetes.node.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubernetes node on Windows/MacOS/Linux only.\n\n``kubernetes.sigs``\n^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubernetes sig archives only\n\n``kubernetes.sigs.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubernetes sig archives only\n\n``kubernetes.operator``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs operator archives only (Linux/MacOS)\n\n* sdk (https://sdk.operatorframework.io)\n\n``kubernetes.operator.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls operator archives only (Linux/MacOS)\n\n* sdk (https://sdk.operatorframework.io)\n\n``kubernetes.operators``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs operator archives only\n\n* https://operatorhub.io\n* https://github.com/flant/shell-operator\n\n``kubernetes.operators.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls operator archives only\n\n``kubernetes.devtools``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs selected kubernetes developer tools only\n\n* https://github.com/ahmetb/kubectx\n* https://github.com/cuelang/cue\n* https://github.com/liggitt/audit2rbac\n* https://github.com/wagoodman/dive\n* https://github.com/wercker/stern\n* https://github.com/kubernetes/minikube\n* https://devspace.sh\n* https://k3s.io\n* https://kudo.dev\n* https://istio.io\n* https://github.com/vmware-tanzu/octant\n* https://linkerd.io, and https://github.com/linkerd/linkerd2\n* https://github.com/GoogleContainerTools/skaffold\n\n``kubernetes.devtools.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls selected kubernetes developer tools only\n\n``kubernetes.devlibs``\n^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs selected kubernetes developer libraries\n\n* https://github.com/kubernetes-client\n* https://github.com/zalando-incubator/kopf\n* https://github.com/ericchiang/k8s\n* https://github.com/ahmetb/kubectl-aliases\n\n``kubernetes.devlibs.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls selected kubernetes developer libraries (i.e. kubernetes client libraries, kopf, etc).\n\n``kubernetes.crimgr``\n^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubernetes cri-resource-manager\n\n* https://github.com/intel/cri-resource-manager\n\n``kubernetes.crimgr.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubernetes cri-resource-manager\n\n\nMain Sub-states\n---------------\n\nThis list may be incomplete.\n\n.. contents::\n   :local:\n\n``kubernetes.server.package``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs server packages from repo.\n\n``kubernetes.server.package.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls server packages only \n\n``kubernetes.server.archive``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs server archive only\n\n``kubernetes.server.archive.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls server archive only\n\n``kubernetes.node.package``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs node packages from repo.\n\n``kubernetes.node.package.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls node packages only \n\n``kubernetes.node.archive``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs node archive only\n\n``kubernetes.node.archive.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls node archive only\n\n``kubernetes.client.package``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubectl package only from repo.\n\n``kubernetes.client.aliases``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubernetes developer aliases to /etc/defaults.\n\n* https://github.com/ahmetb/kubectl-aliases\n\n``kubernetes.client.package.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubectl package only\n\n``kubernetes.client.archive``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubectl archive only\n\n``kubernetes.client.archive.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubectl archive only\n\n``kubernetes.client.binary``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs kubectl binary only\n\n``kubernetes.client.binary.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls kubectl binary only\n\n``kubernetes.k3s.binary``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs k3s binary only\n\n``kubernetes.k3s.binary.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls k3s binary only\n\n``kubernetes.k3s.script``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state installs k3s script only\n\n``kubernetes.k3s.script.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state uninstalls k3s script only\n\n\n\nTesting\n-------\n\nLinux testing is done with ``kitchen-salt``.\n\nRequirements\n^^^^^^^^^^^^\n\n* Ruby\n* Docker\n\n.. code-block:: bash\n\n   $ gem install bundler\n   $ bundle install\n   $ bin/kitchen test [platform]\n\nWhere ``[platform]`` is the platform name defined in ``kitchen.yml``,\ne.g. ``debian-9-2019-2-py3``.\n\n``bin/kitchen converge``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nCreates the docker instance and runs the ``kubernetes`` main state, ready for testing.\n\n``bin/kitchen verify``\n^^^^^^^^^^^^^^^^^^^^^^\n\nRuns the ``inspec`` tests on the actual instance.\n\n``bin/kitchen destroy``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nRemoves the docker instance.\n\n``bin/kitchen test``\n^^^^^^^^^^^^^^^^^^^^\n\nRuns all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.\n\n``bin/kitchen login``\n^^^^^^^^^^^^^^^^^^^^^\n\nGives you SSH access to the instance for manual testing.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fkubernetes-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack-formulas%2Fkubernetes-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Fkubernetes-formula/lists"}