resources

package
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 3, 2024 License: MIT Imports: 22 Imported by: 10

Documentation

Index

Constants

View Source 
const (
	MutatingWebhookConfigurationKind    = "MutatingWebhookConfiguration"
	MutatingWebhookConfigurationVersion = "admissionregistration.k8s.io/v1"

	ValidatingWebhookConfigurationKind    = "ValidatingWebhookConfiguration"
	ValidatingWebhookConfigurationVersion = "admissionregistration.k8s.io/v1"
)
View Source 
const (
	IssuerKind        = cmv1.IssuerKind
	ClusterIssuerKind = cmv1.ClusterIssuerKind
	CertificateKind   = cmv1.CertificateKind
)
View Source 
const (
	ConfigMapKind    = "ConfigMap"
	ConfigMapVersion = "v1"
)
View Source 
const (
	CustomResourceDefinitionKind    = "CustomResourceDefinition"
	CustomResourceDefinitionVersion = "apiextensions.k8s.io/v1"
)
View Source 
const (
	DaemonSetKind    = "DaemonSet"
	DaemonSetVersion = "apps/v1"
)
View Source 
const (
	DeploymentKind    = "Deployment"
	DeploymentVersion = "apps/v1"
)
View Source 
const (
	EndpointsKind    = "Endpoints"
	EndpointsVersion = "v1"
)
View Source 
const (
	JobKind    = "Job"
	JobVersion = "batch/v1"
)
View Source 
const (
	NamespaceKind    = "Namespace"
	NamespaceVersion = "v1"
)
View Source 
const (
	SecretKind    = "Secret"
	SecretVersion = "v1"
)
View Source 
const (
	ServiceKind    = "Service"
	ServiceVersion = "v1"
)
View Source 
const (
	StatefulSetKind    = "StatefulSet"
	StatefulSetVersion = "apps/v1"
)
View Source 
const (
	ReadyPathAnnotation  = "operator-builder.nukleros.io/ready-path"
	ReadyValueAnnotation = "operator-builder.nukleros.io/ready-value"
)

Variables

This section is empty.

Functions

func AreDesired added in v0.3.0 

func AreDesired(desiredObject, actualObject client.Object) (bool, error)

AreDesired determines if an actual resource is in a desired state based on the state of a desired resource.

func AreEqual 

func AreEqual(desired, actual client.Object) (bool, error)

AreEqual determines if two resources are equal.

func AreReady 

func AreReady(resources ...client.Object) (bool, error)

AreReady returns whether resources are ready. All resources must be ready in order to satisfy the requirement that resources are ready.

func Create 

func Create(r workload.Reconciler, req *workload.Request, resource client.Object) error

Create creates a resource.

func EqualGVK 

func EqualGVK(left, right client.Object) bool

EqualGVK will compare the GVK of two resource objects for equality.

func EqualNamespaceName 

func EqualNamespaceName(left, right client.Object) bool

EqualNamespaceName will compare the namespace and name of two resource objects for equality.

func Get 

func Get(r workload.Reconciler, req *workload.Request, resource client.Object) (client.Object, error)

Get gets a resource.

func IsReady 

func IsReady(resource client.Object) (bool, error)

IsReady returns whether a specific known resource is ready. Always returns true for unknown resources so that dependency checks will not fail and reconciliation of resources can happen with errors rather than stopping entirely.

func IsReadyFromReconciler added in v0.5.0 

func IsReadyFromReconciler(r workload.Reconciler, req *workload.Request, resource client.Object) (bool, error)

IsReadyFromReconciler returns whether a specific known resource is ready. Always returns true for unknown resources so that dependency checks will not fail and reconciliation of resources can happen with errors rather than stopping entirely. It takes in a client object and does the get on behalf of the caller.

func MessageFor added in v0.6.0 

func MessageFor(resource client.Object) []any

MessageFor returns a CRUD message for a particular resource. It sets an even number of key/value pairs that are intended to be passed into the reconciler.GetLogger methods.

func NamespaceForResourceIsReady 

func NamespaceForResourceIsReady(r workload.Reconciler, req *workload.Request, resource client.Object) (bool, error)

NamespaceForResourceIsReady will check to see if the Namespace of a metadata.namespace field of a resource is ready.

func NeedsUpdate 

func NeedsUpdate(r workload.Reconciler, desired, actual client.Object) (bool, error)

NeedsUpdate determines if a resource needs to be updated.

func ToTyped 

func ToTyped(destination, source client.Object) error

ToTyped returns the proper object representation of a resource.

func ToUnstructured 

func ToUnstructured(resource client.Object) (*unstructured.Unstructured, error)

ToUnstructured returns an unstructured representation of a resource.

func Update 

func Update(r workload.Reconciler, req *workload.Request, newResource, oldResource client.Object) error

Update updates a resource.

Types

type CRDResource 

type CRDResource struct {
	Object extensionsv1.CustomResourceDefinition
}

CRDResource represents a Kubernetes CustomResourceDefinition object.

