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.

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

Reorganise and improve the monitoring docs #1628

Merged
merged 8 commits into from
Aug 24, 2023
Merged

Reorganise and improve the monitoring docs #1628

merged 8 commits into from
Aug 24, 2023

Conversation

stefanprodan
Copy link
Member

@stefanprodan stefanprodan commented Aug 16, 2023

This PR reorganises and improves the monitoring documentation.

Preview: https://deploy-preview-1628--fluxcd.netlify.app/flux/monitoring/

Completion status

  • Monitoring
    • Alerts
    • Metrics
    • Custom metrics
    • Logs
    • Events
  • ⚠️ remove the temporary website build fix commit

@stefanprodan stefanprodan added area/docs Documentation related issues and pull requests area/flux Flux related issues and pull requests labels Aug 16, 2023
@darkowlzz
Copy link
Contributor

darkowlzz commented Aug 23, 2023

I had to make a few changes for the website build to work locally. Just highlighting that the new controller releases have some changes to where the docs exist. I think the changes in #1577 should address this issue.

Temporarily, I made the following local changes to be able to build and see the preview:

diff --git a/hack/import-flux2-assets.sh b/hack/import-flux2-assets.sh
index e937c9a..21c4c0e 100755
--- a/hack/import-flux2-assets.sh
+++ b/hack/import-flux2-assets.sh
@@ -137,13 +137,13 @@ gen_crd_doc() {
   # kustomize-controller CRDs
   KUSTOMIZE_VER="$(controller_version kustomize-controller)"
   gen_crd_doc "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/api/v1/kustomize.md" "$COMPONENTS_DIR/kustomize/api/v1.md" "HUGETABLE"
-  gen_crd_doc "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/spec/v1/kustomization.md" "$COMPONENTS_DIR/kustomize/kustomization.md"
+  gen_crd_doc "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/spec/v1/kustomizations.md" "$COMPONENTS_DIR/kustomize/kustomization.md"
 }
 
 {
   # helm-controller CRDs
   HELM_VER="$(controller_version helm-controller)"
-  gen_crd_doc "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/api/helmrelease.md" "$COMPONENTS_DIR/helm/api.md" "HUGETABLE"
+  gen_crd_doc "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/api/v2beta1/helm.md" "$COMPONENTS_DIR/helm/api.md" "HUGETABLE"
   gen_crd_doc "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/spec/v2beta1/helmreleases.md" "$COMPONENTS_DIR/helm/helmreleases.md"
 }

stefanprodan and others added 3 commits August 24, 2023 13:49
Signed-off-by: Stefan Prodan <[email protected]>
- New path to KSM config.
- Updated example config to include the suspend metrics label.

Signed-off-by: Sunny <[email protected]>
@stefanprodan stefanprodan marked this pull request as ready for review August 24, 2023 09:10
@stefanprodan stefanprodan requested a review from a team August 24, 2023 09:10
@stefanprodan stefanprodan merged commit 25f6cf9 into main Aug 24, 2023
1 of 5 checks passed
@stefanprodan stefanprodan deleted the monitoring-v2 branch August 24, 2023 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests area/flux Flux related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants