Update docs website
- add notification-controller/api commands to index - move diagrams to docs website - update CRDs docs Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
8
.github/workflows/docs.yaml
vendored
@ -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"
|
||||
|
@ -4,7 +4,7 @@
|
||||
[](https://goreportcard.com/report/github.com/fluxcd/toolkit)
|
||||
[](https://github.com/fluxcd/toolkit/blob/main/LICENSE)
|
||||
[](https://github.com/fluxcd/toolkit/releases)
|
||||

|
||||

|
||||
|
||||
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/)
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 3.4 KiB After Width: | Height: | Size: 3.4 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 53 KiB |
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
Before Width: | Height: | Size: 289 KiB |
@ -245,7 +245,7 @@ apiVersion: notification.toolkit.fluxcd.io/v1beta1
|
||||
namespace: default
|
||||
```
|
||||
|
||||

|
||||

|
||||
|
||||
## Configure webhook receivers
|
||||
|
||||
|
@ -92,7 +92,7 @@ encountered during the reconciliation process.
|
||||
This includes kustomize build and validation errors,
|
||||
apply errors and health check failures.
|
||||
|
||||

|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||

|
||||
|
||||
## 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.
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
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.
|
||||
|
@ -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.
|
||||
|
||||

|
||||

|
||||
|
||||
Target features:
|
||||
|
||||
|
15
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
|
||||
|