func NewCRDResource 

func NewCRDResource(object client.Object) (*CRDResource, error)

NewCRDResource creates and returns a new CRDResource.

func (*CRDResource) IsReady 

func (crd *CRDResource) IsReady() (bool, error)

IsReady performs the logic to determine if a CRD is ready.

type CertificateResource added in v0.5.0 

type CertificateResource struct {
	Object cmv1.Certificate
}

CertificateResource represents a cert-manager Certificate object.

func NewCertificateResource added in v0.5.0 

func NewCertificateResource(object client.Object) (*CertificateResource, error)

NewCertificateResource creates and returns a new CertificateResource.

func (*CertificateResource) IsReady added in v0.5.0 

func (cert *CertificateResource) IsReady() (bool, error)

IsReady checks to see if an Certificate is ready.

type ClusterIssuerResource added in v0.5.0 

type ClusterIssuerResource struct {
	Object cmv1.ClusterIssuer
}

ClusterIssuerResource represents a cert-manager ClusterIssuer object.

func NewClusterIssuerResource added in v0.5.0 

func NewClusterIssuerResource(object client.Object) (*ClusterIssuerResource, error)

NewClusterIssuerResource creates and returns a new ClusterIssuerResource.

func (*ClusterIssuerResource) IsReady added in v0.5.0 

func (clusterIssuer *ClusterIssuerResource) IsReady() (bool, error)

IsReady checks to see if an Issuer is ready.

type ConfigMapResource 

type ConfigMapResource struct {
	Object v1.ConfigMap
}

ConfigMapResource represents a Kubernetes ConfigMap object.

func NewConfigMapResource 

func NewConfigMapResource(object client.Object) (*ConfigMapResource, error)

NewConfigMapResource creates and returns a new ConfigMapResource.

func (*ConfigMapResource) IsReady 

func (configMap *ConfigMapResource) IsReady() (bool, error)

IsReady performs the logic to determine if a ConfigMap is ready.

type DaemonSetResource 

type DaemonSetResource struct {
	Object appsv1.DaemonSet
}

DaemonSetResource represents a Kubernetes DaemonSet object.

func NewDaemonSetResource 

func NewDaemonSetResource(object client.Object) (*DaemonSetResource, error)

NewDaemonSetResource creates and returns a new DaemonSetResource.

func (*DaemonSetResource) IsReady 

func (daemonSet *DaemonSetResource) IsReady() (bool, error)

IsReady checks to see if a DaemonSet is ready.

type DeploymentResource 

type DeploymentResource struct {
	Object appsv1.Deployment
}

DeploymentResource represents a Kubernetes Deployment object.

func NewDeploymentResource 

func NewDeploymentResource(object client.Object) (*DeploymentResource, error)

NewDeploymentResource creates and returns a new DeploymentResource.

func (*DeploymentResource) IsReady 

func (deployment *DeploymentResource) IsReady() (bool, error)

IsReady performs the logic to determine if a Deployment is ready.

type EndpointsResource added in v0.5.0 

type EndpointsResource struct {
	Object corev1.Endpoints
}

func NewEndpointsResource added in v0.5.0 

func NewEndpointsResource(object client.Object) (*EndpointsResource, error)

NewEndpointsResource creates and returns a new EndpointResource.

func (*EndpointsResource) IsReady added in v0.5.0 

func (endpoints *EndpointsResource) IsReady() (bool, error)

IsReady performs the logic to determine if an Endpoints resource is ready.

type IssuerResource added in v0.5.0 

type IssuerResource struct {
	Object cmv1.Issuer
}

IssuerResource represents a cert-manager Issuer object.

func NewIssuerResource added in v0.5.0 

func NewIssuerResource(object client.Object) (*IssuerResource, error)

NewIssuerResource creates and returns a new IssuerResource.

func (*IssuerResource) IsReady added in v0.5.0 

func (issuer *IssuerResource) IsReady() (bool, error)

IsReady checks to see if an Issuer is ready.

type JobResource 

type JobResource struct {
	Object batchv1.Job
}

JobResource represents a Kubernetes Job object.

func NewJobResource 

func NewJobResource(object client.Object) (*JobResource, error)

NewJobResource creates and returns a new JobResource.

func (*JobResource) IsReady 

func (job *JobResource) IsReady() (bool, error)

IsReady checks to see if a Job is ready.

type MutatingWebhookConfigurationResource added in v0.5.0 

type MutatingWebhookConfigurationResource struct {
	Object     admissionv1.MutatingWebhookConfiguration
	Reconciler workload.Reconciler
	Request    *workload.Request
}

MutatingWebhookConfigurationResource represents a Kubernetes MutatingWebhookConfiguration object.

func NewMutatingWebhookConfigurationResource added in v0.5.0 

func NewMutatingWebhookConfigurationResource(
	r workload.Reconciler,
	req *workload.Request,
	object client.Object,
) (*MutatingWebhookConfigurationResource, error)

