Skip to content

Commit

Permalink
Merge pull request #59 from fluxcd/docs-add-ns
Browse files Browse the repository at this point in the history
Add namespace to API docs examples
  • Loading branch information
stefanprodan authored Oct 13, 2020
2 parents 4d51e57 + 286ee63 commit 4c63796
Showing 4 changed files with 10 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/spec/v1beta1/alert.md
Original file line number Diff line number Diff line change
@@ -55,6 +55,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1beta1
kind: Alert
metadata:
name: webapp
namespace: default
spec:
providerRef:
name: on-call-slack
@@ -79,6 +80,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1beta1
kind: Alert
metadata:
name: all-kustomizations
namespace: default
spec:
providerRef:
name: dev-msteams
2 changes: 1 addition & 1 deletion docs/spec/v1beta1/event.md
Original file line number Diff line number Diff line change
@@ -53,5 +53,5 @@ const (
)
```

Controller implementations can use the [fluxcd/pkg/recorder](https://github.com/fluxcd/pkg/tree/master/recorder)
Controller implementations can use the [fluxcd/pkg/runtime/events](https://github.com/fluxcd/pkg/tree/main/runtime/events)
package to push events to notification-controller API.
2 changes: 2 additions & 0 deletions docs/spec/v1beta1/provider.md
Original file line number Diff line number Diff line change
@@ -73,6 +73,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1beta1
kind: Provider
metadata:
name: slack
namespace: default
spec:
type: slack
channel: general
@@ -108,6 +109,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1beta1
kind: Provider
metadata:
name: podinfo
namespace: default
spec:
# provider type can be github or gitlab
type: github
5 changes: 5 additions & 0 deletions docs/spec/v1beta1/receiver.md
Original file line number Diff line number Diff line change
@@ -76,6 +76,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1alpha1
kind: Receiver
metadata:
name: github-receiver
namespace: default
spec:
type: github
events:
@@ -100,6 +101,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1alpha1
kind: Receiver
metadata:
name: gitlab-receiver
namespace: default
spec:
type: gitlab
events:
@@ -124,6 +126,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1alpha1
kind: Receiver
metadata:
name: bitbucket-receiver
namespace: default
spec:
type: bitbucket
events:
@@ -145,6 +148,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1alpha1
kind: Receiver
metadata:
name: harbor-receiver
namespace: default
spec:
type: harbor
secretRef:
@@ -164,6 +168,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1alpha1
kind: Receiver
metadata:
name: generic-receiver
namespace: default
spec:
type: generic
secretRef:

0 comments on commit 4c63796

Please sign in to comment.