{"id":30652762,"url":"https://github.com/detiber/k8s-jumperless","last_synced_at":"2025-08-31T07:09:09.332Z","repository":{"id":308937167,"uuid":"1034485857","full_name":"detiber/k8s-jumperless","owner":"detiber","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-29T21:47:22.000Z","size":9070,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-29T23:32:46.034Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/detiber.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-08T13:17:33.000Z","updated_at":"2025-08-29T19:16:30.000Z","dependencies_parsed_at":"2025-08-29T23:21:20.099Z","dependency_job_id":"4dc65ea2-4220-4fd6-a488-c1c5bd9661bb","html_url":"https://github.com/detiber/k8s-jumperless","commit_stats":null,"previous_names":["detiber/k8s-jumperless"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/detiber/k8s-jumperless","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiber%2Fk8s-jumperless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiber%2Fk8s-jumperless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiber%2Fk8s-jumperless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiber%2Fk8s-jumperless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/detiber","download_url":"https://codeload.github.com/detiber/k8s-jumperless/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/detiber%2Fk8s-jumperless/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272949735,"owners_count":25020451,"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-31T02:00:09.071Z","response_time":79,"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":"2025-08-31T07:09:06.471Z","updated_at":"2025-08-31T07:09:08.162Z","avatar_url":"https://github.com/detiber.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# k8s-jumperless\n\nA Kubernetes controller to declaratively manage [Jumperless v5](https://jumperless-docs.readthedocs.io/)\n\n## Description\n\n**Jumperless v5** is a programmable electronic prototyping device built around an **RP2350B microcontroller** that replaces traditional breadboards with software-controlled connections, enabling automated circuit prototyping and testing through:\n\n- **Programmable connections**: Create and modify fully analog electrical connections between nodes using crosspoint matrix switches - no physical jumper wires needed\n- **Arduino Nano compatibility**: Full support for Arduino Nano form factor with UART passthrough and Arduino sketch flashing capabilities\n- **Voltage control**: Set precise voltages (-8V to +8V) on DAC (Digital-to-Analog Converter) channels for power rails and signal generation\n- **Comprehensive I/O**: On-board ADC, current sensing hardware, GPIO, and PWM support for complete circuit control\n- **Scripting and automation**: Built-in MicroPython interpreter with REPL support for scripting, automation, and extending device functionality\n- **Remote management**: Control the device via serial communication for automated testing and configuration\n- **Configuration persistence**: Save and restore circuit configurations and device settings\n\nThis **Kubernetes controller** provides declarative management of Jumperless v5 devices, allowing you to:\n\n- Define circuit configurations as Kubernetes resources\n- Manage multiple Jumperless devices across your infrastructure  \n- Set DAC voltages and network connections through YAML manifests\n- Monitor device status and firmware versions\n- Integrate electronic prototyping into your CI/CD pipelines\n\nFor more information about Jumperless v5 hardware, visit the [official documentation](https://jumperless-docs.readthedocs.io/).\n\n## Features\n\n- **Declarative Management**: Define Jumperless device configurations using Kubernetes Custom Resources\n- **Hardware Abstraction**: Manage Jumperless devices through standard Kubernetes APIs\n- **Multi-host Support**: Connect to Jumperless devices over SSH or locally\n- **Status Reporting**: Real-time device status and configuration reporting\n\n## Components\n\n- **k8s-jumperless manager**: The main Kubernetes controller\n- **Jumperless emulator**: Virtual device for testing ([docs](docs/emulator-proxy.md))\n- **Jumperless proxy**: Recording proxy for generating test configurations ([docs](docs/emulator-proxy.md))\n\n## Getting Started\n\n### Prerequisites\n- go version v1.25.0+\n- docker version 17.03+.\n- kubectl version v1.11.3+.\n- Access to a Kubernetes v1.11.3+ cluster.\n\n### To Deploy on the cluster\n**Build and push your image to the location specified by `IMG`:**\n\n```sh\nmake docker-build docker-push IMG=\u003csome-registry\u003e/k8s-jumperless:tag\n```\n\n**NOTE:** This image ought to be published in the personal registry you specified.\nAnd it is required to have access to pull the image from the working environment.\nMake sure you have the proper permission to the registry if the above commands don’t work.\n\n**Install the CRDs into the cluster:**\n\n```sh\nmake install\n```\n\n**Deploy the Manager to the cluster with the image specified by `IMG`:**\n\n```sh\nmake deploy IMG=\u003csome-registry\u003e/k8s-jumperless:tag\n```\n\n\u003e **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin\nprivileges or be logged in as admin.\n\n**Create instances of your solution**\nYou can apply the samples (examples) from the config/sample:\n\n```sh\nkubectl apply -k config/samples/\n```\n\n\u003e**NOTE**: Ensure that the samples has default values to test it out.\n\n### To Uninstall\n**Delete the instances (CRs) from the cluster:**\n\n```sh\nkubectl delete -k config/samples/\n```\n\n**Delete the APIs(CRDs) from the cluster:**\n\n```sh\nmake uninstall\n```\n\n**UnDeploy the controller from the cluster:**\n\n```sh\nmake undeploy\n```\n\n## Development Tools\n\nThe project includes testing utilities in the `/utils/` directory, each as independent Go submodules:\n\n- **`/utils/emulator/`** - Comprehensive hardware emulator with realistic device simulation\n- **`/utils/proxy/`** - Recording proxy for capturing real device interactions  \n\n### Building Tools\n\nBuild all binaries including the operator, emulator and proxy:\n\n```sh\nmake build-all  # Builds manager + emulator + proxy\n```\n\nOr build components individually:\n\n```sh\nmake build            # Build k8s-jumperless manager only\nmake build-emulator   # Build emulator\nmake build-proxy      # Build proxy  \n```\n\n### Testing with Emulator\n\nThe emulator provides hardware simulation:\n\n```sh\n# create a kind cluster\nkind create cluster\n\n# ensure the controller dependencies are built\nmake\n\n# install the crds\nmake install\n\n# build the emulator docker image\nmake docker-build-proxy\n\ndocker run --privileged -d --rm --name jumperless-emulator -v /dev:/dev -v ./examples:/examples jumperless-emulator:latest --virtual-port /examples/jumperless-port --config /examples/emulator-data.yml\n\ncat \u003c\u003cEOF | kubectl apply -f -\napiVersion: jumperless.detiber.us/v5alpha1\nkind: Jumperless\nmetadata:\n  name: jumperless-emulated\nspec:\n  host:\n    local:\n      port: ./examples/jumperless-port\nEOF\n\nmake run # wait for reconciliation to complete, then ctrl-c\n\ndocker stop jumperless-emulator\n```\n\n### Recording with Proxy\n\nTo generate an emulator config using the controller\n```sh\n# create a kind cluster\nkind create cluster\n\n# ensure the controller dependencies are built\nmake\n\n# install the crds\nmake install\n\n# build the proxy docker image\nmake docker-build-proxy\n\ndocker run --privileged -d --rm --name jumperless-proxy -v /dev:/dev -v ./examples:/examples jumperless-proxy:latest --virtual-port /examples/jumperless-port --emulator-config /examples/emulator-data.yml\n\ncat \u003c\u003cEOF | kubectl apply -f -\napiVersion: jumperless.detiber.us/v5alpha1\nkind: Jumperless\nmetadata:\n  name: jumperless-record\nspec:\n  host:\n    local:\n      port: ./examples/jumperless-port\nEOF\n\nmake run # wait for reconciliation to complete, then ctrl-c\n\ndocker stop jumperless-proxy\n```\n\n### Docker Support\n\nEach utility has its own Docker support with multi-stage builds:\n\n```sh\n# Build utility Docker images\nmake docker-build-all  # Builds all images (manager + emulator + proxy)\n\n# Or build individually\nmake docker-build           # Build k8s-jumperless image only\nmake docker-build-emulator  # Build jumperless-emulator image\nmake docker-build-proxy     # Build jumperless-proxy image\n```\n\nSee [docs/emulator-proxy.md](docs/emulator-proxy.md) for detailed documentation.\n\n## Project Distribution\n\nFollowing the options to release and provide this solution to the users.\n\n### By providing a bundle with all YAML files\n\n1. Build the installer for the image built and published in the registry:\n\n```sh\nmake build-installer IMG=\u003csome-registry\u003e/k8s-jumperless:tag\n```\n\n**NOTE:** The makefile target mentioned above generates an 'install.yaml'\nfile in the dist directory. This file contains all the resources built\nwith Kustomize, which are necessary to install this project without its\ndependencies.\n\n2. Using the installer\n\nUsers can just run 'kubectl apply -f \u003cURL for YAML BUNDLE\u003e' to install\nthe project, i.e.:\n\n```sh\nkubectl apply -f https://raw.githubusercontent.com/\u003corg\u003e/k8s-jumperless/\u003ctag or branch\u003e/dist/install.yaml\n```\n\n### By providing a Helm Chart\n\n1. Build the chart using the optional helm plugin\n\n```sh\nkubebuilder edit --plugins=helm/v1-alpha\n```\n\n2. See that a chart was generated under 'dist/chart', and users\ncan obtain this solution from there.\n\n**NOTE:** If you change the project, you need to update the Helm Chart\nusing the same command above to sync the latest changes. Furthermore,\nif you create webhooks, you need to use the above command with\nthe '--force' flag and manually ensure that any custom configuration\npreviously added to 'dist/chart/values.yaml' or 'dist/chart/manager/manager.yaml'\nis manually re-applied afterwards.\n\n## Contributing\n// TODO(user): Add detailed information on how you would like others to contribute to this project\n\n**NOTE:** Run `make help` for more information on all potential `make` targets\n\nMore information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)\n\n## License\n\nCopyright 2025.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdetiber%2Fk8s-jumperless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdetiber%2Fk8s-jumperless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdetiber%2Fk8s-jumperless/lists"}