NewMutatingWebhookConfigurationResource creates and returns a new MutatingWebhookConfigurationResource.

func (*MutatingWebhookConfigurationResource) GetServiceStubs added in v0.5.0 

func (webhook *MutatingWebhookConfigurationResource) GetServiceStubs() []v1.Service

GetServiceStubs gets the service stubs objects from a MutatingWebhookConfigurationResource. The stubs are used to lookup the underlying services associated with the webhook.

func (*MutatingWebhookConfigurationResource) IsReady added in v0.5.0 

func (webhook *MutatingWebhookConfigurationResource) IsReady() (bool, error)

IsReady performs the logic to determine if a MutatingWebhookConfiguration is ready.

type NamespaceResource 

type NamespaceResource struct {
	Object v1.Namespace
}

NamespaceResource represents a Kubernetes Namespace object.

func NewNamespaceResource 

func NewNamespaceResource(object client.Object) (*NamespaceResource, error)

NewNamespaceResource creates and returns a new NamespaceResource.

func (*NamespaceResource) IsReady 

func (namespace *NamespaceResource) IsReady() (bool, error)

IsReady defines the criteria for a Namespace to be condsidered ready.

type SecretResource 

type SecretResource struct {
	Object v1.Secret
}

SecretResource represents a Kubernetes Secret object.

func NewSecretResource 

func NewSecretResource(object client.Object) (*SecretResource, error)

NewSecretResource creates and returns a new SecretResource.

func (*SecretResource) IsReady 

func (secret *SecretResource) IsReady() (bool, error)

IsReady checks to see if a Secret is ready.

type ServiceResource 

type ServiceResource struct {
	Object v1.Service
}

ServiceResource represents a Kubernetes Service object.

func NewServiceResource 

func NewServiceResource(object client.Object) (*ServiceResource, error)

NewServiceResource creates and returns a new ServiceResource.

func (*ServiceResource) GetEndpoints added in v0.5.0 

func (service *ServiceResource) GetEndpoints(r workload.Reconciler, req *workload.Request) (*EndpointsResource, error)

GetEndpoints retrieves the endpoints from a service.

func (*ServiceResource) IsReady 

func (service *ServiceResource) IsReady() (bool, error)

IsReady checks to see if a Service is ready.

type ServiceStubRetriever added in v0.5.0 

type ServiceStubRetriever interface {
	GetServiceStubs() []v1.Service
}

ServiceStubRetriever represents an object that retrieves service stubs (stubs include a name and namespace) or any service that is good enough to use as a lookup.

type StatefulSetResource 

type StatefulSetResource struct {
	Object appsv1.StatefulSet
}

StatefulSetResource represents a Kubernetes StatefulSet object.

func NewStatefulSetResource 

func NewStatefulSetResource(object client.Object) (*StatefulSetResource, error)

NewStatefulSetResource creates and returns a new StatefulSetResource.

func (*StatefulSetResource) IsReady 

func (statefulSet *StatefulSetResource) IsReady() (bool, error)

IsReady performs the logic to determine if a StatefulSet is ready.

type UnknownResource 

type UnknownResource struct {
	Object client.Object
}

UnknownResource represents an unknown object.

func NewUnknownResource 

func NewUnknownResource(object client.Object) (*UnknownResource, error)

NewUnknownResource creates and returns a new UnknownResource.

func (*UnknownResource) IsReady 

func (unknown *UnknownResource) IsReady() (bool, error)

IsReady performs the logic to determine if an Unknown resource is ready. It allows functionality that will read a set of annotations that take in a field (in JSONpath format) and a value. If the specific field is equal to that value, then the resource is considered to be ready.

type ValidatingWebhookConfigurationResource added in v0.5.0 

type ValidatingWebhookConfigurationResource struct {
	Object     admissionv1.ValidatingWebhookConfiguration
	Reconciler workload.Reconciler
	Request    *workload.Request
}

ValidatingWebhookConfigurationResource represents a Kubernetes ValidatingWebhookConfiguration object.

func NewValidatingWebhookConfigurationResource added in v0.5.0 

func NewValidatingWebhookConfigurationResource(
	r workload.Reconciler,
	req *workload.Request,
	object client.Object,
) (*ValidatingWebhookConfigurationResource, error)

NewMValidatingWebhookConfigurationResource creates and returns a new ValidatingWebhookConfigurationResource.

func (*ValidatingWebhookConfigurationResource) GetServiceStubs added in v0.5.0 

func (webhook *ValidatingWebhookConfigurationResource) GetServiceStubs() []v1.Service

GetServiceStubs gets the service stubs objects from a ValidatingWebhookConfigurationResource. The stubs are used to lookup the underlying services associated with the webhook.

func (*ValidatingWebhookConfigurationResource) IsReady added in v0.5.0 

func (webhook *ValidatingWebhookConfigurationResource) IsReady() (bool, error)

IsReady performs the logic to determine if a MutatingWebhookConfiguration is ready.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.