README
¶
katanomi common packages 📦
All shared common packages and code across katanomi repos
- apis: common types and functions for type definitions
- apis/meta: objects, definitions and functions shared across projects (versioned)
- apis/validation: common validation methods
- client: client related functions
- controllers: controller methods and objects
- errors: common error functions
- examples: examples of how to utilize this repo methods/objects
- hack: basic repo hacking files (not a package)
- logging: logging related
- manager: controller-runtime manager methods
- multicluster: shared multicluster interfaces and implementations for client, etc.
- names: name generation releated methods (k8s.io/apiserver inspired)
- namespace: namespace releated methods
- parallel: parallel task execution implementation
- plugin: plugin system files and subpackages
- restclient: RESTful client methods
- scheme: scheme related methods
- sharedmain: common main functions to init components
- testing: automated test related methods
- testing/framework: automated test framework for e2e and integration testing
- user: user matching releated functions
- webhook: custom webhook methods to extend current controller-runtime webhooks
TODO
- [ ]: implement custom validation webhook methods
- [ ]: add more unit tests
- [ ]: add requirements to testing/framework to automatically enable/disable tests based on setup
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
data/v1alpha1
Package v1alpha1 contains API Schema definitions for the types v1alpha1 API group this group is a duck type only package that hosts common objects and interfaces in katanomi very similar to knative.dev/pkg/apis/duck/v1 or k8s.io/apimachinery/pkg/apis/meta/v1 +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=data.katanomi.dev
|
Package v1alpha1 contains API Schema definitions for the types v1alpha1 API group this group is a duck type only package that hosts common objects and interfaces in katanomi very similar to knative.dev/pkg/apis/duck/v1 or k8s.io/apimachinery/pkg/apis/meta/v1 +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=data.katanomi.dev |
|
meta/v1alpha1
Package v1alpha1 contains API Schema definitions for the types v1alpha1 API group this group is a duck type only package that hosts common objects and interfaces in katanomi very similar to knative.dev/pkg/apis/duck/v1 or k8s.io/apimachinery/pkg/apis/meta/v1 +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=meta.katanomi.dev
|
Package v1alpha1 contains API Schema definitions for the types v1alpha1 API group this group is a duck type only package that hosts common objects and interfaces in katanomi very similar to knative.dev/pkg/apis/duck/v1 or k8s.io/apimachinery/pkg/apis/meta/v1 +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=meta.katanomi.dev |
|
examples
|
|
|
sample-api
command
|
|
|
sample-controller
command
|
|
|
sample-controller/apis/test/v1alpha1
Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group +kubebuilder:object:generate=true +groupName=test.katanomi.dev
|
Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group +kubebuilder:object:generate=true +groupName=test.katanomi.dev |
|
sample-plugin
command
|
|
|
mock/github.com/katanomi/pkg/apis/meta/v1alpha1
Package apis is a generated GoMock package.
|
Package apis is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/multicluster
Package multicluster is a generated GoMock package.
|
Package multicluster is a generated GoMock package. |
|
mock/knative.dev/pkg/apis
Package apis is a generated GoMock package.
|
Package apis is a generated GoMock package. |
|
mock/sigs.k8s.io/controller-runtime/pkg/manager
Package manager is a generated GoMock package.
|
Package manager is a generated GoMock package. |
|
user
|
|
|
webhook
|
|
Click to show internal directories.
Click to hide internal directories.