Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Major update for the Shaker product release #304

Merged
merged 35 commits into from
Nov 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
a7573fd
Moved navigation to left menu
jmcx Oct 31, 2022
f413a5b
New navigation structure
jmcx Nov 1, 2022
dbd9262
Added Triggers and Brokers pages
jmcx Nov 1, 2022
fb9f82a
Updated SQS docs
jmcx Nov 2, 2022
0d0b8de
Added Kafka docs
jmcx Nov 4, 2022
8eb863b
Added content from targets docs in github
jmcx Nov 4, 2022
d67cd9b
Removed open telemetry
jmcx Nov 4, 2022
1bb6c0f
Added target K8s example yamls
jmcx Nov 4, 2022
a84ce22
Deprecated ConfluentTarget
jmcx Nov 7, 2022
e960f19
Added K8s examples to sources
jmcx Nov 7, 2022
bca75e2
Grid format for doc home page
jmcx Nov 7, 2022
2635a48
Added more sample yaml and reorg
jmcx Nov 9, 2022
26e2821
Added basic quickstart
jmcx Nov 9, 2022
4b39ef5
finished first pass on quickstart
jmcx Nov 10, 2022
78076a6
fixed filename type in quickstart
jmcx Nov 10, 2022
7899000
small tweaks to quickstart
jmcx Nov 12, 2022
384faea
finished AWS sources docs
jmcx Nov 12, 2022
601f616
Azure and Google sources docs fixed
jmcx Nov 15, 2022
da37177
finished all sources
jmcx Nov 16, 2022
e0e9be4
couple fixes to sources
jmcx Nov 16, 2022
5878ead
started work on aws targets
jmcx Nov 16, 2022
80867bc
google and aws targets done
jmcx Nov 17, 2022
9c75bd9
fixes
jmcx Nov 18, 2022
112929b
Update http.md
jmcx Nov 18, 2022
2b6229d
lots of updated targets
jmcx Nov 20, 2022
7f10c78
finshed pretty much all targets
jmcx Nov 20, 2022
44b9ef4
removed sunset components
jmcx Nov 22, 2022
b72050c
new version of the quickstart
jmcx Nov 22, 2022
9a305ac
added new installation instructions to quickstart
jmcx Nov 22, 2022
ae620ca
fixed quickstart link
jmcx Nov 23, 2022
5268047
added brokers & triggers
jmcx Nov 23, 2022
38c6691
fixing broken links
jmcx Nov 24, 2022
b6dc00f
move ensure path before completion
Nov 24, 2022
1d79468
fixed all broken links
jmcx Nov 24, 2022
7a85b3c
Added mkdocs insiders
jmcx Nov 25, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- attach_workspace:
at: ~/
- checkout
- run: pip install mkdocs-material mkdocs-redirects
- run: pip install git+https://${MKDOCS_INSIDERS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git mkdocs-redirects
- run:
name: Building package
command: make build
Expand Down
Empty file removed docs/apis/function.md
Empty file.
Empty file removed docs/apis/transformation.md
Empty file.
Binary file removed docs/assets/images/addNewSecretView.png
Binary file not shown.
Binary file removed docs/assets/images/aws-secret.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/assets/images/awsSecretWizard.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/awss3-source/create-bridge-1.png
Diff not rendered.
Binary file removed docs/assets/images/awss3-source/create-bridge-2.png
Diff not rendered.
Binary file removed docs/assets/images/awss3-source/create-bridge-3.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/awssqs-source/bridge-deployed.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/bridge-status-green.png
Diff not rendered.
Binary file removed docs/assets/images/bridgeinitial.png
Diff not rendered.
Binary file removed docs/assets/images/concepts.png
Diff not rendered.
214 changes: 214 additions & 0 deletions docs/assets/images/concepts.svg

