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
- maps: package to manipulate maps with sortingand other methods.
- 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
|
|
|
applications/v1alpha1
Package v1alpha1 stores definitions and methods to handle application definitions and methods +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=applications.pkg.katanomi.dev
|
Package v1alpha1 stores definitions and methods to handle application definitions and methods +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=applications.pkg.katanomi.dev |
|
archive/v1alpha1
Package v1alpha1 stores definitions and methods to handle archive records
|
Package v1alpha1 stores definitions and methods to handle archive records |
|
artifacts/v1alpha1
Package v1alpha1 stores definitions and methods to handle artifact definitions and methods +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=artifacts.pkg.katanomi.dev
|
Package v1alpha1 stores definitions and methods to handle artifact definitions and methods +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=artifacts.pkg.katanomi.dev |
|
codequality/v1alpha1
Package v1alpha1 stores definitions and methods to handle code quality definitions, results +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=codequality.pkg.katanomi.dev
|
Package v1alpha1 stores definitions and methods to handle code quality definitions, results +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=codequality.pkg.katanomi.dev |
|
coderepository/v1alpha1
Package v1alpha1 stores definitions and methods to handle code repositories definitions and methods
|
Package v1alpha1 stores definitions and methods to handle code repositories definitions and methods |
|
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 |
|
security/v1alpha1
Package v1alpha1 stores definitions and methods to handle security definitions, results +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=security.pkg.katanomi.dev
|
Package v1alpha1 stores definitions and methods to handle security definitions, results +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=security.pkg.katanomi.dev |
|
selection/v1alpha1
Package v1alpha1 provide functions to select resources
|
Package v1alpha1 provide functions to select resources |
|
storage/v1alpha1
Package v1alpha1 stores definitions and methods to handle storage definitions and methods +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=storage.pkg.katanomi.dev
|
Package v1alpha1 stores definitions and methods to handle storage definitions and methods +kubebuilder:object:generate=true +k8s:deepcopy-gen=package +groupName=storage.pkg.katanomi.dev |
|
template/v1alpha1
Package v1alpha1 contains useful functionality or struct for template
|
Package v1alpha1 contains useful functionality or struct for template |
|
validation
Package validation contains useful validation functions
|
Package validation contains useful validation functions |
|
Package approval contains useful functionality for approval
|
Package approval contains useful functionality for approval |
|
Package artifacts provide functions to artifacts
|
Package artifacts provide functions to artifacts |
|
Package check contains functions to check component installed.
|
Package check contains functions to check component installed. |
|
Package client contains functions to add and retrieve client from context
|
Package client contains functions to add and retrieve client from context |
|
command
|
|
|
args
Package args stores useful methods to parse and extract data from extra arguments given to cli commands
|
Package args stores useful methods to parse and extract data from extra arguments given to cli commands |
|
exec
Package exec contains an interface for executing commands, along with helpers TODO(bentheelder): add standardized timeout functionality & a default timeout so that commands cannot hang indefinitely (!)
|
Package exec contains an interface for executing commands, along with helpers TODO(bentheelder): add standardized timeout functionality & a default timeout so that commands cannot hang indefinitely (!) |
|
io
Package io some io operation functions
|
Package io some io operation functions |
|
logger
Package logger logger used by cli
|
Package logger logger used by cli |
|
options
Package options some common options for cli
|
Package options some common options for cli |
|
qualitygate
Package qualitygate helper functions for quality gate
|
Package qualitygate helper functions for quality gate |
|
root
Package root have reusable root commands for clis
|
Package root have reusable root commands for clis |
|
validators
Package validators helper functions for validate params
|
Package validators helper functions for validate params |
|
Package common useful functionality for encoding and decoding objects
|
Package common useful functionality for encoding and decoding objects |
|
Package conditioner contains conditioner related logic
|
Package conditioner contains conditioner related logic |
|
Package config stores katanomi configuration manager which watch configmap and work immediately if configmap changed
|
Package config stores katanomi configuration manager which watch configmap and work immediately if configmap changed |
|
fake
Package fake provide fake manager for config
|
Package fake provide fake manager for config |
|
Package controllers implements the lazy loader logic for Katanomi.
|
Package controllers implements the lazy loader logic for Katanomi. |
|
Package encoding provides some useful functions for encoding and decoding objects
|
Package encoding provides some useful functions for encoding and decoding objects |
|
Package errors contains useful functionality for conversion errors
|
Package errors contains useful functionality for conversion errors |
|
examples
|
|
|
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 |
|
Package finalizer provides a set of functions to manage finalizers
|
Package finalizer provides a set of functions to manage finalizers |
|
Package hash contains useful functionality for hashing.
|
Package hash contains useful functionality for hashing. |
|
Package logging contains useful functionality
|
Package logging contains useful functionality |
|
Package manager contains functions to add and retrieve manager from context
|
Package manager contains functions to add and retrieve manager from context |
|
Package maps contains methods to operate maps of all kinds
|
Package maps contains methods to operate maps of all kinds |
|
Package multicluster contains functions to add and retrieve multi cluster from context
|
Package multicluster contains functions to add and retrieve multi cluster from context |
|
Package names contains useful functionality for generating names
|
Package names contains useful functionality for generating names |
|
Package namespace contains functions to add and retrieve namespace from context
|
Package namespace contains functions to add and retrieve namespace from context |
|
Package networkutils contains functions to help with network operations
|
Package networkutils contains functions to help with network operations |
|
Package parallel used to execute tasks in parallel
|
Package parallel used to execute tasks in parallel |
|
Package patchstatus contains patch status related functions.
|
Package patchstatus contains patch status related functions. |
|
Package plugin for building and running plugin
|
Package plugin for building and running plugin |
|
client
Package client contains functions to add and retrieve auth from context
|
Package client contains functions to add and retrieve auth from context |
|
client/base
Package base contains functions to add and retrieve auth from context
|
Package base contains functions to add and retrieve auth from context |
|
client/v2
Package v2 the v2 version of plugin sdk
|
Package v2 the v2 version of plugin sdk |
|
component/metrics
Package metrics provides prometheus metrics for restful
|
Package metrics provides prometheus metrics for restful |
|
component/tracing
Package tracing contains useful functionality for tracing.
|
Package tracing contains useful functionality for tracing. |
|
path
Package path provides helper functions for handling url path
|
Package path provides helper functions for handling url path |
|
route
Package route contains useful functionality for the package route
|
Package route contains useful functionality for the package route |
|
storage
Package storage for storage plugin
|
Package storage for storage plugin |
|
storage/capabilities
Package capabilities for storage plugin capabilities
|
Package capabilities for storage plugin capabilities |
|
storage/capabilities/archive
Package archive for archive capability
|
Package archive for archive capability |
|
storage/capabilities/archive/v1alpha1
Package v1alpha1 defines versioned interfaces for archive capability
|
Package v1alpha1 defines versioned interfaces for archive capability |
|
storage/capabilities/filestore
Package filestore for file store capability
|
Package filestore for file store capability |
|
storage/capabilities/filestore/v1alpha1
Package v1alpha1 defines versioned interfaces for file-store capability
|
Package v1alpha1 defines versioned interfaces for file-store capability |
|
storage/client
Package client for storage plugin client
|
Package client for storage plugin client |
|
storage/client/versioned/archive/v1alpha1
Package v1alpha1 for archive v1alpha1 client
|
Package v1alpha1 for archive v1alpha1 client |
|
storage/client/versioned/core/v1alpha1
Package v1alpha1 for storage plugin core v1alpha1 client
|
Package v1alpha1 for storage plugin core v1alpha1 client |
|
storage/client/versioned/filestore/v1alpha1
Package v1alpha1 for file store v1alpha1 client
|
Package v1alpha1 for file store v1alpha1 client |
|
storage/core/v1alpha1
Package v1alpha1 defines versioned api server routes of core v1alpha1
|
Package v1alpha1 defines versioned api server routes of core v1alpha1 |
|
storage/route
Package route for storage plugin api server routes
|
Package route for storage plugin api server routes |
|
storage/route/archive/v1alpha1
Package v1alpha1 for archive v1alpha1 routes
|
Package v1alpha1 for archive v1alpha1 routes |
|
storage/route/core/v1alpha1
Package v1alpha1 for core v1alpha1 routes
|
Package v1alpha1 for core v1alpha1 routes |
|
storage/route/filestore/v1alpha1
Package v1alpha1 for file store v1alpha1 routes
|
Package v1alpha1 for file store v1alpha1 routes |
|
types
Package types defines the interfaces for plugin
|
Package types defines the interfaces for plugin |
|
Package pointer provides helper functions for generating pointers
|
Package pointer provides helper functions for generating pointers |
|
Package record has all client logic for recording and reporting
|
Package record has all client logic for recording and reporting |
|
Package references contains methods to manage owner references
|
Package references contains methods to manage owner references |
|
Package regex provides helper functions for regular expression search.
|
Package regex provides helper functions for regular expression search. |
|
Package registry contains functions to detect the registry scheme
|
Package registry contains functions to detect the registry scheme |
|
Package report provides handling functions for different report types
|
Package report provides handling functions for different report types |
|
Package resource provides some common operations on ResourceRequirements resources.
|
Package resource provides some common operations on ResourceRequirements resources. |
|
Package restclient contains functions to add and retrieve rest client from context
|
Package restclient contains functions to add and retrieve rest client from context |
|
Package scheme contains functions to add and retrieve scheme from context
|
Package scheme contains functions to add and retrieve scheme from context |
|
Package secret contains useful functionality for select secret
|
Package secret contains useful functionality for select secret |
|
Package sharedmain contains useful functionality for main
|
Package sharedmain contains useful functionality for main |
|
Package ssl contains operations related to SSL certificates.
|
Package ssl contains operations related to SSL certificates. |
|
storage
|
|
|
accessmode
Package accessmode contains accessMode related functions.
|
Package accessmode contains accessMode related functions. |
|
cleanup
Package cleanup for clean pvc mount for taskrun
|
Package cleanup for clean pvc mount for taskrun |
|
configmap
Package configmap contains configMap related functions.
|
Package configmap contains configMap related functions. |
|
storageclass
Package storageclass contains storageClass related functions.
|
Package storageclass contains storageClass related functions. |
|
Package substitution contains useful functionality for validating variables
|
Package substitution contains useful functionality for validating variables |
|
Package env provides functions to get the cluster name from environment
|
Package env provides functions to get the cluster name from environment |
|
Package tekton contains useful functionality for tekton resource.
|
Package tekton contains useful functionality for tekton resource. |
|
assertions
Package assertions contains all the assertions that can be used in tests for general testing.
|
Package assertions contains all the assertions that can be used in tests for general testing. |
|
framework/conformance
Package conformance is a framework for conformance test
|
Package conformance is a framework for conformance test |
|
mock
Package mock contains useful functionality for testing
|
Package mock contains useful functionality for testing |
|
mock/github.com/katanomi/pkg
Package sharedmain is a generated GoMock package.
|
Package sharedmain is a generated GoMock package. |
|
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/conditioner
Package mock is a generated GoMock package.
|
Package mock 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/github.com/katanomi/pkg/plugin/client
Package client is a generated GoMock package.
|
Package client is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/plugin/storage
Package storage is a generated GoMock package.
|
Package storage is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/plugin/storage/capabilities/archive/v1alpha1
Package v1alpha1 is a generated GoMock package.
|
Package v1alpha1 is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/plugin/storage/capabilities/filestore/v1alpha1
Package v1alpha1 is a generated GoMock package.
|
Package v1alpha1 is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/plugin/storage/client
Package v1alpha1 is a generated GoMock package.
|
Package v1alpha1 is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/plugin/storage/client/versioned/archive/v1alpha1
Package v1alpha1 is a generated GoMock package.
|
Package v1alpha1 is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/plugin/storage/client/versioned/filestore/v1alpha1
Package v1alpha1 is a generated GoMock package.
|
Package v1alpha1 is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/plugin/types
Package types is a generated GoMock package.
|
Package types is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/warnings/condition
Package warnings is a generated GoMock package.
|
Package warnings is a generated GoMock package. |
|
mock/github.com/katanomi/pkg/webhook/admission
Package admission is a generated GoMock package.
|
Package admission is a generated GoMock package. |
|
mock/github.com/minio/minio-go
Package pkg is a generated GoMock package.
|
Package pkg is a generated GoMock package. |
|
mock/k8s.io/cli-runtime/pkg/genericclioptions
Package genericclioptions is a generated GoMock package.
|
Package genericclioptions is a generated GoMock package. |
|
mock/k8s.io/client-go/kubernetes
Package kubernetes is a generated GoMock package.
|
Package kubernetes is a generated GoMock package. |
|
mock/k8s.io/client-go/tools/clientcmd
Package clientcmd is a generated GoMock package.
|
Package clientcmd 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/client
Package client is a generated GoMock package.
|
Package client 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. |
|
mock/testing/fake
Package fake is a generated GoMock package.
|
Package fake is a generated GoMock package. |
|
Package tracing contains tracing related functions.
|
Package tracing contains tracing related functions. |
|
Package url contains general processing functions for some urls.
|
Package url contains general processing functions for some urls. |
|
Package user package is to manage the context of user information
|
Package user package is to manage the context of user information |
|
matching
Package matching contains useful functionality for matching users
|
Package matching contains useful functionality for matching users |
|
Package variable package is generate variable by object.
|
Package variable package is generate variable by object. |
|
Package warnings contains useful functions to manage warnings in the status
|
Package warnings contains useful functions to manage warnings in the status |
|
condition
Package condition provides a set of utilities for managing warning conditions and emitting warning events
|
Package condition provides a set of utilities for managing warning conditions and emitting warning events |
|
Package watcher stores interface DefaultingWatcherWithOnChange
|
Package watcher stores interface DefaultingWatcherWithOnChange |
|
webhook
|
|
|
admission
Package admission contains functions to add and retrieve admission request from context
|
Package admission contains functions to add and retrieve admission request from context |
|
Package workers for job worker managed by controller-runtime manager
|
Package workers for job worker managed by controller-runtime manager |
Click to show internal directories.
Click to hide internal directories.