README
¶
crossplane-runtime
Overview
crossplane-runtime is a set of go libraries used to build Kubernetes controllers in Crossplane and its related stacks. Take a look at our developer guide and API documentation for help getting started with crossplane-runtime.
Contributing
crossplane-runtime is a community driven project and we welcome contributions. See the Crossplane contributing guidelines to get started.
Report a Bug
For filing bugs, suggesting improvements, or requesting new features, please open an issue.
Contact
Please use the following to reach members of the community:
- Slack: Join our slack channel
- Forums: crossplane-dev
- Twitter: @crossplane_io
- Email: info@crossplane.io
Roadmap
crossplane-runtime goals and milestones are currently tracked in Crossplane's roadmap.
Governance and Owners
crossplane-runtime is run according to the same governance and ownership structure as the core Crossplane project.
Code of Conduct
crossplane-runtime adheres to the same code of conduct as the core Crossplane project.
Licensing
crossplane-runtime is under the Apache 2.0 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
common/v1
Package v1 contains core API types used by most Crossplane resources.
|
Package v1 contains core API types used by most Crossplane resources. |
|
pkg
|
|
|
certificates
Package certificates loads TLS certificates from a given folder.
|
Package certificates loads TLS certificates from a given folder. |
|
connection
Package connection provides utilities for working with connection details.
|
Package connection provides utilities for working with connection details. |
|
connection/fake
Package fake implements a fake secret store.
|
Package fake implements a fake secret store. |
|
connection/store
Package store implements secret stores.
|
Package store implements secret stores. |
|
connection/store/kubernetes
Package kubernetes implements a secret store backed by Kubernetes Secrets.
|
Package kubernetes implements a secret store backed by Kubernetes Secrets. |
|
connection/store/plugin
Package plugin implements a gRPC client for external secret store plugins.
|
Package plugin implements a gRPC client for external secret store plugins. |
|
connection/store/plugin/fake
Package fake is a fake ExternalSecretStorePluginServiceClient.
|
Package fake is a fake ExternalSecretStorePluginServiceClient. |
|
controller
Package controller configures controller options.
|
Package controller configures controller options. |
|
errors
Package errors is a github.com/pkg/errors compatible API for native errors.
|
Package errors is a github.com/pkg/errors compatible API for native errors. |
|
event
Package event records Kubernetes events.
|
Package event records Kubernetes events. |
|
feature
Package feature contains utilities for managing Crossplane features.
|
Package feature contains utilities for managing Crossplane features. |
|
fieldpath
Package fieldpath provides utilities for working with field paths.
|
Package fieldpath provides utilities for working with field paths. |
|
logging
Package logging provides Crossplane's recommended logging interface.
|
Package logging provides Crossplane's recommended logging interface. |
|
meta
Package meta contains functions for dealing with Kubernetes object metadata.
|
Package meta contains functions for dealing with Kubernetes object metadata. |
|
parser
Package parser implements a parser for Crossplane packages.
|
Package parser implements a parser for Crossplane packages. |
|
password
Package password contains a simple password generator.
|
Package password contains a simple password generator. |
|
ratelimiter
Package ratelimiter contains suggested default ratelimiters for Crossplane.
|
Package ratelimiter contains suggested default ratelimiters for Crossplane. |
|
reconciler
Package reconciler provides reconcilers for Crossplane resources.
|
Package reconciler provides reconcilers for Crossplane resources. |
|
reconciler/managed
Package managed provides a reconciler that manages the lifecycle of a resource in an external system.
|
Package managed provides a reconciler that manages the lifecycle of a resource in an external system. |
|
reconciler/providerconfig
Package providerconfig provides a reconciler that manages the lifecycle of a ProviderConfig.
|
Package providerconfig provides a reconciler that manages the lifecycle of a ProviderConfig. |
|
reference
Package reference contains utilities for working with cross-resource references.
|
Package reference contains utilities for working with cross-resource references. |
|
resource
Package resource provides types and functions that can be used to build Kubernetes controllers that reconcile Crossplane resources.
|
Package resource provides types and functions that can be used to build Kubernetes controllers that reconcile Crossplane resources. |
|
resource/fake
Package fake provides fake Crossplane resources for use in tests.
|
Package fake provides fake Crossplane resources for use in tests. |
|
resource/unstructured
Package unstructured contains utilities unstructured Kubernetes objects.
|
Package unstructured contains utilities unstructured Kubernetes objects. |
|
resource/unstructured/claim
Package claim contains an unstructured composite resource claim.
|
Package claim contains an unstructured composite resource claim. |
|
resource/unstructured/composed
Package composed contains an unstructured composed resource.
|
Package composed contains an unstructured composed resource. |
|
resource/unstructured/composite
Package composite contains an unstructured composite resource.
|
Package composite contains an unstructured composite resource. |
|
resource/unstructured/reference
Package reference contains references to resources.
|
Package reference contains references to resources. |
|
statemetrics
Package statemetrics contains utilities for recording Crossplane resource state metrics.
|
Package statemetrics contains utilities for recording Crossplane resource state metrics. |
|
test
Package test implements utilities that can be used to test Kubernetes controllers that reconcile Crossplane resources.
|
Package test implements utilities that can be used to test Kubernetes controllers that reconcile Crossplane resources. |
|
webhook
Package webhook contains utilities for building Kubernetes webhooks.
|
Package webhook contains utilities for building Kubernetes webhooks. |
Click to show internal directories.
Click to hide internal directories.