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

Commit b30f4e2

Browse files
sebgoaSameer Naik
andauthored
fix source guide with mention of installation procedure (#218)
* fix source guide with mention of installation procedure * Apply suggestions from code review Co-authored-by: Sameer Naik <[email protected]> Co-authored-by: Sameer Naik <[email protected]>
1 parent d7eede8 commit b30f4e2

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/guides/creatingasource.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Creating a Source
22

3+
!!! Info "Installation"
4+
Make sure you have completed the installation [procedure](installation.md) before continuing with any of the guides.
5+
36
In this guide we will create a point to point Bridge between an AWS SQS queue and a microservice application called `sockeye` which displays events in a web interface. This simple flow is depicted below.
47

58
![](../assets/images/sqs-sockeye.png)
@@ -39,7 +42,7 @@ $ kubectl get ksvc sockeye -o=jsonpath='{.status.url}'
3942

4043
## Create a AWS SQS Event source
4144

42-
You can explore the specification of the object using the `kubectl explain` command. You will see that you need the ARN (i.e Amazon Resource Name) of your AWS SQS queue and you need your AWS API keys.
45+
You can explore the specification of the object using the `kubectl explain` command. You will see that you need the ARN (i.e Amazon Resource Name) of your AWS SQS queue and the AWS API keys that give you access to SQS.
4346

4447

4548
```console
@@ -70,6 +73,17 @@ FIELDS:
7073
The destination of events sourced from Amazon SQS.
7174
```
7275

76+
Create a secret called `awscreds` which contains your access key and your secret key like so:
77+
78+
```console
79+
kubectl create secret generic awscreds \
80+
--from-literal=access_key_id=<ACCESS_KEY_ID> \
81+
--from-literal=secret_access_key=<SECRET_ACCESS_KEY>
82+
```
83+
84+
Then, write a YAML manifest for your SQS source similar to the one below. The following sample points to a SQS queue, referenced by its ARN and a secret called `awscreds`.
85+
86+
7387
```yaml
7488
apiVersion: sources.triggermesh.io/v1alpha1
7589
kind: AWSSQSSource
@@ -93,9 +107,11 @@ spec:
93107
name: sockeye
94108
```
95109
110+
Create this source with the `kubectl apply -f` command.
111+
96112
## Results
97113

98-
Verify that your objects are ready:
114+
Verify that your source is ready with:
99115

100116
```console
101117
$ kubectl get awssqssource

0 commit comments

Comments
 (0)