README
¶
appresource
Package appresource implements a generic operatorkit resource for managing app custom resources. The custom resources are managed by app-operator which installs applications packaged as Helm charts into Kubernetes clusters.
Example custom resource
The app custom resources look something like this.
apiVersion: application.giantswarm.io/v1alpha1
kind: App
metadata:
name: "prometheus"
labels:
app-operator.giantswarm.io/version: "1.0.0"
spec:
catalog: "giantswarm"
name: "kube-state-metrics"
namespace: "kube-system"
version: "0.4.0"
config:
configMap:
name: "eggs2-cluster-values"
namespace: "eggs2"
kubeConfig:
context:
name: "eggs2"
secret:
name: "eggs2-kubeconfig"
namespace: "eggs2"
status:
appVersion: "1.7.2"
release:
lastDeployed: "2019-11-30T21:06:20Z"
status: "DEPLOYED"
version: "0.4.0"
Used by
License
appresource is under the Apache 2.0 license. See the LICENSE file for details.
Documentation
¶
Index ¶
- func IsInvalidConfig(err error) bool
- func IsWrongTypeError(err error) bool
- type Config
- type Resource
- func (r *Resource) ApplyCreateChange(ctx context.Context, obj, createChange interface{}) error
- func (r *Resource) ApplyDeleteChange(ctx context.Context, obj, deleteChange interface{}) error
- func (r *Resource) ApplyUpdateChange(ctx context.Context, obj, updateChange interface{}) error
- func (r *Resource) GetCurrentState(ctx context.Context, obj interface{}) (interface{}, error)
- func (r *Resource) GetDesiredState(ctx context.Context, obj interface{}) (interface{}, error)
- func (r *Resource) Name() string
- func (r *Resource) NewDeletePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*controller.Patch, error)
- func (r *Resource) NewUpdatePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*controller.Patch, error)
- type StateGetter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsInvalidConfig ¶
IsInvalidConfig asserts invalidConfigError.
func IsWrongTypeError ¶
IsWrongTypeError asserts wrongTypeError.
Types ¶
type Config ¶
type Config struct {
G8sClient versioned.Interface
Logger micrologger.Logger
StateGetter StateGetter
Name string
}
type Resource ¶
type Resource struct {
// contains filtered or unexported fields
}
func (*Resource) ApplyCreateChange ¶
ApplyCreateChange ensures the App CR is created in the k8s api.
func (*Resource) ApplyDeleteChange ¶
func (*Resource) ApplyUpdateChange ¶
func (*Resource) GetCurrentState ¶
func (*Resource) GetDesiredState ¶
func (*Resource) NewDeletePatch ¶
func (*Resource) NewUpdatePatch ¶
type StateGetter ¶
type StateGetter interface {
// GetCurrentState returns a current state of the system for the given
// incarnation of the observed Kubernetes object. The state consists of
// multiple objects but it is fine to return a slice of single object
// if only one object is managed by this resource.
GetCurrentState(ctx context.Context, obj interface{}) ([]*v1alpha1.App, error)
// GetDesiredState returns a desired state of the system for the given
// incarnation of the observed Kubernetes object. The state consists of
// multiple objects but it is fine to return a slice of single object
// if only one object is managed by this resource.
//
// NOTE: This state may be different if the observed object is
// created/updated or deleted. Deletion timestamp can be checked to
// figure if the object is scheduled for deletion.
GetDesiredState(ctx context.Context, obj interface{}) ([]*v1alpha1.App, error)
}
Source Files
Click to show internal directories.
Click to hide internal directories.