Private sources

Packages:

sources.triggermesh.io/v1alpha1

sources.triggermesh.io/v1alpha1

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

Resource Types:

AzureActivityLogsSource
AzureBlobStorageSource
AzureEventHubSource
OCIMetricsSource
SalesforceSource

AzureActivityLogsSource

AzureActivityLogsSource is the Schema for the event source.

Field Description

apiVersion
string sources.triggermesh.io/v1alpha1

kind
string AzureActivityLogsSource

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureActivityLogsSourceSpec

`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`eventHubsSASPolicyID` EventHubsSASPolicyResourceID	Resource ID of an SAS policy with Manage permissions on an Event Hubs namespace. Besides the SAS policy name itself, the resource ID contains the subscription ID, resource group name and Event Hubs namespace to uniquely identify the rule. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName} References: * https://docs.microsoft.com/en-us/rest/api/eventhub/2017-04-01/authorization%20rules%20-%20namespaces/getauthorizationrule * https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-shared-access-signature
`categories` []string	(Optional) Categories of Activity Logs to collect. All available categories are selected when this attribute is empty. https://docs.microsoft.com/en-us/azure/azure-monitor/platform/activity-log-schema#categories
`eventHubName` string	(Optional) Name of an Event Hub to send data to. When this attribute is set, an Event Hub with the given name MUST already exist within the namespace. When this attribute is not set, Azure creates an Event Hub with the name ‘insights-activity-logs’.
`auth` AzureAuth	Authentication method to interact with the Azure Monitor REST API. This event source only supports the ServicePrincipal authentication.

status
AzureActivityLogsSourceStatus

AzureBlobStorageSource

AzureBlobStorageSource is the Schema for the event source.

Field Description

apiVersion
string sources.triggermesh.io/v1alpha1

kind
string AzureBlobStorageSource

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureBlobStorageSourceSpec

`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`containerName` string	ContainerName is the name of the Blob Storage Container we plan to interface with
`accountName` string	AccountName is the account name
`accountKey` SecretValueFromSource	AccountKey is the account key

status
EventSourceStatus

AzureEventHubSource

AzureEventHubSource is the Schema for the event source.

Field Description

apiVersion
string sources.triggermesh.io/v1alpha1

kind
string AzureEventHubSource

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
AzureEventHubSourceSpec

`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`auth` AzureAuth	Authentication method to interact with the Azure Event Hubs API.
`hubNamespace` string	If we use SP account or SAS token key, we must specify which Event Hub to use
`hubName` string

status
EventSourceStatus

OCIMetricsSource

OCIMetricsSource is the schema for the event source.

Field Description

apiVersion
string sources.triggermesh.io/v1alpha1

kind
string OCIMetricsSource

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
OCIMetricsSourceSpec

`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) inherits duck/v1 SourceSpec, which currently provides: * Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. * CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.
`oracleApiPrivateKey` SecretValueFromSource	Oracle User API private key
`oracleApiPrivateKeyPassphrase` SecretValueFromSource	Oracle User API private key passphrase
`oracleApiPrivateKeyFingerprint` SecretValueFromSource	Oracle User API cert fingerprint
`oracleTenancy` string	Oracle Tenancy OCID
`oracleUser` string	Oracle User OCID associated with the API key
`oracleRegion` string	Oracle Cloud Region
`metricsPollingFrequency` string	OCI Metrics Polling Frequency
`metricsNamespace` string	Namespace for the query metric to use
`metricsQuery` string	OCI Metrics Query See https://docs.cloud.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/MetricData

status
EventSourceStatus

SalesforceSource

SalesforceSource is the Schema for the event source.

Field Description

apiVersion
string sources.triggermesh.io/v1alpha1

kind
string SalesforceSource

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
SalesforceSourceSpec

