Documentation
¶
Overview ¶
Package resource contains utilities to convert protobuf representations of Crossplane resources to unstructured Go types, often with convenient getters and setters.
Index ¶
- Constants
- func AsObject(s *structpb.Struct, o runtime.Object) error
- func AsStruct(o runtime.Object) (*structpb.Struct, error)
- func MustStructJSON(j string) *structpb.Struct
- func MustStructObject(o runtime.Object) *structpb.Struct
- type Composite
- type ConnectionDetails
- type Credentials
- type CredentialsType
- type DesiredComposed
- type Extradeprecated
- type Name
- type ObservedComposed
- type Ready
- type Required
Constants ¶
const (
// CredentialsTypeData is a Credential of type Data.
CredentialsTypeData = "Data"
)
Variables ¶
This section is empty.
Functions ¶
func MustStructJSON ¶
MustStructJSON is intended only for use in tests. It returns the supplied JSON string as a struct. It panics if it can't.
Types ¶
type Composite ¶
type Composite struct {
Resource *composite.Unstructured
ConnectionDetails ConnectionDetails
Ready Ready
}
A Composite resource - aka an XR.
type ConnectionDetails ¶
ConnectionDetails created or updated during an operation on an external resource, for example usernames, passwords, endpoints, ports, etc.
type Credentials ¶ added in v0.3.0
type Credentials struct {
// Type represents the type of credentials.
Type CredentialsType
// Data is a map of key-value pairs where the keys are strings, and the values are byte slices
// containing sensitive data.
Data map[string][]byte
}
Credentials is a secret requested by a Function.
type CredentialsType ¶ added in v0.3.0
type CredentialsType string
CredentialsType is the type of credentials.
type DesiredComposed ¶
type DesiredComposed struct {
Resource *composed.Unstructured
Ready Ready
}
DesiredComposed reflects the desired state of a composed resource.
func NewDesiredComposed ¶
func NewDesiredComposed() *DesiredComposed
NewDesiredComposed returns a new, empty desired composed resource.
type Name ¶
type Name string
A Name uniquely identifies a composed resource within a Composition Function pipeline. It's not the resource's metadata.name.
type ObservedComposed ¶
type ObservedComposed struct {
Resource *composed.Unstructured
ConnectionDetails ConnectionDetails
}
ObservedComposed reflects the observed state of a composed resource.
type Ready ¶
type Ready string
Ready indicates whether a composed resource should be considered ready.
type Required ¶ added in v0.5.0
type Required struct {
Resource *unstructured.Unstructured
}
Required is a resource explicitly required by a Function.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package composed contains an unstructured composed resource.
|
Package composed contains an unstructured composed resource. |
|
Package composite contains an unstructured composite resource (XR).
|
Package composite contains an unstructured composite resource (XR). |