API Concepts

K10 exposes an API based on Kubernetes Custom Resource Definitions (CRDs).

This section helps you learn about the the K10 platform and the abstractions that that are available through the API.

Currently the following K10 objects are supported:

  • Profile - abstracts a location (e.g. object store, NFS file store) and a set of credentials for accessing it. The Profile location is used to store and transfer application meta-data and, in some cases, actual persistent data during K10 data management operations.

  • Policy - represents a collection of K10 data management actions that are configured to occur on a periodic or event driven basis. Policies would typically encode a set of business rules and translate them to specific actions that K10 will apply on the applications it has discovered.

  • PolicyPreset - is a predefined set of settings that can easily be applied to a Policy. A PolicyPreset can represent organizational SLAs requiring a user to specify only the application details to be used in a Policy.

  • K10 Application - abstracts an application that has been automatically discovered on the cluster where K10 is running. The application object encapsulates information about all stateful and stateless resources that comprise the application.

  • Action - represents a data management operation that K10 perform. Actions can be initiated on demand or as part of a policy. A number of different types of actions are supported.

  • RestorePoint - created as a result of a backup or import action, a RestorePoint represents a version-in-time of an application that has been captured by K10 and that can be restored using a restore action.