Go SDK
This is the documentation for module github.com/eclipse-iofog/iofog-go-sdk/v3. It describes the public API in the current source tree (Controller REST v3.9 client, EdgeletAPI v1, YAML apiVersion default iofog.org/v3). Release notes live in the module repository.
The SDK is a library. It does not ship a CLI. potctl and the operator call these packages.
Start here
| If you want to | Read |
|---|---|
| Install the module and call the Controller once | Getting started |
| Understand which package to import | Packages |
| Authenticate, TLS, and token handling | Security model |
| See why routes were removed | Messaging |
How-to guides
| Task | Guide |
|---|---|
| Log in and call Controller REST | Use the Controller client |
| Deploy Application or Microservice YAML | Deploy YAML |
| Read config inside an edge container | Write an edge microservice |
| Exec into a container or tail logs | Exec and logs |
| Manage models, Knowledge, and RuntimeClasses | Fleet resources |
Reference
| Package | Import path | Reference |
|---|---|---|
| Controller REST client | .../pkg/client | Client |
| YAML deploy executors | .../pkg/apps | Apps |
| EdgeletAPI v1 | .../pkg/microservices | Microservices |
| NATS control plane | methods on client.Client | NATS |
| Kubernetes helpers | .../pkg/k8s, .../pkg/k8s/operator | Kubernetes |
| Architecture codes and registry ids | .../pkg/arch, client maps | Codes |
| Errors, retries, HTTP status | client, apps, microservices | Errors |
See anything wrong with the document? Help us improve it!