Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the docs for Google pub/sub #564

Closed
wants to merge 2 commits into from
Closed

Update the docs for Google pub/sub #564

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62e4dc5
update the docs for pub/sub
somtochiama Jun 27, 2023
4c7d615
remove extra yaml formatting
somtochiama Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions docs/spec/v1beta2/providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ stringData:
When `.spec.type` is set to `googlepubsub`, the controller will publish the payload of
an [Event](events.md#event-structure) on the Google Pub/Sub Topic ID provided in the
[Channel](#channel) field, which must exist in the GCP Project ID provided in the
[Address](#address) field.
[Address](#address) field of the secret referenced in the provider.

This Provider type can optionally use the [Secret reference](#secret-reference) to
authenticate on the Google Pub/Sub API by using [JSON credentials](https://cloud.google.com/iam/docs/service-account-creds#key-types).
Expand All @@ -697,6 +697,28 @@ to the Pub/Sub message using a [`headers` key in the referenced Secret](#http-he
This Provider type does not support the configuration of a [proxy URL](#https-proxy)
or [TLS certificates](#tls-certificates).

```yaml
---
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Provider
metadata:
name: googlepubsub-provider
namespace: desired-namespace
spec:
type: googlepubsub
channel: <Pub/Sub Topic ID>
secretRef:
name: googlepubsub-provider-creds
---
apiVersion: v1
kind: Secret
metadata:
name: googlepubsub-provider-creds
namespace: desired-namespace
stringData:
address: <GCP Project ID>
```

###### Google Pub/Sub with JSON Credentials and Custom Headers Example

To configure a Provider for Google Pub/Sub authenticating with JSON credentials and
Expand All @@ -714,7 +736,6 @@ metadata:
namespace: desired-namespace
spec:
type: googlepubsub
address: <GCP Project ID>
channel: <Pub/Sub Topic ID>
secretRef:
name: googlepubsub-provider-creds
Expand All @@ -726,6 +747,7 @@ metadata:
namespace: desired-namespace
stringData:
token: <GCP JSON credentials>
address: <GCP Project ID>
headers: |
attr1-name: attr1-value
attr2-name: attr2-value
Expand Down