oam-kubernetes-runtime

module

v0.0.3 Latest Latest Go to latest Published: Jun 27, 2020 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/crossplane/oam-kubernetes-runtime

Links

Open Source Insights

README ¶

OAM Kubernetes Runtime

The OAM Kubernetes runtime project is a collection of Golang helper libraries and OAM api type definitions.

It is designed to help OAM platform builders rather than being used directly by developers or end-users. We would recommend end-users to check Crossplane official documentation instead.

In addition, we created this library with the following goals in mind

All OAM Kubernetes platform builders use and contribute to this library.
The wide adoption of this library can facilitate workload/trait interoperability among OAM Kubernetes platform builders.

Getting started

Check out DEVELOPMENT.md to see how to develop with OAM Kubernetes runtime

And a HealthScope looking like below

kubectl get healthscopes.core.oam.dev
NAME                   AGE
example-health-scope   23s

Community, discussion, contribution

You can reach the maintainers of this project at:

Slack channel: crossplane#oam

Licenses

The OAM Kubernetes runtime is released under the Apache 2.0 license.

Directories ¶

Path	Synopsis
apis Package apis contains Kubernetes API groups	Package apis contains Kubernetes API groups
core Package core contains Kubernetes API groups for core OAM resources.	Package core contains Kubernetes API groups for core OAM resources.
core/v1alpha2 Package v1alpha2 contains resources relating to the Open Application Model.	Package v1alpha2 contains resources relating to the Open Application Model.
examples
containerized-workload
pkg
controller
controller/oam
controller/oam/applicationconfiguration
oam Package oam contains core OAM types.	Package oam contains core OAM types.
oam/fake Package fake provides fake OAM resources for use in tests.	Package fake provides fake OAM resources for use in tests.
oam/util
reconciler Package reconciler provides reconcilers for OAM workloads and traits.	Package reconciler provides reconcilers for OAM workloads and traits.
reconciler/trait Package trait provides a reconciler OAM traits.	Package trait provides a reconciler OAM traits.
reconciler/workload Package workload provides a reconciler that for OAM workloads.	Package workload provides a reconciler that for OAM workloads.
scope Package scope provides functions used to modify Kubernetes objects that have been translated from OAM workloads.	Package scope provides functions used to modify Kubernetes objects that have been translated from OAM workloads.
scope/health
trait Package trait provides functions used to modify Kubernetes objects that have been translated from OAM workloads.	Package trait provides functions used to modify Kubernetes objects that have been translated from OAM workloads.
trait/manualscaler
workload Package workload provides functions used to translate OAM workload types into Kubernetes objects.	Package workload provides functions used to translate OAM workload types into Kubernetes objects.
workload/containerized
test
integration

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL