{"id":24169642,"url":"https://github.com/bashtools/mok-docs","last_synced_at":"2026-03-04T16:32:09.179Z","repository":{"id":143872173,"uuid":"272496822","full_name":"bashtools/mok-docs","owner":"bashtools","description":"Documentation for mokctl.","archived":false,"fork":false,"pushed_at":"2020-09-16T21:13:12.000Z","size":671,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-05T18:37:21.940Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bashtools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-06-15T17:01:56.000Z","updated_at":"2024-11-22T20:26:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"db4fd6a8-bbbd-4b92-a272-91605c3b7652","html_url":"https://github.com/bashtools/mok-docs","commit_stats":null,"previous_names":["bashtools/mok-docs","bashtools/mokctl-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/bashtools/mok-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtools%2Fmok-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtools%2Fmok-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtools%2Fmok-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtools%2Fmok-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bashtools","download_url":"https://codeload.github.com/bashtools/mok-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtools%2Fmok-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30086451,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T15:40:14.053Z","status":"ssl_error","status_checked_at":"2026-03-04T15:40:13.655Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2025-01-12T23:12:54.630Z","updated_at":"2026-03-04T16:32:09.161Z","avatar_url":"https://github.com/bashtools.png","language":null,"readme":"# My Own Kind Documentation\n\nBuild verifiably conformant kubernetes multi-node clusters in containers.\n\n## Documentation\n\nThe FAQ, integrating the Parser in your own project, and how `mokctl` was created are all in [Documentation](/docs/README.md).\n\n## Contributing\n\nAll types of contributions are welcome, from giving this project a STAR, bug reports, success stories, feature requests, fixing typppos, correcting documentation, to coding. Also check the [CONTRIBUTING.md](/CONTRIBUTING.md) document.\n\n## Try mokctl\n\nTake note of the [Status](#status) below and the [Releases](https://github.com/mclarkson/my-own-kind/releases) page.\n\n### Status\n\n- stable version - not yet.\n\n- development version - 0.8.10\n  \n  | OS      | Version | Terminal       | Status                            | Notes                                 |\n  | ------- | ------- | -------------- | --------------------------------- | ------------------------------------- |\n  | Ubuntu  | 18.04.4 | gnome terminal | works                             | install as below                      |\n  | Fedora  | 31      | gnome terminal | works                             | disable cgroups2\u003cbr/\u003einstall as below |\n  | Fedora  | 32      | gnome terminal | works                             | disable cgroups2\u003cbr/\u003einstall as below |\n  | Mac OS  |         |                | not tried\u003cbr/\u003eno reports received |                                       |\n  | Windows |         |                | not tried\u003cbr/\u003eno reports received |                                       |\n\n### Install on Linux, Mac and Windows\n\n\u003e Note for **Linux** users: Cgroups 2 must be disabled. See [Linux Installation Options](https://github.com/my-own-kind/mokctl/blob/master/docs/install-linux.md).\n\nEnsure [Docker](https://www.docker.com/get-started) or [Moby](https://github.com/moby/moby) are installed first.\n\nAdd the following to your shell startup file, for example `~/.bashrc` or `~/.zshrc`:\n\n```bash\nalias mokbox='docker run --rm -ti --hostname mokbox --name mokbox -v /var/run/docker.sock:/var/run/docker.sock -v /var/tmp:/var/tmp myownkind/mokbox'\n```\n\nClose the terminal and start it again so the alias is created.\n\nThen 'log in' to the work container:\n\n```bash\nmokbox\n```\n\nUse `mokctl` and `kubectl`, which are already installed in the 'mokbox' container:\n\n```bash\nmokctl build image --get-prebuilt-image\n\nmokctl create cluster myk8s --masters 1\n\nexport KUBECONFIG=/var/tmp/admin-myk8s.conf\n\nkubectl get pods -A\n```\n\nType `exit` or `Ctrl-d` to 'log out' of the mokbox. The mokbox container will be deleted but the kubernetes cluster will remain, as will the `kubectl` file,`/var/tmp/admin-myk8s.conf`.\n\nTo remove the kubernetes cluster:\n\n```bash\nmokbox\n\nexport KUBECONFIG=/var/tmp/admin-myk8s.conf\n\nmokctl delete cluster myk8s\n\nexit\n```\n\nTwo docker images will remain, 'myownkind/mokbox' and 'myownkind/mok-centos-7-v1.19.1'. Remove them to reclaim disk space, or keep them around to be able to quickly build kubernetes clusters.\n\nSee also:\n\n* [Mokctl on Docker Hub](https://hub.docker.com/repository/docker/myownkind/mokctl) - to alias the `mokctl` command only, no mokbox.\n\n* [Linux installation options](/docs/install-linux.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbashtools%2Fmok-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbashtools%2Fmok-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbashtools%2Fmok-docs/lists"}