Onboarding an Application with OneCompute
This section summarizes the steps required to onboard an application with OneCompute:
- Register the application
- Get access to the OneCompute API
- Authenticating with the OneCompute API
- Build the Application Worker
- Create and Submit Jobs through the OneCompute API
Register the application
OneCompute supports two different application registries, depending on which authentication model is used by the application (see the Authentication Topics section for details):
- If interactive user authentication is needed, the application must be registered with Veracity
- If client credentials (typically service-to-service) authentication is used, the application must be registered with the OneCompute Service Registry
Get Access to the OneCompute API
When authenticating, the client must request which APis it needs access to. In the Veracity API registry, each OneCompute deployment has a separate API id. In the OneCompute Service Registry, the same API id is shared between all OneCompute deployments.
Authenticating with the OneCompute API
See Authentication Topics for details on the types of authentication supported by the OneCompute API.
When choosing the authentication model to use, the following guidelines can be used:
- If the OneCompute job is initiated by from an interactive session and it is required to associate the job with the interactive user, use Veracity authentication
- Otherwise, use client credentials authentication (typically in a service-to-service scenario)
Build the Application Worker
See Application Worker.
Create and Submit Jobs through the OneCompute API
The following sections in the documentation are relevant for creating and submitting a OneCompute job:
- Job paragraph in the OneCompute Concepts section describing the Job concept
- Create Job describing how to create a job
- OneCompute Platform Client describing the OneCompute Platform client providing easy access to the OneCompute Platform REST API
- Submit Job describing how to submit a job to OneCompute Platform using the OneCompute Platform Client. See the Job paragraph in the OneCompute Concepts section for description of