Edges API reference

Prerequisites and scope

Use the workspace where Edges is enabled. Authenticate with a credential authorized for the requested resource and operation. Inspect your deployed API discovery for the exact schema in your hub.

Interfaces

KubernetesCluster and LinuxServer are connected targets; Service exposes an edge application. Workload and Placement describe deployment and target assignment. The API group is edges.railgrid.ai.

Resource schemas

Resource fields and validation rules are generated from the checked-in schemas, with a downloadable JSON bundle.

Inspect edge resources

Authenticate the kubeconfig context for the workspace before reading resources. KubernetesCluster, LinuxServer, and Service are cluster-scoped within the selected workspace. Workload and Placement are namespaced; -A includes those objects across its namespaces.

kubectl railgrid use
kubectl api-resources --api-group=edges.railgrid.ai
kubectl get kubernetesclusters.edges.railgrid.ai,linuxservers.edges.railgrid.ai,services.edges.railgrid.ai,workloads.edges.railgrid.ai,placements.edges.railgrid.ai -A
kubectl explain services.edges.railgrid.ai.spec --api-version=edges.railgrid.ai/v1alpha1

Use kubectl describe on a named object to read conditions and controller events. Forbidden is an RBAC/workspace-scope problem; NotFound can mean the object is in another namespace or the edge has not been registered. Wait for the resource’s reported readiness condition before relying on a Service or Workload endpoint.

Authoritative definitions

API definitions contain fields and contracts. For Kubernetes-style resources, use kubectl api-resources and kubectl explain RESOURCE against the intended workspace to inspect the installed schema.

Related guide

Services and workloads . Return to Edges for prerequisites and the provider’s quickstart.