Skip to content

Commit 759b056

Browse files
kvs-coderkvs-coder
committed
initial
0 parents  commit 759b056

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+4851
-0
lines changed

‎.gitignore

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
# Jetbrains IDEs
3+
.idea
4+
5+
# Vim
6+
*.swp
7+
*.swn
8+
*.swo
9+
10+
# MacOS system file
11+
.DS_Store
12+
13+
# Environment variable files
14+
*.env
15+
16+
# PEM files
17+
*.pem
18+
19+
# Binaries for programs and plugins
20+
*.exe
21+
*.exe~
22+
*.dll
23+
*.so
24+
*.dylib
25+
26+
# Binaries compiled by Go
27+
build/
28+
29+
# Test binary, built with `go test -c`
30+
*.test
31+
32+
# Output of the go coverage tool
33+
*.new
34+
*.old
35+
*.out
36+
37+
# Dependency directories
38+
vendor/
39+
40+
# Redis
41+
*.rdb

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2020 ARM Ltd
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

‎Makefile

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
check_context:
2+
@if [ "$$(docker context show)" != "deviceorbit" ]; then \
3+
echo "Switching Docker context to 'deviceorbit'"; \
4+
docker context use deviceorbit; \
5+
fi
6+
@if [ "$$(kubectx --current)" != "k3d-deviceorbit" ]; then \
7+
echo "Switching Kubernetes context to 'k3d-deviceorbit'"; \
8+
kubectx k3d-deviceorbit; \
9+
fi
10+
11+
skaffold_run:
12+
$(MAKE) -C src/controller skaffold_run
13+
$(MAKE) -C src/plugin skaffold_run
14+
wait
15+
16+
skaffold_clean:
17+
$(MAKE) -C src/plugin skaffold_clean
18+
$(MAKE) -C src/controller skaffold_clean
19+
wait
20+
21+
run: check_context skaffold_run
22+
23+
clean: check_context skaffold_clean

‎README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# DeviceOrbit Monorepo
2+
Streamlined USB Mobile Device Management in Kubernetes
3+
4+
## Overview
5+
**DeviceOrbit** is a monorepo that integrates USB-connected Android and iOS devices into Kubernetes environments. It combines a Device Plugin, a pod management controller, and a local K3s cluster setup to enable secure, containerized access to mobile devices for development and testing. Built with Skaffold, Helm, and K3s, it’s designed for simplicity and flexibility.
6+
7+
### Purpose
8+
DeviceOrbit simplifies working with physical mobile devices in Kubernetes by:
9+
- Exposing USB devices as node resources
10+
- Managing device-specific pods programmatically
11+
- Providing a lightweight local testing environment
12+
13+
## Components
14+
The monorepo includes three key components, each with its own subdirectory:
15+
16+
1. **`src/plugin`**: A Kubernetes Device Plugin that detects USB mobile devices (Android/iOS) and exposes them as resources (e.g., `com.kvs.deviceorbit/<serial>`).
17+
2. **`src/controller`**: A controller that creates and deletes pods for these devices via gRPC and HTTP APIs.
18+
3. **`cluster/`**: A K3d configuration for a local K3s cluster with USB support and a registry (`deviceorbit:5050`).
19+
20+
For detailed functionality, setup, and usage, refer to the `README.md` in each subdirectory.

‎cluster/Makefile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Default values
2+
IP_ADDRESS ?= 127.0.0.2
3+
HOSTNAME ?= deviceorbit
4+
5+
init:
6+
sudo ./setup.sh $(IP_ADDRESS) $(HOSTNAME)

