Documentation
¶
Index ¶
- Constants
- Variables
- func AwsIamRoleAnnotation(iamRole apis.ARN) resource.ServiceAccountOption
- func NewConditionSet(cts ...apis.ConditionType) apis.ConditionSet
- type AWSAuth
- type AWSEndpoint
- type AWSSecurityCredentials
- type AdapterOverrides
- type CloudEventStatus
- type GroupObject
- type Status
- type StatusManager
- type ValueFromField
Constants ¶
const ( // ConditionReady has status True when the component is ready to receive/send events. ConditionReady = apis.ConditionReady // ConditionSinkProvided has status True when the component has been configured with an event sink. ConditionSinkProvided apis.ConditionType = "SinkProvided" // ConditionDeployed has status True when the component's adapter is up and running. ConditionDeployed apis.ConditionType = "Deployed" )
Status conditions
const ( // ReasonRBACNotBound is set on a Deployed condition when an adapter's // ServiceAccount cannot be bound. ReasonRBACNotBound = "RBACNotBound" ReasonUnavailable = "AdapterUnavailable" // ReasonSinkNotFound is set on a SinkProvided condition when a sink does not exist. ReasonSinkNotFound = "SinkNotFound" // ReasonSinkEmpty is set on a SinkProvided condition when a sink URI is empty. ReasonSinkEmpty = "EmptySinkURI" )
Reasons for status conditions
Variables ¶
var DefaultConditionSet = NewConditionSet()
DefaultConditionSet is a generic set of status conditions used by default in all components.
var EventSenderConditionSet = NewConditionSet( ConditionSinkProvided, )
EventSenderConditionSet is a set of conditions for instances that send events to a sink.
Functions ¶
func AwsIamRoleAnnotation ¶
func AwsIamRoleAnnotation(iamRole apis.ARN) resource.ServiceAccountOption
AwsIamRoleAnnotation returns a functional option that sets the EKS role-arn annotation on a ServiceAccount.
func NewConditionSet ¶
func NewConditionSet(cts ...apis.ConditionType) apis.ConditionSet
NewConditionSet returns a set of status conditions for a component type. Default conditions can be augmented by passing condition types as function arguments.
Types ¶
type AWSAuth ¶
type AWSAuth struct {
// Security credentials allow AWS to authenticate and authorize
// requests based on a signature composed of an access key ID and a
// corresponding secret access key.
// See https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html
// +optional
Credentials *AWSSecurityCredentials `json:"credentials,omitempty"`
// (Amazon EKS only) The ARN of an IAM role which can be impersonated
// to obtain AWS permissions.
// See https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html
// +optional
EksIAMRole *apis.ARN `json:"iamRole,omitempty"`
}
AWSAuth contains multiple authentication methods for AWS services.
+k8s:deepcopy-gen=true
type AWSEndpoint ¶
AWSEndpoint contains parameters which are used to override the destination of REST API calls to AWS services. It allows, for example, to target API-compatible alternatives to the public AWS cloud (Localstack, Minio, ElasticMQ, ...).
+k8s:deepcopy-gen=true
type AWSSecurityCredentials ¶
type AWSSecurityCredentials struct {
AccessKeyID ValueFromField `json:"accessKeyID"`
SecretAccessKey ValueFromField `json:"secretAccessKey"`
}
AWSSecurityCredentials represents a set of AWS security credentials.
+k8s:deepcopy-gen=true
type AdapterOverrides ¶
type AdapterOverrides struct {
// Public value indicates if the adapter backed by a Kn Service should have
// its network visibility scope set to public. Default scope is cluster-local.
Public *bool `json:"public,omitempty"`
// Resources limits and requirements applied on adapter container.
Resources *corev1.ResourceRequirements `json:"resources,omitempty"`
// Pod tolerations.
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
// NodeSelector to control which nodes the pod can be scheduled on.
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
// Pod affinity.
Affinity *corev1.Affinity `json:"affinity,omitempty"`
// Environment variables applied on adapter container.
Env []corev1.EnvVar `json:"env,omitempty"`
// Labels applied on adapter container.
Labels map[string]string `json:"labels,omitempty"`
}
AdapterOverrides are applied on top of the default adapter parameters.
+k8s:deepcopy-gen=true
type CloudEventStatus ¶
type CloudEventStatus struct {
// AcceptedEventTypes are the CloudEvent types that a component can process.
// +optional
AcceptedEventTypes []string `json:"acceptedEventTypes,omitempty"`
}
CloudEventStatus contains attributes that event receivers can embed to declare the event types they accept.
+k8s:deepcopy-gen=true
type Status ¶
type Status struct {
duckv1.SourceStatus `json:",inline"`
duckv1.AddressStatus `json:",inline"`
// Accepted CloudEvent attributes
CloudEventStatus `json:",inline"`
}
Status defines the observed state of a component instance.
+k8s:deepcopy-gen=true
type StatusManager ¶
type StatusManager struct {
apis.ConditionSet
*Status
}
StatusManager manages the status of a TriggerMesh component.
type ValueFromField ¶
type ValueFromField struct {
// Field value.
// +optional
Value string `json:"value,omitempty"`
// Field value from a Kubernetes Secret.
// +optional
ValueFromSecret *corev1.SecretKeySelector `json:"valueFromSecret,omitempty"`
}
ValueFromField is a struct field that can have its value either defined explicitly or sourced from another entity.
+k8s:deepcopy-gen=true
Source Files