Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 3.67 KB

File metadata and controls

89 lines (61 loc) · 3.67 KB

API Reference

Packages

servicebindings.anynines.com/v1beta3

Package v1beta3 contains API Schema definitions for the servicebindings v1beta3 API group

Resource Types

InstanceRef

InstanceRef is a reference to a Data Service Instance.

Appears in:

Field Description
apiVersion string APIVersion is the <api_group>/ of the referenced Data Service Instance, e.g. "postgresql.anynines.com/v1beta3" or "redis.anynines.com/v1alpha1".
kind string Kind is the Kubernetes API Kind of the referenced Data Service Instance.
NamespacedName NamespacedName NamespacedName represents the referenced Data Service Instance namespace and name.

NamespacedName

NamespacedName represents a Kubernetes API namespace and name. It's factored out to its own type for reusability.

Appears in:

Field Description
namespace string Namepace of the Instance, if not provided the same namespace as the service bindings will be used
name string

ServiceBinding

ServiceBinding is the Schema for the servicebindings API

Appears in:

Field Description
apiVersion string servicebindings.anynines.com/v1beta3
kind string ServiceBinding
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceBindingSpec
status ServiceBindingStatus

ServiceBindingList

ServiceBindingList contains a list of ServiceBinding.

Field Description
apiVersion string servicebindings.anynines.com/v1beta3
kind string ServiceBindingList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceBinding array

ServiceBindingSpec

ServiceBindingSpec defines the desired state of the ServiceBinding.

Appears in:

Field Description
instance InstanceRef Instance identifies the Data Service Instance that the ServiceBinding binds to.

ServiceBindingStatus

ServiceBindingStatus defines the observed state of the ServiceBinding.

Appears in:

Field Description
secret NamespacedName Secret contains the namespace and name of the Kubernetes API secret that stores the credentials and information (e.g. URL) associated to the service binding to access the bound Data Service Instance.
implemented boolean Implemented is true if and only if the service binding has been implemented by creating a user with the appropriate permissions in the bound Data Service Instance. Users can safely consume the service binding secret identified by Secret IF AND ONLY IF Implemented is true. In other words, even if the secret identified by Secret gets created before Implemented becomes true, users MUST NOT consume that secret before Implemented has become true.
error string Error is a message explaining why the service binding could not be implemented if that's the case.