{"id":27259539,"url":"https://github.com/pnxtech/local-k8s","last_synced_at":"2025-06-10T13:33:34.692Z","repository":{"id":54474635,"uuid":"522382291","full_name":"pnxtech/local-k8s","owner":"pnxtech","description":"Local Kubernetes cluster for use with Windows/Mac under Docker Desktop","archived":false,"fork":false,"pushed_at":"2022-08-14T02:32:38.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T04:06:08.527Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/pnxtech.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}},"created_at":"2022-08-08T02:40:12.000Z","updated_at":"2022-08-08T02:42:13.000Z","dependencies_parsed_at":"2022-08-13T17:00:25.135Z","dependency_job_id":null,"html_url":"https://github.com/pnxtech/local-k8s","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnxtech%2Flocal-k8s","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnxtech%2Flocal-k8s/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnxtech%2Flocal-k8s/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnxtech%2Flocal-k8s/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pnxtech","download_url":"https://codeload.github.com/pnxtech/local-k8s/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnxtech%2Flocal-k8s/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259085282,"owners_count":22803176,"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":[],"created_at":"2025-04-11T04:06:07.664Z","updated_at":"2025-06-10T13:33:34.652Z","avatar_url":"https://github.com/pnxtech.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# local-k8s\nLocal Kubernetes Cluster\n\nThis repo is design to enable a Kubernetes cluster environment for use in development. \n\nThe cluster hosts services such as a single instance of Redis and MongoDB.  \n\n## Machine setup\n\n### Docker Desktop\nThis Kubernetes setup relies on an installation of [Docker Desktop]() . Once installed make sure to enable Kubernetes on the Docker Desktop dashboard.\n\n## Cluster Setup\nExecute the one time init script. Optionally, include the `local_cluster_host` argument pointed at your ngrok origin, ie: https://some-unique-subdomain.ngrok.io. But all other arguments are required to run the init script.\n\nUsage:\n```shell\n$ ./one-time-init.sh \\\n  --local_cluster_host localk8s.ngrok.io \\\n  --docker_username \u003cdocker-username\u003e \\\n  --docker_password \"\u003cdocker-password\u003e\" \\\n  --docker_email \u003cdocker-email\u003e \\\n  --github_token \u003cgithub-readonly-token\u003e\n```\n\nFor ease, copy the command above into init.sh and execute it.  The `init.sh` is automatically excluded from github and may be deleted after use.\n\n## Starting and stopping the Local K8s cluster\n\n### On MacOS\n\nStarting: \n\n```sh\n./startup.sh\n```\n\nStopping:\n\n```sh\n./shutdown.sh\n```\n\n### On Windows\n\nStarting: \n\n```sh\n.\\startup.ps1\n```\n\nStopping:\n\n```sh\n.\\shutdown.ps1\n```\n\n## Access local gateway rouer\n```\n{sudo} kubectl port-forward --address 0.0.0.0 service/hydra-router-cluster-ip-service 80:5353\nkubectl port-forward --address 0.0.0.0 service/redis-cluster-ip-service 6379:6379\n```\n\n## Optional: using ngrok\n\n```\n ./ngrok.exe http --subdomain=cjus 80\n```\n\n## Use of Redis\nThis repo uses RedisStack to enable a local Redis server. It's highly recommended that you consider using RedisInsight to access the Redis Service.\n\nDownload a version for your OS: https://redis.io/docs/stack/insight/#download-the-latest-redisinsight\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpnxtech%2Flocal-k8s","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpnxtech%2Flocal-k8s","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpnxtech%2Flocal-k8s/lists"}