‎cluster/README.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# K3d Cluster Setup for Mobile Device Testing
2+
Quickly Set Up a Local K3s Cluster for USB Mobile Device Projects
3+
4+
## Overview
5+
This guide provides instructions to set up a local K3s cluster using K3d, tailored for testing the **Mobile Device Controller** and **Smart Device Manager** projects. The cluster, named `k3d-deviceorbit`, includes a local registry (`deviceorbit:5050`), USB device access, and port mappings for HTTP/gRPC APIs. It’s ideal for developing and testing workflows involving Android and iOS devices in Kubernetes.
6+
7+
### Purpose
8+
- Create a lightweight K3s cluster for local development
9+
- Enable USB device passthrough for mobile device testing
10+
- Integrate with Skaffold and Helm workflows from related projects
11+
12+
## Prerequisites
13+
To set up and use this K3d cluster, ensure the following requirements are met:
14+
15+
- **Operating System**: A Linux distribution (e.g., Ubuntu) with `sudo` privileges
16+
- **Required Tools**:
17+
- [Docker](https://www.docker.com/) (`docker.io`) for container runtime
18+
- [K3d](https://k3d.io) (`k3d`) for managing the K3s cluster
19+
- `kubectx` and `kubectl` for Kubernetes context and cluster management
20+
- `make` for executing Makefile targets
21+
- **Hardware**: A machine equipped with USB ports and connected Android/iOS devices
22+
- **Dependencies**: `libusb` installed on the host for USB device support
23+
- **Docker Registry Configuration**:
24+
The local registry operates on `deviceorbit:5050` over HTTP. Configure Docker to recognize it as an insecure registry:
25+
- Edit (or create) `/etc/docker/daemon.json`:
26+
```json
27+
{
28+
"insecure-registries": ["deviceorbit:5050"]
29+
}
30+
```
31+
32+
## Cluster Configuration
33+
The cluster is defined in `k3d.yaml`:
34+
- **Name**: `k3d-deviceorbit`
35+
- **API**: Exposed at `deviceorbit:6445` (mapped to `0.0.0.0:6445`)
36+
- **Registry**:
37+
- Name: `deviceorbit`
38+
- Host: `0.0.0.0:5050`
39+
- Mirror: `deviceorbit.local:5050` (endpoint: `http://deviceorbit:5000`)
40+
- **Volumes**:
41+
- `/dev:/dev` mapped to the server node for USB access
42+
- **Ports**:
43+
- `8080-8090:8080-8090` (HTTP range)
44+
- `30050-30100:30050-30100` (NodePort range)
45+
- **K3s Options**:
46+
- Allows unsafe sysctls: `net.ipv6.conf.all.disable_ipv6`, `net.ipv4.ip_forward`
47+
48+
## Setup Instructions
49+
### Makefile Targets
50+
The repository includes a Makefile with a single target for initialization:
51+
- **`init`**: Runs `./setup.sh` with `IP_ADDRESS` and `HOSTNAME` arguments
52+
- Default: `IP_ADDRESS=127.0.0.2`, `HOSTNAME=deviceorbit`

‎cluster/k3d.yaml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
apiVersion: k3d.io/v1alpha5 # this will change in the future as we make everything more stable
2+
kind: Simple # internally, we also have a Cluster config, which is not yet available externally
3+
metadata:
4+
name: deviceorbit # name that you want to give to your cluster (will still be prefixed with `k3d-`)
5+
kubeAPI: # same as `--api-port myhost.my.domain:6445` (where the name would resolve to 127.0.0.1)
6+
host: "deviceorbit" # important for the `server` setting in the kubeconfig
7+
hostIP: "0.0.0.0" # where the Kubernetes API will be listening on
8+
hostPort: "6445" # where the Kubernetes API listening port will be mapped to on your host system
9+
registries: # define how registries should be created or used
10+
create: # creates a default registry to be used with the cluster; same as `--registry-create registry.localhost`
11+
name: deviceorbit
12+
host: "0.0.0.0"
13+
hostPort: "5050"
14+
config: |
15+
auths: null
16+
mirrors:
17+
deviceorbit.local:5050:
18+
endpoint:
19+
- http://deviceorbit:5000
20+
options:
21+
k3s: # options passed on to K3s itself
22+
extraArgs: # additional arguments passed to the `k3s server|agent` command; same as `--k3s-arg`
23+
- arg: --kubelet-arg=--allowed-unsafe-sysctls=net.ipv6.conf.all.disable_ipv6
24+
nodeFilters: ['server:0']
25+
- arg: --kubelet-arg=--allowed-unsafe-sysctls=net.ipv4.ip_forward
26+
nodeFilters: ['server:0']
27+
volumes: # repeatable flags are represented as YAML lists
28+
- volume: /dev:/dev # same as `--volume '/my/host/path:/path/in/node@server:0;agent:*'`
29+
nodeFilters: ['server:0']
30+
ports:
31+
- port: 8080-8090:8080-8090
32+
nodeFilters: ['server:0']
33+
- port: 30050-30100:30050-30100
34+
nodeFilters: ['server:0']
35+

0 commit comments

Comments
 (0)