Knative Eventing Sources

Packages:

sources.eventing.knative.dev

Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group

Resource Types:

ContainerSource

ContainerSource is the Schema for the containersources API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
ContainerSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ContainerSourceSpec


image
string

Image is the image to run inside of the container.

args
[]string

Args are passed to the ContainerSpec as they are.

env
[]Kubernetes core/v1.EnvVar
(Optional)

Env is the list of environment variables to set in the container. Cannot be updated.

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

status
ContainerSourceStatus

GcpPubSubSource

GcpPubSubSource is the Schema for the gcppubsubsources API.

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
GcpPubSubSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GcpPubSubSourceSpec


gcpCredsSecret
Kubernetes core/v1.SecretKeySelector

GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used to create or delete the Subscription, only to poll it. The value of the secret entry must be a service account key in the JSON format (see https://cloud.google.com/iam/docs/creating-managing-service-account-keys).

googleCloudProject
string

GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.

topic
string

Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not ‘projects/my-gcp-project/topics/laconia’.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

status
GcpPubSubSourceStatus

GitHubSource

GitHubSource is the Schema for the githubsources API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
GitHubSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GitHubSourceSpec


serviceAccountName
string
(Optional)

ServiceAccountName holds the name of the Kubernetes service account as which the underlying K8s resources should be run. If unspecified this will default to the “default” service account for the namespace in which the GitHubSource exists.

ownerAndRepository
string

OwnerAndRepository is the GitHub owner/org and repository to receive events from. The repository may be left off to receive events from an entire organization. Examples: myuser/project myorganization

eventTypes
[]string

EventType is the type of event to receive from GitHub. These correspond to the “Webhook event name” values listed at https://developer.github.com/v3/activity/events/types/ - ie “pull_request”

accessToken
SecretValueFromSource

AccessToken is the Kubernetes secret containing the GitHub access token

secretToken
SecretValueFromSource

SecretToken is the Kubernetes secret containing the GitHub secret token

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

status
GitHubSourceStatus

KubernetesEventSource

KubernetesEventSource is the Schema for the kuberneteseventsources API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
KubernetesEventSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
KubernetesEventSourceSpec


namespace
string

Namespace that we watch kubernetes events in.

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

status
KubernetesEventSourceStatus

ContainerSourceSpec

(Appears on: ContainerSource)

ContainerSourceSpec defines the desired state of ContainerSource

Field Description
image
string

Image is the image to run inside of the container.

args
[]string

Args are passed to the ContainerSpec as they are.

env
[]Kubernetes core/v1.EnvVar
(Optional)

Env is the list of environment variables to set in the container. Cannot be updated.

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

ContainerSourceStatus

(Appears on: ContainerSource)

ContainerSourceStatus defines the observed state of ContainerSource

Field Description
conditions
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
(Optional)

Conditions holds the state of a source at a point in time.

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the ContainerSource.

GcpPubSubSourceSpec

(Appears on: GcpPubSubSource)

GcpPubSubSourceSpec defines the desired state of the GcpPubSubSource.

Field Description
gcpCredsSecret
Kubernetes core/v1.SecretKeySelector

GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used to create or delete the Subscription, only to poll it. The value of the secret entry must be a service account key in the JSON format (see https://cloud.google.com/iam/docs/creating-managing-service-account-keys).

googleCloudProject
string

GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.

topic
string

Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not ‘projects/my-gcp-project/topics/laconia’.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

GcpPubSubSourceStatus

(Appears on: GcpPubSubSource)

GcpPubSubSourceStatus defines the observed state of GcpPubSubSource.

Field Description
conditions
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
(Optional)

Conditions holds the state of a source at a point in time.

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the GcpPubSubSource.

GitHubSourceSpec

(Appears on: GitHubSource)

GitHubSourceSpec defines the desired state of GitHubSource

Field Description
serviceAccountName
string
(Optional)

ServiceAccountName holds the name of the Kubernetes service account as which the underlying K8s resources should be run. If unspecified this will default to the “default” service account for the namespace in which the GitHubSource exists.

ownerAndRepository
string

OwnerAndRepository is the GitHub owner/org and repository to receive events from. The repository may be left off to receive events from an entire organization. Examples: myuser/project myorganization

eventTypes
[]string

EventType is the type of event to receive from GitHub. These correspond to the “Webhook event name” values listed at https://developer.github.com/v3/activity/events/types/ - ie “pull_request”

accessToken
SecretValueFromSource

AccessToken is the Kubernetes secret containing the GitHub access token

secretToken
SecretValueFromSource

SecretToken is the Kubernetes secret containing the GitHub secret token

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

GitHubSourceStatus

(Appears on: GitHubSource)

GitHubSourceStatus defines the observed state of GitHubSource

Field Description
conditions
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
(Optional)

Conditions holds the state of a source at a point in time.

webhookIDKey
string

WebhookIDKey is the ID of the webhook registered with GitHub

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the GitHubSource.

KubernetesEventSourceSpec

(Appears on: KubernetesEventSource)

KubernetesEventSourceSpec defines the desired state of the source.

Field Description
namespace
string

Namespace that we watch kubernetes events in.

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

KubernetesEventSourceStatus

(Appears on: KubernetesEventSource)

KubernetesEventSourceStatus defines the observed state of the source.

Field Description
conditions
github.com/knative/pkg/apis/duck/v1alpha1.Conditions
(Optional)

Conditions holds the state of a source at a point in time.

sinkUri
string
(Optional)

SinkURI is the current active sink URI that has been configured for the source.

SecretValueFromSource

(Appears on: GitHubSourceSpec)

SecretValueFromSource represents the source of a secret value

Field Description
secretKeyRef
Kubernetes core/v1.SecretKeySelector

The Secret key to select from.


Generated with gen-crd-api-reference-docs on git commit 9741f15.

Last modified 01.01.0001