diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index f735467b..a0a64098 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -15,10 +15,10 @@ jobs: - name: Copy assets env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - SOURCE_VER: ${{ 'v0.1.0' }} - KUSTOMIZE_VER: ${{ 'v0.1.0' }} - HELM_VER: ${{ 'v0.1.1' }} - NOTIFICATION_VER: ${{ 'v0.1.0' }} + SOURCE_VER: ${{ 'v0.1.1' }} + KUSTOMIZE_VER: ${{ 'v0.1.1' }} + HELM_VER: ${{ 'v0.1.2' }} + NOTIFICATION_VER: ${{ 'v0.1.1' }} run: | controller_version() { sed -n "s/\(.*$1\/.*?ref=\)//p;n" "manifests/bases/$1/kustomization.yaml" diff --git a/README.md b/README.md index b2a3f186..9f6c2fd6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![report](https://goreportcard.com/badge/github.com/fluxcd/toolkit)](https://goreportcard.com/report/github.com/fluxcd/toolkit) [![license](https://img.shields.io/github/license/fluxcd/toolkit.svg)](https://github.com/fluxcd/toolkit/blob/main/LICENSE) [![release](https://img.shields.io/github/release/fluxcd/toolkit/all.svg)](https://github.com/fluxcd/toolkit/releases) -![overview](docs/diagrams/gotk-feature.png) +![overview](docs/diagrams/gitops-toolkit.png) The GitOps Toolkit is a set of composable APIs and specialized tools that can be used to build a Continuous Delivery platform on top of Kubernetes. @@ -82,9 +82,10 @@ The GitOps Toolkit is always looking for new contributors and there are a multit - Check out [how to contribute](CONTRIBUTING.md) to the project ## Featured Talks -- [4 Sep 2020 - KubeCon/CloudNativeCon Europe: Flux Deep Dive: The road to "Flux v2" and Progressive Delivery with Stefan Prodan & Hidde Beydals](https://youtu.be/8v94nUkXsxU) -- [25 June 2020 - Cloud Native Nordics Tech Talk “Introduction to GitOps & GitOps Toolkit” with Alexis Richardson & Stefan Prodan](https://youtu.be/qQBtSkgl7tI) -- [7 May 2020 - GitOps Days - Community Special: GitOps Toolkit Experimentation](https://youtu.be/WHzxunv4DKk?t=6521) +- [12 Oct 2020 - Rawkode Live: Introduction to GitOps Toolkit with Stefan Prodan](https://youtu.be/HqTzuOBP0eY) +- [4 Sep 2020 - KubeCon/CloudNativeCon Europe: The road to Flux v2 and Progressive Delivery with Stefan Prodan & Hidde Beydals](https://youtu.be/8v94nUkXsxU) +- [25 June 2020 - Cloud Native Nordics: Introduction to GitOps & GitOps Toolkit with Alexis Richardson & Stefan Prodan](https://youtu.be/qQBtSkgl7tI) +- [7 May 2020 - GitOps Days - Community Special: GitOps Toolkit Experimentation with Stefan Prodan](https://youtu.be/WHzxunv4DKk?t=6521) ### Upcoming Meetups - [19 October 2020 - GitOps Toolkit Guide Walk-through](https://www.meetup.com/GitOps-Community/events/273640196/) diff --git a/docs/diagrams/github-commit-status.png b/docs/_files/github-commit-status.png similarity index 100% rename from docs/diagrams/github-commit-status.png rename to docs/_files/github-commit-status.png diff --git a/docs/diagrams/gitlab-commit-status.png b/docs/_files/gitlab-commit-status.png similarity index 100% rename from docs/diagrams/gitlab-commit-status.png rename to docs/_files/gitlab-commit-status.png diff --git a/docs/diagrams/helm-controller-alerts.png b/docs/_files/helm-controller-alerts.png similarity index 100% rename from docs/diagrams/helm-controller-alerts.png rename to docs/_files/helm-controller-alerts.png diff --git a/docs/_files/kustomize-controller.png b/docs/_files/kustomize-controller.png index 10a5e776..1ac9cc70 100644 Binary files a/docs/_files/kustomize-controller.png and b/docs/_files/kustomize-controller.png differ diff --git a/docs/diagrams/slack-error-alert.png b/docs/_files/slack-error-alert.png similarity index 100% rename from docs/diagrams/slack-error-alert.png rename to docs/_files/slack-error-alert.png diff --git a/docs/diagrams/slack-info-alert.png b/docs/_files/slack-info-alert.png similarity index 100% rename from docs/diagrams/slack-info-alert.png rename to docs/_files/slack-info-alert.png diff --git a/docs/_files/source-controller.png b/docs/_files/source-controller.png index 6d4f4c7a..554c0054 100644 Binary files a/docs/_files/source-controller.png and b/docs/_files/source-controller.png differ diff --git a/docs/diagrams/gotk-feature.png b/docs/diagrams/gitops-toolkit.png similarity index 100% rename from docs/diagrams/gotk-feature.png rename to docs/diagrams/gitops-toolkit.png diff --git a/docs/diagrams/gotk-overview.png b/docs/diagrams/gotk-overview.png deleted file mode 100644 index 4cbdf66b..00000000 Binary files a/docs/diagrams/gotk-overview.png and /dev/null differ diff --git a/docs/guides/helmreleases.md b/docs/guides/helmreleases.md index 92070611..c270e824 100644 --- a/docs/guides/helmreleases.md +++ b/docs/guides/helmreleases.md @@ -245,7 +245,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1beta1 namespace: default ``` -![helm-controller alerts](../diagrams/helm-controller-alerts.png) +![helm-controller alerts](../_files/helm-controller-alerts.png) ## Configure webhook receivers diff --git a/docs/guides/notifications.md b/docs/guides/notifications.md index 09a29d69..de9b4811 100644 --- a/docs/guides/notifications.md +++ b/docs/guides/notifications.md @@ -92,7 +92,7 @@ encountered during the reconciliation process. This includes kustomize build and validation errors, apply errors and health check failures. -![error alert](../diagrams/slack-error-alert.png) +![error alert](../_files/slack-error-alert.png) When the verbosity is set to `info`, the controller will alert if: @@ -101,7 +101,7 @@ When the verbosity is set to `info`, the controller will alert if: * a dependency is delaying the execution * an error occurs -![info alert](../diagrams/slack-info-alert.png) +![info alert](../_files/slack-info-alert.png) ## Git commit status @@ -111,8 +111,8 @@ commit status works, refer to the [GitHub](https://docs.github.com/en/github/col or [GitLab](https://docs.gitlab.com/ee/api/commits.html) documentation. The first image is an example of how it may look like in GitHub while the one below is an example for GitLab. -![github commit status](../diagrams/github-commit-status.png) -![gitlab commit status](../diagrams/gitlab-commit-status.png) +![github commit status](../_files/github-commit-status.png) +![gitlab commit status](../_files/gitlab-commit-status.png) Currently the provider will only work with Alerts for Kustomization resources as the events have to be linked with a specific git commit. Any other event that does not contain a commit reference will be ignored by the provider. diff --git a/docs/index.md b/docs/index.md index 77f91104..47a4388b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ events and are responsible for the reconciliation of their designated API object the toolkit is in an active experimentation phase. If you wish to take part in this quest please reach out to us on Slack or GitHub. -![overview](diagrams/gotk-feature.png) +![overview](diagrams/gitops-toolkit.png) Target features: diff --git a/mkdocs.yml b/mkdocs.yml index 742fcfb1..88ca670b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -87,6 +87,9 @@ nav: - Create source git: cmd/gotk_create_source_git.md - Create source helm: cmd/gotk_create_source_helm.md - Create source bucket: cmd/gotk_create_source_bucket.md + - Create alert provider: cmd/gotk_create_alert-provider.md + - Create alert: cmd/gotk_create_alert.md + - Create receiver: cmd/gotk_create_receiver.md #- Create tenant: cmd/gotk_create_tenant.md - Delete: cmd/gotk_delete.md - Delete kustomization: cmd/gotk_delete_kustomization.md @@ -102,6 +105,9 @@ nav: - Export source git: cmd/gotk_export_source_git.md - Export source helm: cmd/gotk_export_source_helm.md - Export source bucket: cmd/gotk_export_source_bucket.md + - Export alert provider: cmd/gotk_export_alert-provider.md + - Export alert: cmd/gotk_export_alert.md + - Export receiver: cmd/gotk_export_receiver.md - Get: cmd/gotk_get.md - Get kustomizations: cmd/gotk_get_kustomizations.md - Get helmreleases: cmd/gotk_get_helmreleases.md @@ -109,13 +115,22 @@ nav: - Get sources git: cmd/gotk_get_sources_git.md - Get sources helm: cmd/gotk_get_sources_helm.md - Get sources bucket: cmd/gotk_get_sources_bucket.md + - Get alert provider: cmd/gotk_get_alert-provider.md + - Get alert: cmd/gotk_get_alert.md + - Get receiver: cmd/gotk_get_receiver.md - Install: cmd/gotk_install.md - Resume: cmd/gotk_resume.md - Resume kustomization: cmd/gotk_resume_kustomization.md - Resume helmrelease: cmd/gotk_resume_helmrelease.md + - Resume alert provider: cmd/gotk_resume_alert-provider.md + - Resume alert: cmd/gotk_resume_alert.md + - Resume receiver: cmd/gotk_resume_receiver.md - Suspend: cmd/gotk_suspend.md - Suspend kustomization: cmd/gotk_suspend_kustomization.md - Suspend helmrelease: cmd/gotk_suspend_helmrelease.md + - Suspend alert provider: cmd/gotk_suspend_alert-provider.md + - Suspend alert: cmd/gotk_suspend_alert.md + - Suspend receiver: cmd/gotk_suspend_receiver.md - Reconcile: cmd/gotk_reconcile.md - Reconcile kustomization: cmd/gotk_reconcile_kustomization.md - Reconcile helmrelease: cmd/gotk_reconcile_helmrelease.md