Skip to content

Commit

Permalink
Merge pull request #1335 from fluxcd/notification-v1beta2
Browse files Browse the repository at this point in the history
Update spec docs to Notification APIs v1beta2
  • Loading branch information
stefanprodan authored Dec 21, 2022
2 parents b576d58 + ed98432 commit 692439f
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion content/en/flux/cheatsheets/oci-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ please see the [HelmChart documentation](/flux/components/source/helmcharts/#ver
Configure alerting for when new artifacts are pulled and reconciled:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Alert
metadata:
name: podinfo
Expand Down
2 changes: 1 addition & 1 deletion content/en/flux/components/notification/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ please see the [bootstrap cheatsheet](../../cheatsheets/bootstrap.md).

| Name | Type | Description |
|---------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------|
| `--concurrent` | int | The number of concurrent notification reconciles. (default 4) |
| `--concurrent` | int | The number of concurrent notification reconciles. (default 4) |
| `--default-service-account` | string | Default service account used for impersonation. |
| `--enable-leader-election` | boolean | Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. |
| `--events-addr` | string | The address of the events receiver. |
Expand Down
4 changes: 2 additions & 2 deletions content/en/flux/guides/helmreleases.md
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ the `flux-system` to start receiving notifications about the Helm
release:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Alert
metadata:
generation: 2
Expand Down Expand Up @@ -594,7 +594,7 @@ kubectl -n flux-system create secret generic webhook-token \
When using [Harbor](https://goharbor.io/) as your Helm repository, you can define a receiver with:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Receiver
metadata:
name: helm-podinfo
Expand Down
2 changes: 1 addition & 1 deletion content/en/flux/guides/image-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ kubectl -n flux-system create secret generic webhook-token \
Define a receiver for DockerHub:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Receiver
metadata:
name: podinfo
Expand Down
4 changes: 2 additions & 2 deletions content/en/flux/guides/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ To display the Flux notifications on Grafana dashboards
you can configure Flux to push events to Grafana annotations API:
```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Alert
metadata:
name: grafana
Expand All @@ -139,7 +139,7 @@ spec:
name: '*'
namespace: flux-system
---
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Provider
metadata:
name: grafana
Expand Down
8 changes: 4 additions & 4 deletions content/en/flux/guides/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ it can be a Slack, Microsoft Teams, Discord or Rocket webhook URL.
Create a notification provider for Slack by referencing the above secret:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Provider
metadata:
name: slack
Expand All @@ -64,7 +64,7 @@ Elasticsearch, CloudWatch, Stackdriver, etc.
Create an alert definition for all repositories and kustomizations:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Alert
metadata:
name: on-call-webapp
Expand Down Expand Up @@ -204,7 +204,7 @@ Creating a git provider is very similar to creating other types of providers.
The only caveat being that the provider address needs to point to the same
git repository as the event source originates from.
```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Provider
metadata:
name: flux-system
Expand All @@ -215,7 +215,7 @@ spec:
secretRef:
name: github
---
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Alert
metadata:
name: podinfo
Expand Down
2 changes: 1 addition & 1 deletion content/en/flux/guides/webhook-receivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ kubectl -n flux-system create secret generic webhook-token \
Create a receiver for GitHub and specify the `GitRepository` object:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Receiver
metadata:
name: webapp
Expand Down
4 changes: 2 additions & 2 deletions content/en/flux/use-cases/gh-actions-helm-promotion.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ it performs a Helm release upgrade.
Example of `clusters/staging/apps/demo-github.yaml`:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Provider
metadata:
name: github
Expand All @@ -174,7 +174,7 @@ spec:
secretRef:
name: github-token
---
apiVersion: notification.toolkit.fluxcd.io/v1beta1
apiVersion: notification.toolkit.fluxcd.io/v1beta2
kind: Alert
metadata:
name: demo-dispatch
Expand Down
8 changes: 4 additions & 4 deletions hack/import-flux2-assets.sh
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,10 @@ gen_crd_doc() {
# notification-controller CRDs
NOTIFICATION_VER="$(controller_version notification-controller)"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/api/notification.md" "$COMPONENTS_DIR/notification/api.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/event.md" "$COMPONENTS_DIR/notification/event.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/alert.md" "$COMPONENTS_DIR/notification/alert.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/provider.md" "$COMPONENTS_DIR/notification/provider.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/receiver.md" "$COMPONENTS_DIR/notification/receiver.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta2/events.md" "$COMPONENTS_DIR/notification/event.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta2/alerts.md" "$COMPONENTS_DIR/notification/alert.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta2/providers.md" "$COMPONENTS_DIR/notification/provider.md"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta2/receivers.md" "$COMPONENTS_DIR/notification/receiver.md"
}

{
Expand Down

0 comments on commit 692439f

Please sign in to comment.