README
¶
Cloud Robotics Core
Google's Cloud Robotics Core is an open source platform that provides infrastructure essential to building and running robotics solutions for business automation. Cloud Robotics Core makes managing robot fleets easy for developers, integrators, and operators. It enables:
- packaging and distribution of applications
- secure, bidirectional robot-cloud communication
- easy access to Google Cloud services such as ML, logging, and monitoring.
Cloud Robotics Core is open source and pre-alpha. Support is currently limited to a small set of early access partners. We will gladly accept contributions and feedback, but we are making no stability or support guarantees at this point in time.
Documentation
Documentation of the platform and related how-to guides can be found at:
https://googlecloudrobotics.github.io/core/. The source code for this
documentation is located in the docs folder.
Get Involved
If you want to get involved, please refer to CONTRIBUTING.md, reach out to cloud-robotics-discuss@googlegroups.com or ask Stack Overflow questions with #google-cloud-robotics.
Source Code
Most interesting bits are under src:
- app_charts: contains kubernetes resources for the core platform and apps
- bootstrap: provisioning for the cloud (terraform) and the robot (script)
- go/: the code that goes into images referenced from
app_charts
External dependencies are managed through the third_party folder.
The root directory contains a deploy.sh script for building and installing the software. More
details on that are in the building from sources guide.
Directories
¶
| Path | Synopsis |
|---|---|
|
src
module
|
|
|
go/cmd/app-rollout-controller
command
Runs the app rollout controller which creates and deletes Kubernetes deployments to bring them into agreement with configuration.
|
Runs the app rollout controller which creates and deletes Kubernetes deployments to bring them into agreement with configuration. |
|
go/cmd/chart-assignment-controller
command
Package main defines the entry point for the chart assignment controller service.
|
Package main defines the entry point for the chart assignment controller service. |
|
go/cmd/cr-syncer
command
The CR syncer syncs custom resources between a remote Kubernetes cluster and the local Kubernetes cluster.
|
The CR syncer syncs custom resources between a remote Kubernetes cluster and the local Kubernetes cluster. |
|
go/cmd/cr-syncer-auth-webhook
command
The cr-syncer-auth-webhook verifies that requests from the cr-syncer are limited to the robot named in the credentials.
|
The cr-syncer-auth-webhook verifies that requests from the cr-syncer are limited to the robot named in the credentials. |
|
go/cmd/gcr-credential-refresher
command
|
|
|
go/cmd/http-relay-client
command
Package main runs a local HTTP relay client.
|
Package main runs a local HTTP relay client. |
|
go/cmd/http-relay-client/client
Package main runs a local HTTP relay client.
|
Package main runs a local HTTP relay client. |
|
go/cmd/http-relay-server
command
Package main runs a multiplexing HTTP relay server.
|
Package main runs a multiplexing HTTP relay server. |
|
go/cmd/hw-exporter
command
hw-exporter exposes a Prometheus metric pci_device_count that indicates the number of each PCI device type (vendor/product/class/driver) installed on this node.
|
hw-exporter exposes a Prometheus metric pci_device_count that indicates the number of each PCI device type (vendor/product/class/driver) installed on this node. |
|
go/cmd/metadata-server
command
Package main runs a local http server providing details about the connected cloud project.
|
Package main runs a local http server providing details about the connected cloud project. |
|
go/cmd/setup-dev
command
|
|
|
go/cmd/setup-robot
command
|
|
|
go/cmd/status-echo-server
command
|
|
|
go/cmd/synk
command
|
|
|
go/cmd/token-vendor
command
|
|
|
go/cmd/token-vendor/repository
Package repository defines the api for the pub key stores
|
Package repository defines the api for the pub key stores |
|
go/pkg/client/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
go/pkg/client/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
go/pkg/client/versioned/typed/apps/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
go/pkg/client/versioned/typed/apps/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
go/pkg/client/versioned/typed/registry/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
go/pkg/client/versioned/typed/registry/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
go/pkg/gcr
Library for updating the token used to pull images from GCR in the surrounding cluster.
|
Library for updating the token used to pull images from GCR in the surrounding cluster. |
|
go/pkg/kubetest
Package kubetest provides functionality to create local Kubernetes test clusters and run tests against them.
|
Package kubetest provides functionality to create local Kubernetes test clusters and run tests against them. |
|
go/pkg/robotauth
The robotauth package contains the class for reading and writing the robot-id.json file.
|
The robotauth package contains the class for reading and writing the robot-id.json file. |
|
go/pkg/synk
Package synk contains functionality to synchronize a batch of resources with a cluster while correctly handling CRDs and deletions.
|
Package synk contains functionality to synchronize a batch of resources with a cluster while correctly handling CRDs and deletions. |
|
go/tests
command
|
|
|
proto/http-relay
package http_relay is generated by the proto compiler during the build process.
|
package http_relay is generated by the proto compiler during the build process. |
Click to show internal directories.
Click to hide internal directories.