Large diffs are not rendered by default.

Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/event-display.png
Diff not rendered.
Binary file removed docs/assets/images/exportconfig.png
Diff not rendered.
Binary file removed docs/assets/images/genericsecret.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/hasura-target/create-bridge-1.png
Diff not rendered.
Binary file removed docs/assets/images/hasura-target/create-bridge-2.png
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/header.png
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/log-display.png
Diff not rendered.
Binary file removed docs/assets/images/logz-target/create-bridge-1.png
Diff not rendered.
Binary file removed docs/assets/images/logz-target/create-bridge-2.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file added docs/assets/images/prometheus-ingest.png
Binary file added docs/assets/images/prometheus-trigger.png
Binary file removed docs/assets/images/repotask.png
Diff not rendered.
Binary file removed docs/assets/images/repotaskrun.png
Diff not rendered.
Binary file removed docs/assets/images/repowiz1.png
Diff not rendered.
Binary file removed docs/assets/images/repowiz2.png
Diff not rendered.
Binary file removed docs/assets/images/repowiz3.png
Diff not rendered.
Binary file removed docs/assets/images/repowiz4.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/salesforce/file-upload-secret.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/service-info.png
Diff not rendered.
Binary file removed docs/assets/images/servicesecretref.png
Diff not rendered.
Binary file removed docs/assets/images/serviceview.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/slack-source/07createsecret.png
Diff not rendered.
Binary file removed docs/assets/images/slack-target/bridge-create-1.png
Diff not rendered.
Binary file removed docs/assets/images/slack-target/bridge-create-2.png
Diff not rendered.
Binary file removed docs/assets/images/slack-target/bridge-create-3.png
Diff not rendered.
Binary file removed docs/assets/images/sourcescron.png
Diff not rendered.
Binary file removed docs/assets/images/sourcesecretref.png
Diff not rendered.
Binary file removed docs/assets/images/splunk-target/create-bridge-1.png
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/splunk-target/create-bridge-3.png
Diff not rendered.
Binary file removed docs/assets/images/taskexec.png
Diff not rendered.
Binary file removed docs/assets/images/taskrunlogs.png
Diff not rendered.
Binary file removed docs/assets/images/taskrunshow.png
Diff not rendered.
Binary file removed docs/assets/images/taskyaml.png
Diff not rendered.
Binary file removed docs/assets/images/tekton-target/bridge-create-1.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/til-demo.png
Diff not rendered.
Binary file removed docs/assets/images/tmAddTargets.png
Diff not rendered.
Binary file removed docs/assets/images/tmBridgeFlow.png
Diff not rendered.
Binary file removed docs/assets/images/tmBridges.png
Diff not rendered.
Binary file removed docs/assets/images/tmCreateBridge.png
Diff not rendered.
Binary file removed docs/assets/images/tmCreateServiceDropdown.png
Diff not rendered.
Binary file removed docs/assets/images/tmCreateServiceFromTarget.png
Diff not rendered.
Binary file removed docs/assets/images/tmDashCreateTask.png
Diff not rendered.
Binary file removed docs/assets/images/tmDashTask.png
Diff not rendered.
Binary file removed docs/assets/images/tmEventDisplay.png
Diff not rendered.
Binary file removed docs/assets/images/tmEventDisplayTarget.png
Diff not rendered.
Binary file removed docs/assets/images/tmPingSource.png
Diff not rendered.
Binary file removed docs/assets/images/tmRepoView.png
Diff not rendered.
Binary file removed docs/assets/images/tmServicesViewBridges.png
Diff not rendered.
Binary file removed docs/assets/images/tmSubmitBridge.png
Diff not rendered.
Binary file removed docs/assets/images/tmTaskRuns.png
Diff not rendered.
Binary file removed docs/assets/images/tmTaskYaml.png
Diff not rendered.
Binary file removed docs/assets/images/tmTaskYamlView.png
Diff not rendered.
Binary file removed docs/assets/images/tmcloudrun.png
Diff not rendered.
Binary file removed docs/assets/images/tmconsole.png
Diff not rendered.
Binary file removed docs/assets/images/tmconsoleservice.png
Diff not rendered.
Binary file removed docs/assets/images/tmdashservice.png
Diff not rendered.
Binary file removed docs/assets/images/tmlogin.png
Diff not rendered.
Binary file removed docs/assets/images/tmservice.png
Diff not rendered.
Binary file removed docs/assets/images/tmyaml.png
Diff not rendered.
Binary file removed docs/assets/images/twilio-source/create-bridge-1.png
Diff not rendered.
Binary file removed docs/assets/images/twilio-source/create-bridge-2.png
Diff not rendered.
Diff not rendered.
Binary file removed docs/assets/images/twilio-source/integrate-4.png
Diff not rendered.
Binary file removed docs/assets/images/twilio-source/integrate-5.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
8 changes: 8 additions & 0 deletions docs/brokers/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Brokers