`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`auth` SalesforceAuth	Authentication method to interact with the Salesforce API.
`apiVersion` string	(Optional) APIVersion at Salesforce.
`subscription` SalesforceSubscription	Subscription to a Salesforce channel

status
EventSourceStatus

AzureActivityLogsSourceSpec

(Appears on: AzureActivityLogsSource)

AzureActivityLogsSourceSpec defines the desired state of the event source.

Field	Description
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`eventHubsSASPolicyID` EventHubsSASPolicyResourceID	Resource ID of an SAS policy with Manage permissions on an Event Hubs namespace. Besides the SAS policy name itself, the resource ID contains the subscription ID, resource group name and Event Hubs namespace to uniquely identify the rule. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName} References: * https://docs.microsoft.com/en-us/rest/api/eventhub/2017-04-01/authorization%20rules%20-%20namespaces/getauthorizationrule * https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-shared-access-signature
`categories` []string	(Optional) Categories of Activity Logs to collect. All available categories are selected when this attribute is empty. https://docs.microsoft.com/en-us/azure/azure-monitor/platform/activity-log-schema#categories
`eventHubName` string	(Optional) Name of an Event Hub to send data to. When this attribute is set, an Event Hub with the given name MUST already exist within the namespace. When this attribute is not set, Azure creates an Event Hub with the name ‘insights-activity-logs’.
`auth` AzureAuth	Authentication method to interact with the Azure Monitor REST API. This event source only supports the ServicePrincipal authentication.

AzureActivityLogsSourceStatus

(Appears on: AzureActivityLogsSource)

AzureActivityLogsSourceStatus defines the observed state of the event source.

Field	Description
`EventSourceStatus` EventSourceStatus	(Members of `EventSourceStatus` are embedded into this type.)

AzureAuth

(Appears on: AzureActivityLogsSourceSpec, AzureEventHubSourceSpec)

AzureAuth contains multiple authentication methods for Azure services.

Field	Description
`sasToken` AzureSASToken	SASToken contains either Azure Connection string or a key-value pair required to produce an access token. See https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview
`servicePrincipal` AzureServicePrincipal	Service principals provide a way to create a non-interactive account associated with your identity to which you grant only the privileges your app needs to run. See https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals

AzureBlobStorageSourceSpec

(Appears on: AzureBlobStorageSource)

AzureBlobStorageSourceSpec defines the desired state of the event source.

Field	Description
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`containerName` string	ContainerName is the name of the Blob Storage Container we plan to interface with
`accountName` string	AccountName is the account name
`accountKey` SecretValueFromSource	AccountKey is the account key

AzureEventHubSourceSpec

(Appears on: AzureEventHubSource)

AzureEventHubSourceSpec defines the desired state of the event source.

Field	Description
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`auth` AzureAuth	Authentication method to interact with the Azure Event Hubs API.
`hubNamespace` string	If we use SP account or SAS token key, we must specify which Event Hub to use
`hubName` string

AzureSASToken

(Appears on: AzureAuth)

AzureSASToken represents Azure shared access signatures auth.

Field	Description
`keyName` string
`keyValue` string
`connectionString` string

AzureServicePrincipal

(Appears on: AzureAuth)

AzureServicePrincipal represents an AAD Service Principal.

Field	Description
`tenantID` ValueFromField
`clientID` ValueFromField
`clientSecret` ValueFromField

EventHubsSASPolicyResourceID

(Appears on: AzureActivityLogsSourceSpec)

EventHubsSASPolicyResourceID represents a resource ID for an Event Hubs SAS policy.

Field	Description
`SubscriptionID` string
`ResourceGroup` string
`Namespace` string
`AuthorizationRule` string

EventSource

EventSource is implemented by all event source types.

EventSourceStatus

(Appears on: AzureBlobStorageSource, AzureEventHubSource, OCIMetricsSource, SalesforceSource, AzureActivityLogsSourceStatus, EventSourceStatusManager)

EventSourceStatus defines the observed state of an event source.

Field	Description
`SourceStatus` knative.dev/pkg/apis/duck/v1.SourceStatus	(Members of `SourceStatus` are embedded into this type.)
`AddressStatus` knative.dev/pkg/apis/duck/v1.AddressStatus	(Members of `AddressStatus` are embedded into this type.)

EventSourceStatusManager

EventSourceStatusManager manages the status of event sources.

Field	Description
`ConditionSet` knative.dev/pkg/apis.ConditionSet
`EventSourceStatus` EventSourceStatus

OCIMetricsSourceSpec

(Appears on: OCIMetricsSource)

OCIMetricsSourceSpec defines the desired state of the event source.

Field	Description
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.) inherits duck/v1 SourceSpec, which currently provides: * Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. * CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.
`oracleApiPrivateKey` SecretValueFromSource	Oracle User API private key
`oracleApiPrivateKeyPassphrase` SecretValueFromSource	Oracle User API private key passphrase
`oracleApiPrivateKeyFingerprint` SecretValueFromSource	Oracle User API cert fingerprint
`oracleTenancy` string	Oracle Tenancy OCID
`oracleUser` string	Oracle User OCID associated with the API key
`oracleRegion` string	Oracle Cloud Region
`metricsPollingFrequency` string	OCI Metrics Polling Frequency
`metricsNamespace` string	Namespace for the query metric to use
`metricsQuery` string	OCI Metrics Query See https://docs.cloud.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/MetricData

SalesforceAuth

(Appears on: SalesforceSourceSpec)

SalesforceAuth contains Salesforce credentials.

Field	Description
`clientID` string
`server` string
`user` string
`certKey` SecretValueFromSource

SalesforceSourceSpec

(Appears on: SalesforceSource)

SalesforceSourceSpec defines the desired state of the event source.

Field	Description
`SourceSpec` knative.dev/pkg/apis/duck/v1.SourceSpec	(Members of `SourceSpec` are embedded into this type.)
`auth` SalesforceAuth	Authentication method to interact with the Salesforce API.
`apiVersion` string	(Optional) APIVersion at Salesforce.
`subscription` SalesforceSubscription	Subscription to a Salesforce channel

SalesforceSubscription

(Appears on: SalesforceSourceSpec)

SalesforceSubscription to connect to.

Field	Description
`channel` string
`replayID` int

SecretValueFromSource

(Appears on: AzureBlobStorageSourceSpec, OCIMetricsSourceSpec, SalesforceAuth)

SecretValueFromSource represents the source of a secret value

Field	Description
`secretKeyRef` Kubernetes core/v1.SecretKeySelector	The Secret key to select from.

ValueFromField

(Appears on: AzureServicePrincipal)

ValueFromField is a struct field that can have its value either defined explicitly or sourced from another entity.

Field	Description
`value` string	(Optional) Field value.
`valueFromSecret` Kubernetes core/v1.SecretKeySelector	(Optional) Field value from a Kubernetes Secret.

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