TriggerMesh provides components called Brokers that act as intermediaries that route events from event producers to consumers. Brokers are responsible for guaranteeing that events are delivered to their destinations. Different Broker types will provide different guarantees and tradeoffs.

* `Memory Broker` uses ephemeral memory to store events, and is best used for development and non-mission-critical use cases where event loss is acceptable in the case of crashes or restarts
* `Redis Broker` uses a backing Redis instance to store events, thereby providing durability that is suitable for production uses cases where event loss in not acceptable during crashes or restarts

Triggers listen for events that land on a Broker, and evaluate events against the Trigger's filters. If the filters match, the Trigger fires and forwards the event to its target.
24 changes: 24 additions & 0 deletions docs/brokers/memorybroker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Memory Broker

On Kubernetes:

```yaml
apiVersion: eventing.triggermesh.io/v1alpha1
kind: MemoryBroker
metadata:
name: <broker instance name>
spec:
memory:
bufferSize: <maximum number of events>
broker:
port: <HTTP port for ingesting events>
observability:
valueFromConfigMap: <kubernetes ConfigMap that contains observability configuration>
```

The only `MemoryBroker` specific parameter is `spec.memory.bufferSize` which indicates the available size of the internal queue that the broker manages. When the maximum number of items is reached, new ingest requests will block and might eventually time out. This parameter is optional and defaults to 10000.

The `spec.broker` section contains generic Broker parameters:

- `spec.broker.port` that the Broker service will be listening at. Optional, defaults to port 80.
- `spec.broker.observability` can be set to the name of a ConfigMap at the same namespace that contains observability settings (documentation coming soon). This parameter is optional.
41 changes: 41 additions & 0 deletions docs/brokers/redisbroker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Redis Broker

On Kubernetes:

```yaml
apiVersion: eventing.triggermesh.io/v1alpha1
kind: RedisBroker
metadata:
name: <broker instance name>
spec:
redis:
connection: <Provides a connection to an external Redis instance. Optional>
url: <redis URL. Required>
username: <redis username, referenced using a Kubernetes secret>
secretKeyRef:
name: <Kubernetes secret name>
key: <Kubernetes secret key>
password: <redis password, referenced using a Kubernetes secret>
secretKeyRef:
name: <Kubernetes secret name>
key: <Kubernetes secret key>
tlsEnabled: <boolean that indicates if the Redis server is TLS protected. Optional, defaults to false>
tlsSkipVerify: <boolean that skips verifying TLS certificates. Optional, defaults to false>
stream: <Redis stream name. Optional, defaults to a combination of namespace and broker name>
streamMaxLen: <maximum number of items the Redis stream can host. Optional, defaults to unlimited>
broker:
port: <HTTP port for ingesting events>
observability:
valueFromConfigMap: <kubernetes ConfigMap that contains observability configuration>
```

The only `RedisBroker` specific parameters are:

- `spec.redis.connection`. When not used the broker will spin up a managed Redis Deployment. However for production scenarios that require HA and hardened security it is recommended to provide the connection to a user managed Redis instance.
- `spec.stream` is the Redis stream name to be used by the broker. If it doesn't exists the Broker will create it.
- `spec.streamMaxLen` is the maximum number of elements that the stream will contain.

The `spec.broker` section contains generic Broker parameters:

- `spec.broker.port` that the Broker service will be listening at. Optional, defaults to port 80.
- `spec.broker.observability` can be set to the name of a ConfigMap at the same namespace that contains observability settings (documentation coming soon). This parameter is optional.
33 changes: 33 additions & 0 deletions docs/brokers/triggers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Trigger

On Kubernetes:

```yaml
apiVersion: eventing.triggermesh.io/v1alpha1
kind: Trigger
metadata:
name: mytrigger
spec:
broker:
kind: RedisBroker
group: eventing.triggermesh.io
name: mybroker
filters:
- any:
- exact:
type: my.event.type
target:
ref:
apiVersion: v1alpha1
kind: CloudEventsTarget
name: my-cloudevents-target

delivery:
retry: 3
deadLetterSink:
ref:
kind: Service
apiVersion: v1
name: display-deadlettersink

```
80 changes: 0 additions & 80 deletions docs/cloud/bridge.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/cloud/guides/secrets.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/cloud/index.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/cloud/secrets.md

This file was deleted.

Loading