From 2c2292181b25188f414d64e9846786609af5b4a0 Mon Sep 17 00:00:00 2001 From: codeEvolveZenith345 Date: Tue, 11 Nov 2025 18:44:54 +0000 Subject: [PATCH] Rename master to main across docs, CI, and configs to use inclusive terminology. Signed-off-by: codeEvolveZenith345 --- .github/workflows/Pull_Request.yml | 2 +- .github/workflows/docker_Push.yml | 6 ++--- CONTRIBUTING.md | 6 ++--- website/README.md | 2 +- .../chaoscenter-developer-guide.md | 4 +-- website/docs/faq.md | 2 +- website/docs/getting-started/installation.md | 4 +-- website/docs/integrations/backstage.md | 8 +++--- website/docs/integrations/grafana.md | 26 +++++++++---------- website/docs/introduction/community.md | 10 +++---- website/docs/litmusctl/additional-commands.md | 2 +- .../litmusctl/connect-chaos-infrastructure.md | 2 +- website/docs/litmusctl/installation.md | 20 +++++++------- website/docs/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../docs/user-guides/manage-app-dashboard.md | 2 +- website/docs/user-guides/setup-datasource.md | 20 +++++++------- .../docs/user-guides/share-app-dashboard.md | 4 +-- website/docs/user-guides/upgrade.md | 4 +-- website/docusaurus.config.js | 4 +-- website/versioned_docs/version-3.0.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../version-3.0.0/integrations/backstage.md | 8 +++--- .../version-3.0.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.0.0/introduction/community.md | 6 ++--- .../version-3.0.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.0.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.0.0/user-guides/upgrade.md | 8 +++--- website/versioned_docs/version-3.1.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.1.0/integrations/backstage.md | 8 +++--- .../version-3.1.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.1.0/introduction/community.md | 6 ++--- .../version-3.1.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.1.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.1.0/user-guides/upgrade.md | 6 ++--- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.10.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.10.0/integrations/backstage.md | 8 +++--- .../version-3.10.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.10.0/introduction/community.md | 6 ++--- .../version-3.10.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.10.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.10.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.11.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.11.0/integrations/backstage.md | 8 +++--- .../version-3.11.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.11.0/introduction/community.md | 6 ++--- .../version-3.11.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.11.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.11.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.12.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.12.0/integrations/backstage.md | 8 +++--- .../version-3.12.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.12.0/introduction/community.md | 10 +++---- .../version-3.12.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.12.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.12.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.13.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.13.0/integrations/backstage.md | 8 +++--- .../version-3.13.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.13.0/introduction/community.md | 10 +++---- .../version-3.13.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.13.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.13.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.14.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.14.0/integrations/backstage.md | 8 +++--- .../version-3.14.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.14.0/introduction/community.md | 10 +++---- .../version-3.14.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.14.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.14.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.15.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.15.0/integrations/backstage.md | 8 +++--- .../version-3.15.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.15.0/introduction/community.md | 10 +++---- .../version-3.15.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.15.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.15.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.16.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.16.0/integrations/backstage.md | 8 +++--- .../version-3.16.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.16.0/introduction/community.md | 10 +++---- .../version-3.16.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.16.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.16.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.17.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.17.0/integrations/backstage.md | 8 +++--- .../version-3.17.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.17.0/introduction/community.md | 10 +++---- .../version-3.17.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.17.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.17.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.18.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.18.0/integrations/backstage.md | 8 +++--- .../version-3.18.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.18.0/introduction/community.md | 10 +++---- .../version-3.18.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.18.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.18.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.19.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.19.0/integrations/backstage.md | 8 +++--- .../version-3.19.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.19.0/introduction/community.md | 10 +++---- .../version-3.19.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.19.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.19.0/user-guides/upgrade.md | 4 +-- website/versioned_docs/version-3.2.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.2.0/integrations/backstage.md | 8 +++--- .../version-3.2.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.2.0/introduction/community.md | 6 ++--- .../version-3.2.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.2.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.2.0/user-guides/upgrade.md | 6 ++--- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.20.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.20.0/integrations/backstage.md | 8 +++--- .../version-3.20.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.20.0/introduction/community.md | 10 +++---- .../version-3.20.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.20.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.20.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.21.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.21.0/integrations/backstage.md | 8 +++--- .../version-3.21.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.21.0/introduction/community.md | 10 +++---- .../version-3.21.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.21.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.21.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.22.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.22.0/integrations/backstage.md | 8 +++--- .../version-3.22.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.22.0/introduction/community.md | 10 +++---- .../litmusctl/additional-commands.md | 2 +- .../litmusctl/connect-chaos-infrastructure.md | 2 +- .../version-3.22.0/litmusctl/installation.md | 20 +++++++------- .../version-3.22.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.22.0/user-guides/upgrade.md | 4 +-- website/versioned_docs/version-3.3.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.3.0/integrations/backstage.md | 8 +++--- .../version-3.3.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.3.0/introduction/community.md | 6 ++--- .../version-3.3.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.3.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.3.0/user-guides/upgrade.md | 6 ++--- website/versioned_docs/version-3.4.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.4.0/integrations/backstage.md | 8 +++--- .../version-3.4.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.4.0/introduction/community.md | 6 ++--- .../version-3.4.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.4.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.4.0/user-guides/upgrade.md | 6 ++--- website/versioned_docs/version-3.5.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.5.0/integrations/backstage.md | 8 +++--- .../version-3.5.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.5.0/introduction/community.md | 6 ++--- .../version-3.5.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.5.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.5.0/user-guides/upgrade.md | 6 ++--- website/versioned_docs/version-3.6.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.6.0/integrations/backstage.md | 8 +++--- .../version-3.6.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.6.0/introduction/community.md | 6 ++--- .../version-3.6.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.6.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.6.0/user-guides/upgrade.md | 6 ++--- website/versioned_docs/version-3.7.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.7.0/integrations/backstage.md | 8 +++--- .../version-3.7.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.7.0/introduction/community.md | 6 ++--- .../version-3.7.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.7.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.7.0/user-guides/upgrade.md | 6 ++--- website/versioned_docs/version-3.8.0/faq.md | 2 +- .../getting-started/installation.md | 2 +- .../getting-started/resources.md | 2 +- .../version-3.8.0/integrations/backstage.md | 8 +++--- .../version-3.8.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.8.0/introduction/community.md | 6 ++--- .../version-3.8.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.8.0/troubleshooting.md | 2 +- ...haoscenter-namespace-scope-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 4 +-- .../version-3.8.0/user-guides/upgrade.md | 6 ++--- website/versioned_docs/version-3.9.0/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.9.0/integrations/backstage.md | 8 +++--- .../version-3.9.0/integrations/grafana.md | 26 +++++++++---------- .../version-3.9.0/introduction/community.md | 6 ++--- .../version-3.9.0/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.9.0/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 2 +- .../version-3.9.0/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.9.1/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.9.1/integrations/backstage.md | 8 +++--- .../version-3.9.1/integrations/grafana.md | 26 +++++++++---------- .../version-3.9.1/introduction/community.md | 6 ++--- .../version-3.9.1/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.9.1/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 6 ++--- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../user-guides/uninstall-litmus.md | 2 +- .../version-3.9.1/user-guides/upgrade.md | 4 +-- .../chaoscenter-developer-guide.md | 4 +-- website/versioned_docs/version-3.9.2/faq.md | 2 +- .../getting-started/installation.md | 4 +-- .../version-3.9.2/integrations/backstage.md | 8 +++--- .../version-3.9.2/integrations/grafana.md | 26 +++++++++---------- .../version-3.9.2/introduction/community.md | 6 ++--- .../version-3.9.2/litmusctl/installation.md | 20 +++++++------- .../litmusctl/litmusctl-usage.md | 6 ++--- .../version-3.9.2/troubleshooting.md | 2 +- .../chaoscenter-advanced-installation.md | 4 +-- .../chaoscenter-oauth-dex-installation.md | 2 +- .../editing-queries-app-dashboard.md | 2 +- .../user-guides/manage-app-dashboard.md | 2 +- .../user-guides/setup-datasource.md | 20 +++++++------- .../user-guides/share-app-dashboard.md | 4 +-- .../version-3.9.2/user-guides/upgrade.md | 4 +-- 432 files changed, 1560 insertions(+), 1560 deletions(-) diff --git a/.github/workflows/Pull_Request.yml b/.github/workflows/Pull_Request.yml index 28f45f3e..4e4a1f74 100644 --- a/.github/workflows/Pull_Request.yml +++ b/.github/workflows/Pull_Request.yml @@ -44,7 +44,7 @@ jobs: tput setaf 3; echo "Please follow the instructions to run embedmd:" tput setaf 3; echo "cd website/docs" tput setaf 3; echo "embedmd -w \$(find **/*.md)" - tput setaf 6; echo "For more info visit https://github.com/litmuschaos/litmus-docs/blob/master/CONTRIBUTING.md" + tput setaf 6; echo "For more info visit https://github.com/litmuschaos/litmus-docs/blob/main/CONTRIBUTING.md" exit 1 else tput setaf 2; echo "Nothing to embed" diff --git a/.github/workflows/docker_Push.yml b/.github/workflows/docker_Push.yml index 301cdf24..771805a7 100644 --- a/.github/workflows/docker_Push.yml +++ b/.github/workflows/docker_Push.yml @@ -3,7 +3,7 @@ name: CD-Build on: push: branches: - - master + - main paths: - "website/**" @@ -42,7 +42,7 @@ jobs: - name: Checking out CD repository uses: actions/checkout@v2 with: - ref: "master" + ref: "main" repository: litmuschaos/litmus-cd token: ${{ secrets.CD_PUSH_TOKEN }} @@ -57,5 +57,5 @@ jobs: git config user.email litmusbot@github.com git add . git commit -m "Manifest updated for litmus-docs" - git push origin master + git push origin main diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1c136b7..cd1fac91 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,10 +21,10 @@ Litmus documentation currently runs using [Docusaurus](https://docusaurus.io/) s - Find an issue to work on or create a new issue. The issues are maintained at [litmuschaos/litmus](https://github.com/litmuschaos/litmus/issues). For new contributors, you can pick up from a list of [good first issues](https://github.com/litmuschaos/litmus/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Flitmus-docs+label%3A%22good+first+issue%22+) - Claim your issue by commenting your intent to work on it to avoid duplication of efforts. - Fork the repository on GitHub. -- Create a branch from where you want to base your work (usually master). +- Create a branch from where you want to base your work (usually main). - Make your changes, test locally, see preview by starting server and seeing in Preview Mode. - Execute embedmd command before commiting your changes, so that it can embed source code into documentation, refer [README](/README.md) for steps. -- Commit your changes by making sure the commit messages convey the need and notes about the commit. Also make sure to [sign your commit](https://github.com/litmuschaos/litmus-docs/blob/master/CONTRIBUTING.md#sign-your-work) while making a new commit. +- Commit your changes by making sure the commit messages convey the need and notes about the commit. Also make sure to [sign your commit](https://github.com/litmuschaos/litmus-docs/blob/main/CONTRIBUTING.md#sign-your-work) while making a new commit. - Push your changes to the branch in your fork of the repository. - Submit a pull request to the original repository. @@ -41,7 +41,7 @@ embedmd -w $(find **/*.md) ## Pull Request Checklist -- Rebase to the current master branch before submitting your pull request. +- Rebase to the current main branch before submitting your pull request. - Commits should be kept small if possible. Each commit should follow the checklist below: diff --git a/website/README.md b/website/README.md index 25de28f7..43a93c00 100644 --- a/website/README.md +++ b/website/README.md @@ -30,5 +30,5 @@ This command generates static content into the `build` directory and can be serv npm run docusaurus docs:version ``` -This command will tag a new version from master docs. +This command will tag a new version from main docs. It will copy the docs/ folder contents into a new versioned_docs/version-``/ folder, create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-``-sidebars.json and append the new version number to versions.json. diff --git a/website/docs/developer-guide/chaoscenter-developer-guide.md b/website/docs/developer-guide/chaoscenter-developer-guide.md index 2df27bd9..0d631e2b 100644 --- a/website/docs/developer-guide/chaoscenter-developer-guide.md +++ b/website/docs/developer-guide/chaoscenter-developer-guide.md @@ -131,7 +131,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -191,7 +191,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/docs/faq.md b/website/docs/faq.md index 8b938e12..0317a292 100644 --- a/website/docs/faq.md +++ b/website/docs/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/docs/getting-started/installation.md b/website/docs/getting-started/installation.md index 8a70c7eb..4e1946b8 100644 --- a/website/docs/getting-started/installation.md +++ b/website/docs/getting-started/installation.md @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info. ## Install Litmus using kubectl -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### Install mongo @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/docs/integrations/backstage.md b/website/docs/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/docs/integrations/backstage.md +++ b/website/docs/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/docs/integrations/grafana.md b/website/docs/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/docs/integrations/grafana.md +++ b/website/docs/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/docs/introduction/community.md b/website/docs/introduction/community.md index 881640fc..ae751859 100644 --- a/website/docs/introduction/community.md +++ b/website/docs/introduction/community.md @@ -72,16 +72,16 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). -Checkout the [contribution guide](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +Checkout the [contribution guide](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/docs/litmusctl/additional-commands.md b/website/docs/litmusctl/additional-commands.md index 12a7673d..45e47613 100644 --- a/website/docs/litmusctl/additional-commands.md +++ b/website/docs/litmusctl/additional-commands.md @@ -7,7 +7,7 @@ sidebar_label: Additional Commands This guide covers additional litmusctl commands for managing your ChaosCenter account, projects, environments, and chaos infrastructures. -Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#additional-commands) to learn more about litmusctl commands. +Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md#additional-commands) to learn more about litmusctl commands. --- diff --git a/website/docs/litmusctl/connect-chaos-infrastructure.md b/website/docs/litmusctl/connect-chaos-infrastructure.md index abfa8fcf..dedf376f 100644 --- a/website/docs/litmusctl/connect-chaos-infrastructure.md +++ b/website/docs/litmusctl/connect-chaos-infrastructure.md @@ -153,4 +153,4 @@ To verify the connection, open your ChaosCenter and go to the Targets section. Y --- -For additional details or examples, you can also refer to this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture). +For additional details or examples, you can also refer to this [guide](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture). diff --git a/website/docs/litmusctl/installation.md b/website/docs/litmusctl/installation.md index 8ebfa231..2e38c88c 100644 --- a/website/docs/litmusctl/installation.md +++ b/website/docs/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -37,7 +37,7 @@ To install the latest version of litmusctl follow the below steps: 1.12.0 1.11.0 1.10.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -49,7 +49,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -62,7 +62,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -75,7 +75,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -88,7 +88,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -101,7 +101,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -114,7 +114,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -127,7 +127,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -140,7 +140,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/docs/troubleshooting.md b/website/docs/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/docs/troubleshooting.md +++ b/website/docs/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/docs/user-guides/chaoscenter-advanced-installation.md b/website/docs/user-guides/chaoscenter-advanced-installation.md index 52d36cd3..fc944710 100644 --- a/website/docs/user-guides/chaoscenter-advanced-installation.md +++ b/website/docs/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/docs/user-guides/chaoscenter-oauth-dex-installation.md b/website/docs/user-guides/chaoscenter-oauth-dex-installation.md index 194b81ed..7c0b96c5 100644 --- a/website/docs/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/docs/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/docs/user-guides/editing-queries-app-dashboard.md b/website/docs/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/docs/user-guides/editing-queries-app-dashboard.md +++ b/website/docs/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/docs/user-guides/manage-app-dashboard.md b/website/docs/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/docs/user-guides/manage-app-dashboard.md +++ b/website/docs/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/docs/user-guides/setup-datasource.md b/website/docs/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/docs/user-guides/setup-datasource.md +++ b/website/docs/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/docs/user-guides/share-app-dashboard.md b/website/docs/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/docs/user-guides/share-app-dashboard.md +++ b/website/docs/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/docs/user-guides/upgrade.md b/website/docs/user-guides/upgrade.md index 3c6514ab..9b9cdb9a 100644 --- a/website/docs/user-guides/upgrade.md +++ b/website/docs/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 970651c5..35497ebd 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -83,7 +83,7 @@ module.exports = { to: `docs/${version}/introduction/what-is-litmus` })), { - label: 'master/unreleased', + label: 'main/unreleased', to: 'docs/next/introduction/what-is-litmus' }, ] @@ -172,7 +172,7 @@ module.exports = { { docs: { sidebarPath: require.resolve('./sidebars.js'), - editUrl: 'https://github.com/litmuschaos/litmus-docs/edit/master/website', + editUrl: 'https://github.com/litmuschaos/litmus-docs/edit/main/website', showLastUpdateTime: false }, theme: { diff --git a/website/versioned_docs/version-3.0.0/faq.md b/website/versioned_docs/version-3.0.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.0.0/faq.md +++ b/website/versioned_docs/version-3.0.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.0.0/getting-started/installation.md b/website/versioned_docs/version-3.0.0/getting-started/installation.md index 519fbed0..25d9f193 100644 --- a/website/versioned_docs/version-3.0.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.0.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.0.0/integrations/backstage.md b/website/versioned_docs/version-3.0.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.0.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.0.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.0.0/integrations/grafana.md b/website/versioned_docs/version-3.0.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.0.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.0.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.0.0/introduction/community.md b/website/versioned_docs/version-3.0.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.0.0/introduction/community.md +++ b/website/versioned_docs/version-3.0.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.0.0/litmusctl/installation.md b/website/versioned_docs/version-3.0.0/litmusctl/installation.md index 466e0cd7..548d68da 100644 --- a/website/versioned_docs/version-3.0.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.0.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -29,46 +29,46 @@ To install the latest version of litmusctl follow the below steps: - + - + - + - + - + - + - + - + - +
Platforms 0.23.0master(Unreleased)main(Unreleased)
litmusctl-darwin-amd64 (MacOS) Click hereClick hereClick here
litmusctl-linux-386 Click hereClick hereClick here
litmusctl-linux-amd64 Click hereClick hereClick here
litmusctl-linux-arm Click hereClick hereClick here
litmusctl-linux-arm64 Click hereClick hereClick here
litmusctl-windows-386 Click hereClick hereClick here
litmusctl-windows-amd64 Click hereClick hereClick here
litmusctl-windows-arm Click hereClick hereClick here
diff --git a/website/versioned_docs/version-3.0.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.0.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.0.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.0.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.0.0/troubleshooting.md b/website/versioned_docs/version-3.0.0/troubleshooting.md index 017fd3c6..10146acf 100644 --- a/website/versioned_docs/version-3.0.0/troubleshooting.md +++ b/website/versioned_docs/version-3.0.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs/3.0.0/litmus-portal-crds-3.0.0.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs/3.0.0/litmus-portal-crds-3.0.0.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-namespace-scope-installation.md index 26c1df2c..8effe89b 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.0.0-beta6/litmus-namespaced-3.0.0-beta6.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.0.0-beta6/litmus-namespaced-3.0.0-beta6.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.0.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.0.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.0.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.0.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.0.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.0.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.0.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.0.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.0.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.0.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.0.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.0.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.0.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.0.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.0.0/user-guides/uninstall-litmus.md index e7760896..32a4349f 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.0.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.0.0/user-guides/upgrade.md b/website/versioned_docs/version-3.0.0/user-guides/upgrade.md index fed5ef63..2866e34a 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.0.0/user-guides/upgrade.md @@ -16,16 +16,16 @@ To upgrade Litmus ChaosCenter from 3.0.0-beta7 to 3.0.0-beta8, you can follow th To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.0.0-beta8/litmus-3.0.0-beta8.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.0.0-beta8/litmus-3.0.0-beta8.yaml ``` ## Upgrade Mongodb DB Schema > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.1.0/faq.md b/website/versioned_docs/version-3.1.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.1.0/faq.md +++ b/website/versioned_docs/version-3.1.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.1.0/getting-started/installation.md b/website/versioned_docs/version-3.1.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.1.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.1.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.1.0/getting-started/resources.md b/website/versioned_docs/version-3.1.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.1.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.1.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.1.0/integrations/backstage.md b/website/versioned_docs/version-3.1.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.1.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.1.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.1.0/integrations/grafana.md b/website/versioned_docs/version-3.1.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.1.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.1.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.1.0/introduction/community.md b/website/versioned_docs/version-3.1.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.1.0/introduction/community.md +++ b/website/versioned_docs/version-3.1.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.1.0/litmusctl/installation.md b/website/versioned_docs/version-3.1.0/litmusctl/installation.md index b9d752be..ab45199b 100644 --- a/website/versioned_docs/version-3.1.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.1.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 0.20.0 0.19.0 0.18.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.1.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.1.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.1.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.1.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.1.0/troubleshooting.md b/website/versioned_docs/version-3.1.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.1.0/troubleshooting.md +++ b/website/versioned_docs/version-3.1.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-namespace-scope-installation.md index 9bc642a7..0fda1edc 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.1.0/litmus-namespaced-3.1.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.1.0/litmus-namespaced-3.1.0.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.1.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.1.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.1.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.1.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.1.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.1.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.1.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.1.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.1.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.1.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.1.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.1.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.1.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.1.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.1.0/user-guides/uninstall-litmus.md index 45389528..2f162c32 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.1.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.1.0/user-guides/upgrade.md b/website/versioned_docs/version-3.1.0/user-guides/upgrade.md index ad8d6321..a8ab3e20 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.1.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.0.0 to 3.1.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.10.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.10.0/developer-guide/chaoscenter-developer-guide.md index 021405ff..bb2413b7 100644 --- a/website/versioned_docs/version-3.10.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.10.0/developer-guide/chaoscenter-developer-guide.md @@ -129,7 +129,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -189,7 +189,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.10.0/faq.md b/website/versioned_docs/version-3.10.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.10.0/faq.md +++ b/website/versioned_docs/version-3.10.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.10.0/getting-started/installation.md b/website/versioned_docs/version-3.10.0/getting-started/installation.md index 01980b2c..eca1c8ac 100644 --- a/website/versioned_docs/version-3.10.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.10.0/getting-started/installation.md @@ -107,7 +107,7 @@ Litmus uses Kubernetes CRDs to define the chaos intent. Helm3 handles CRDs bette ### Install Litmus using kubectl -You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). #### Install Mongo @@ -154,7 +154,7 @@ Litmus supports HTTP and HTTPS mode of installation. Applying the manifest file installs all the required service account configuration and ChaosCenter in the namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS-based and CORS rules apply) diff --git a/website/versioned_docs/version-3.10.0/integrations/backstage.md b/website/versioned_docs/version-3.10.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.10.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.10.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.10.0/integrations/grafana.md b/website/versioned_docs/version-3.10.0/integrations/grafana.md index af717f1a..66c2d6a9 100644 --- a/website/versioned_docs/version-3.10.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.10.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.10.0/introduction/community.md b/website/versioned_docs/version-3.10.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.10.0/introduction/community.md +++ b/website/versioned_docs/version-3.10.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.10.0/litmusctl/installation.md b/website/versioned_docs/version-3.10.0/litmusctl/installation.md index 583299d7..1b96143c 100644 --- a/website/versioned_docs/version-3.10.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.10.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.4.0 1.3.0 1.2.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.10.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.10.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.10.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.10.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.10.0/troubleshooting.md b/website/versioned_docs/version-3.10.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.10.0/troubleshooting.md +++ b/website/versioned_docs/version-3.10.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-advanced-installation.md index a6c1af24..f680d12f 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-oauth-dex-installation.md index 8923a565..a36b4024 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.10.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.10.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.10.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.10.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.10.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.10.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.10.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.10.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.10.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.10.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.10.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.10.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.10.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.10.0/user-guides/upgrade.md b/website/versioned_docs/version-3.10.0/user-guides/upgrade.md index 1dcf3597..b3f7ddc5 100644 --- a/website/versioned_docs/version-3.10.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.10.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.9.0 to 3.10.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.10.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.10.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.11.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.11.0/developer-guide/chaoscenter-developer-guide.md index a4fd3d2d..3192dc49 100644 --- a/website/versioned_docs/version-3.11.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.11.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.11.0/faq.md b/website/versioned_docs/version-3.11.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.11.0/faq.md +++ b/website/versioned_docs/version-3.11.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.11.0/getting-started/installation.md b/website/versioned_docs/version-3.11.0/getting-started/installation.md index 01980b2c..eca1c8ac 100644 --- a/website/versioned_docs/version-3.11.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.11.0/getting-started/installation.md @@ -107,7 +107,7 @@ Litmus uses Kubernetes CRDs to define the chaos intent. Helm3 handles CRDs bette ### Install Litmus using kubectl -You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). #### Install Mongo @@ -154,7 +154,7 @@ Litmus supports HTTP and HTTPS mode of installation. Applying the manifest file installs all the required service account configuration and ChaosCenter in the namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS-based and CORS rules apply) diff --git a/website/versioned_docs/version-3.11.0/integrations/backstage.md b/website/versioned_docs/version-3.11.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.11.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.11.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.11.0/integrations/grafana.md b/website/versioned_docs/version-3.11.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.11.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.11.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.11.0/introduction/community.md b/website/versioned_docs/version-3.11.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.11.0/introduction/community.md +++ b/website/versioned_docs/version-3.11.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.11.0/litmusctl/installation.md b/website/versioned_docs/version-3.11.0/litmusctl/installation.md index d8b17f48..dcf6c377 100644 --- a/website/versioned_docs/version-3.11.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.11.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.5.0 1.4.0 1.3.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.11.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.11.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.11.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.11.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.11.0/troubleshooting.md b/website/versioned_docs/version-3.11.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.11.0/troubleshooting.md +++ b/website/versioned_docs/version-3.11.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-advanced-installation.md index 516754eb..dbb19c34 100644 --- a/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-oauth-dex-installation.md index 48dd6714..97166827 100644 --- a/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.11.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.11.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.11.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.11.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.11.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.11.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.11.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.11.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.11.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.11.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.11.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.11.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.11.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.11.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.11.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.11.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.11.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.11.0/user-guides/upgrade.md b/website/versioned_docs/version-3.11.0/user-guides/upgrade.md index 12c9e225..92d0deb1 100644 --- a/website/versioned_docs/version-3.11.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.11.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.11.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.11.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.12.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.12.0/developer-guide/chaoscenter-developer-guide.md index a4fd3d2d..3192dc49 100644 --- a/website/versioned_docs/version-3.12.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.12.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.12.0/faq.md b/website/versioned_docs/version-3.12.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.12.0/faq.md +++ b/website/versioned_docs/version-3.12.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.12.0/getting-started/installation.md b/website/versioned_docs/version-3.12.0/getting-started/installation.md index 01980b2c..eca1c8ac 100644 --- a/website/versioned_docs/version-3.12.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.12.0/getting-started/installation.md @@ -107,7 +107,7 @@ Litmus uses Kubernetes CRDs to define the chaos intent. Helm3 handles CRDs bette ### Install Litmus using kubectl -You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). #### Install Mongo @@ -154,7 +154,7 @@ Litmus supports HTTP and HTTPS mode of installation. Applying the manifest file installs all the required service account configuration and ChaosCenter in the namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS-based and CORS rules apply) diff --git a/website/versioned_docs/version-3.12.0/integrations/backstage.md b/website/versioned_docs/version-3.12.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.12.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.12.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.12.0/integrations/grafana.md b/website/versioned_docs/version-3.12.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.12.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.12.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.12.0/introduction/community.md b/website/versioned_docs/version-3.12.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.12.0/introduction/community.md +++ b/website/versioned_docs/version-3.12.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.12.0/litmusctl/installation.md b/website/versioned_docs/version-3.12.0/litmusctl/installation.md index 688ae8a2..674086a9 100644 --- a/website/versioned_docs/version-3.12.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.12.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.6.0 1.5.0 1.4.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.12.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.12.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.12.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.12.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.12.0/troubleshooting.md b/website/versioned_docs/version-3.12.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.12.0/troubleshooting.md +++ b/website/versioned_docs/version-3.12.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-advanced-installation.md index 41755812..f6d3e52b 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-oauth-dex-installation.md index 48dd6714..97166827 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.12.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.12.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.12.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.12.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.12.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.12.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.12.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.12.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.12.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.12.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.12.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.12.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.12.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.12.0/user-guides/upgrade.md b/website/versioned_docs/version-3.12.0/user-guides/upgrade.md index 0f1654ad..c829f690 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.12.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.12.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.12.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.13.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.13.0/developer-guide/chaoscenter-developer-guide.md index a4fd3d2d..3192dc49 100644 --- a/website/versioned_docs/version-3.13.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.13.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.13.0/faq.md b/website/versioned_docs/version-3.13.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.13.0/faq.md +++ b/website/versioned_docs/version-3.13.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.13.0/getting-started/installation.md b/website/versioned_docs/version-3.13.0/getting-started/installation.md index ca53fcc2..bb8f0ce1 100644 --- a/website/versioned_docs/version-3.13.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.13.0/getting-started/installation.md @@ -114,7 +114,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -161,7 +161,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.13.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.13.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.13.0/integrations/backstage.md b/website/versioned_docs/version-3.13.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.13.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.13.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.13.0/integrations/grafana.md b/website/versioned_docs/version-3.13.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.13.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.13.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.13.0/introduction/community.md b/website/versioned_docs/version-3.13.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.13.0/introduction/community.md +++ b/website/versioned_docs/version-3.13.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.13.0/litmusctl/installation.md b/website/versioned_docs/version-3.13.0/litmusctl/installation.md index 688ae8a2..674086a9 100644 --- a/website/versioned_docs/version-3.13.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.13.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.6.0 1.5.0 1.4.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.13.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.13.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.13.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.13.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.13.0/troubleshooting.md b/website/versioned_docs/version-3.13.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.13.0/troubleshooting.md +++ b/website/versioned_docs/version-3.13.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-advanced-installation.md index c913e3ba..5df686da 100644 --- a/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-oauth-dex-installation.md index 48dd6714..97166827 100644 --- a/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.13.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.13.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.13.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.13.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.13.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.13.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.13.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.13.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.13.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.13.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.13.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.13.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.13.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.13.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.13.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.13.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.13.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.13.0/user-guides/upgrade.md b/website/versioned_docs/version-3.13.0/user-guides/upgrade.md index eb86b646..495d4e07 100644 --- a/website/versioned_docs/version-3.13.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.13.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.13.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.13.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.14.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.14.0/developer-guide/chaoscenter-developer-guide.md index a4fd3d2d..3192dc49 100644 --- a/website/versioned_docs/version-3.14.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.14.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.14.0/faq.md b/website/versioned_docs/version-3.14.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.14.0/faq.md +++ b/website/versioned_docs/version-3.14.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.14.0/getting-started/installation.md b/website/versioned_docs/version-3.14.0/getting-started/installation.md index 1d4d04c4..d2978f5e 100644 --- a/website/versioned_docs/version-3.14.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.14.0/getting-started/installation.md @@ -114,7 +114,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -161,7 +161,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.14.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.14.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.14.0/integrations/backstage.md b/website/versioned_docs/version-3.14.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.14.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.14.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.14.0/integrations/grafana.md b/website/versioned_docs/version-3.14.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.14.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.14.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.14.0/introduction/community.md b/website/versioned_docs/version-3.14.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.14.0/introduction/community.md +++ b/website/versioned_docs/version-3.14.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.14.0/litmusctl/installation.md b/website/versioned_docs/version-3.14.0/litmusctl/installation.md index 688ae8a2..674086a9 100644 --- a/website/versioned_docs/version-3.14.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.14.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.6.0 1.5.0 1.4.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.14.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.14.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.14.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.14.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.14.0/troubleshooting.md b/website/versioned_docs/version-3.14.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.14.0/troubleshooting.md +++ b/website/versioned_docs/version-3.14.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-advanced-installation.md index 570c6379..d3d39edf 100644 --- a/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-oauth-dex-installation.md index 48dd6714..97166827 100644 --- a/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.14.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.14.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.14.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.14.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.14.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.14.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.14.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.14.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.14.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.14.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.14.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.14.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.14.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.14.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.14.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.14.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.14.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.14.0/user-guides/upgrade.md b/website/versioned_docs/version-3.14.0/user-guides/upgrade.md index cbeece1c..d0e96073 100644 --- a/website/versioned_docs/version-3.14.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.14.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.14.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.14.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.15.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.15.0/developer-guide/chaoscenter-developer-guide.md index a4fd3d2d..3192dc49 100644 --- a/website/versioned_docs/version-3.15.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.15.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.15.0/faq.md b/website/versioned_docs/version-3.15.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.15.0/faq.md +++ b/website/versioned_docs/version-3.15.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.15.0/getting-started/installation.md b/website/versioned_docs/version-3.15.0/getting-started/installation.md index a22c5429..6e24cf8c 100644 --- a/website/versioned_docs/version-3.15.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.15.0/getting-started/installation.md @@ -114,7 +114,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -161,7 +161,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.15.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.15.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.15.0/integrations/backstage.md b/website/versioned_docs/version-3.15.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.15.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.15.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.15.0/integrations/grafana.md b/website/versioned_docs/version-3.15.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.15.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.15.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.15.0/introduction/community.md b/website/versioned_docs/version-3.15.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.15.0/introduction/community.md +++ b/website/versioned_docs/version-3.15.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.15.0/litmusctl/installation.md b/website/versioned_docs/version-3.15.0/litmusctl/installation.md index 688ae8a2..674086a9 100644 --- a/website/versioned_docs/version-3.15.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.15.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.6.0 1.5.0 1.4.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.15.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.15.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.15.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.15.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.15.0/troubleshooting.md b/website/versioned_docs/version-3.15.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.15.0/troubleshooting.md +++ b/website/versioned_docs/version-3.15.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-advanced-installation.md index b79dddc8..4b01381d 100644 --- a/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-oauth-dex-installation.md index 48dd6714..97166827 100644 --- a/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.15.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.15.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.15.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.15.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.15.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.15.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.15.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.15.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.15.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.15.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.15.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.15.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.15.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.15.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.15.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.15.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.15.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.15.0/user-guides/upgrade.md b/website/versioned_docs/version-3.15.0/user-guides/upgrade.md index a781c55f..30bb74ff 100644 --- a/website/versioned_docs/version-3.15.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.15.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.15.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.15.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.16.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.16.0/developer-guide/chaoscenter-developer-guide.md index a4fd3d2d..3192dc49 100644 --- a/website/versioned_docs/version-3.16.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.16.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.16.0/faq.md b/website/versioned_docs/version-3.16.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.16.0/faq.md +++ b/website/versioned_docs/version-3.16.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.16.0/getting-started/installation.md b/website/versioned_docs/version-3.16.0/getting-started/installation.md index 2e03125e..9a125c12 100644 --- a/website/versioned_docs/version-3.16.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.16.0/getting-started/installation.md @@ -114,7 +114,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -161,7 +161,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.16.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.16.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.16.0/integrations/backstage.md b/website/versioned_docs/version-3.16.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.16.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.16.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.16.0/integrations/grafana.md b/website/versioned_docs/version-3.16.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.16.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.16.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.16.0/introduction/community.md b/website/versioned_docs/version-3.16.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.16.0/introduction/community.md +++ b/website/versioned_docs/version-3.16.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.16.0/litmusctl/installation.md b/website/versioned_docs/version-3.16.0/litmusctl/installation.md index 688ae8a2..674086a9 100644 --- a/website/versioned_docs/version-3.16.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.16.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.6.0 1.5.0 1.4.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.16.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.16.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.16.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.16.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.16.0/troubleshooting.md b/website/versioned_docs/version-3.16.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.16.0/troubleshooting.md +++ b/website/versioned_docs/version-3.16.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-advanced-installation.md index e55f4490..a6337a6d 100644 --- a/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-oauth-dex-installation.md index 48dd6714..97166827 100644 --- a/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.16.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.16.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.16.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.16.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.16.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.16.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.16.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.16.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.16.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.16.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.16.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.16.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.16.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.16.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.16.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.16.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.16.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.16.0/user-guides/upgrade.md b/website/versioned_docs/version-3.16.0/user-guides/upgrade.md index 1ce607b0..84e2af74 100644 --- a/website/versioned_docs/version-3.16.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.16.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.16.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.16.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.17.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.17.0/developer-guide/chaoscenter-developer-guide.md index 73ede222..273b9e9c 100644 --- a/website/versioned_docs/version-3.17.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.17.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.17.0/faq.md b/website/versioned_docs/version-3.17.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.17.0/faq.md +++ b/website/versioned_docs/version-3.17.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.17.0/getting-started/installation.md b/website/versioned_docs/version-3.17.0/getting-started/installation.md index 99c20094..f045cfd7 100644 --- a/website/versioned_docs/version-3.17.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.17.0/getting-started/installation.md @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.17.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.17.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.17.0/integrations/backstage.md b/website/versioned_docs/version-3.17.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.17.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.17.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.17.0/integrations/grafana.md b/website/versioned_docs/version-3.17.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.17.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.17.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.17.0/introduction/community.md b/website/versioned_docs/version-3.17.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.17.0/introduction/community.md +++ b/website/versioned_docs/version-3.17.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.17.0/litmusctl/installation.md b/website/versioned_docs/version-3.17.0/litmusctl/installation.md index c0a2d469..0c62e818 100644 --- a/website/versioned_docs/version-3.17.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.17.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.12.0 1.11.0 1.10.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.17.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.17.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.17.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.17.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.17.0/troubleshooting.md b/website/versioned_docs/version-3.17.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.17.0/troubleshooting.md +++ b/website/versioned_docs/version-3.17.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-advanced-installation.md index 1b830c79..375bb7df 100644 --- a/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-oauth-dex-installation.md index 9fed10ee..7d2e202d 100644 --- a/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.17.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.17.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.17.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.17.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.17.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.17.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.17.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.17.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.17.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.17.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.17.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.17.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.17.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.17.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.17.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.17.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.17.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.17.0/user-guides/upgrade.md b/website/versioned_docs/version-3.17.0/user-guides/upgrade.md index b12fc4b1..ab7f0f37 100644 --- a/website/versioned_docs/version-3.17.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.17.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.17.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.17.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.18.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.18.0/developer-guide/chaoscenter-developer-guide.md index 73ede222..273b9e9c 100644 --- a/website/versioned_docs/version-3.18.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.18.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.18.0/faq.md b/website/versioned_docs/version-3.18.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.18.0/faq.md +++ b/website/versioned_docs/version-3.18.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.18.0/getting-started/installation.md b/website/versioned_docs/version-3.18.0/getting-started/installation.md index a508dabd..0c41cfd7 100644 --- a/website/versioned_docs/version-3.18.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.18.0/getting-started/installation.md @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.18.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.18.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.18.0/integrations/backstage.md b/website/versioned_docs/version-3.18.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.18.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.18.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.18.0/integrations/grafana.md b/website/versioned_docs/version-3.18.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.18.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.18.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.18.0/introduction/community.md b/website/versioned_docs/version-3.18.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.18.0/introduction/community.md +++ b/website/versioned_docs/version-3.18.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.18.0/litmusctl/installation.md b/website/versioned_docs/version-3.18.0/litmusctl/installation.md index c0a2d469..0c62e818 100644 --- a/website/versioned_docs/version-3.18.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.18.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.12.0 1.11.0 1.10.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.18.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.18.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.18.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.18.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.18.0/troubleshooting.md b/website/versioned_docs/version-3.18.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.18.0/troubleshooting.md +++ b/website/versioned_docs/version-3.18.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-advanced-installation.md index e7fa038b..b00ceb4e 100644 --- a/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-oauth-dex-installation.md index 9fed10ee..7d2e202d 100644 --- a/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.18.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.18.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.18.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.18.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.18.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.18.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.18.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.18.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.18.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.18.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.18.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.18.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.18.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.18.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.18.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.18.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.18.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.18.0/user-guides/upgrade.md b/website/versioned_docs/version-3.18.0/user-guides/upgrade.md index c6613de1..1ae02b9a 100644 --- a/website/versioned_docs/version-3.18.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.18.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.18.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.18.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.19.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.19.0/developer-guide/chaoscenter-developer-guide.md index 73ede222..273b9e9c 100644 --- a/website/versioned_docs/version-3.19.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.19.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.19.0/faq.md b/website/versioned_docs/version-3.19.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.19.0/faq.md +++ b/website/versioned_docs/version-3.19.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.19.0/getting-started/installation.md b/website/versioned_docs/version-3.19.0/getting-started/installation.md index b0a1e812..ccf625fe 100644 --- a/website/versioned_docs/version-3.19.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.19.0/getting-started/installation.md @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.19.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.19.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.19.0/integrations/backstage.md b/website/versioned_docs/version-3.19.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.19.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.19.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.19.0/integrations/grafana.md b/website/versioned_docs/version-3.19.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.19.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.19.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.19.0/introduction/community.md b/website/versioned_docs/version-3.19.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.19.0/introduction/community.md +++ b/website/versioned_docs/version-3.19.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.19.0/litmusctl/installation.md b/website/versioned_docs/version-3.19.0/litmusctl/installation.md index c0a2d469..0c62e818 100644 --- a/website/versioned_docs/version-3.19.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.19.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.12.0 1.11.0 1.10.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.19.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.19.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.19.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.19.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.19.0/troubleshooting.md b/website/versioned_docs/version-3.19.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.19.0/troubleshooting.md +++ b/website/versioned_docs/version-3.19.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-advanced-installation.md index 046c441e..cbd76f05 100644 --- a/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-oauth-dex-installation.md index 9fed10ee..7d2e202d 100644 --- a/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.19.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.19.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.19.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.19.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.19.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.19.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.19.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.19.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.19.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.19.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.19.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.19.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.19.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.19.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.19.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.19.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.19.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.19.0/user-guides/upgrade.md b/website/versioned_docs/version-3.19.0/user-guides/upgrade.md index 39c62203..0c635e76 100644 --- a/website/versioned_docs/version-3.19.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.19.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.19.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.19.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.2.0/faq.md b/website/versioned_docs/version-3.2.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.2.0/faq.md +++ b/website/versioned_docs/version-3.2.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.2.0/getting-started/installation.md b/website/versioned_docs/version-3.2.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.2.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.2.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.2.0/getting-started/resources.md b/website/versioned_docs/version-3.2.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.2.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.2.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.2.0/integrations/backstage.md b/website/versioned_docs/version-3.2.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.2.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.2.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.2.0/integrations/grafana.md b/website/versioned_docs/version-3.2.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.2.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.2.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.2.0/introduction/community.md b/website/versioned_docs/version-3.2.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.2.0/introduction/community.md +++ b/website/versioned_docs/version-3.2.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.2.0/litmusctl/installation.md b/website/versioned_docs/version-3.2.0/litmusctl/installation.md index b3e62922..1caf4eb9 100644 --- a/website/versioned_docs/version-3.2.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.2.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 0.21.0 0.20.0 0.19.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.2.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.2.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.2.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.2.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.2.0/troubleshooting.md b/website/versioned_docs/version-3.2.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.2.0/troubleshooting.md +++ b/website/versioned_docs/version-3.2.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-namespace-scope-installation.md index ca4b07bd..d20aa8ea 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.2.0/litmus-namespaced-3.2.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.2.0/litmus-namespaced-3.2.0.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.2.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.2.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.2.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.2.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.2.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.2.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.2.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.2.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.2.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.2.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.2.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.2.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.2.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.2.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.2.0/user-guides/uninstall-litmus.md index 66be68fa..32fc791c 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.2.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.2.0/user-guides/upgrade.md b/website/versioned_docs/version-3.2.0/user-guides/upgrade.md index 146ec7ff..419ac052 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.2.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.1.0 to 3.2.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.20.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.20.0/developer-guide/chaoscenter-developer-guide.md index 73ede222..273b9e9c 100644 --- a/website/versioned_docs/version-3.20.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.20.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.20.0/faq.md b/website/versioned_docs/version-3.20.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.20.0/faq.md +++ b/website/versioned_docs/version-3.20.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.20.0/getting-started/installation.md b/website/versioned_docs/version-3.20.0/getting-started/installation.md index ab53892d..f712e43a 100644 --- a/website/versioned_docs/version-3.20.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.20.0/getting-started/installation.md @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.20.0/integrations/backstage.md b/website/versioned_docs/version-3.20.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.20.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.20.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.20.0/integrations/grafana.md b/website/versioned_docs/version-3.20.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.20.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.20.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.20.0/introduction/community.md b/website/versioned_docs/version-3.20.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.20.0/introduction/community.md +++ b/website/versioned_docs/version-3.20.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.20.0/litmusctl/installation.md b/website/versioned_docs/version-3.20.0/litmusctl/installation.md index c0a2d469..0c62e818 100644 --- a/website/versioned_docs/version-3.20.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.20.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.12.0 1.11.0 1.10.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.20.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.20.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.20.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.20.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.20.0/troubleshooting.md b/website/versioned_docs/version-3.20.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.20.0/troubleshooting.md +++ b/website/versioned_docs/version-3.20.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-advanced-installation.md index 52d36cd3..fc944710 100644 --- a/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-oauth-dex-installation.md index 9fed10ee..7d2e202d 100644 --- a/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.20.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.20.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.20.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.20.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.20.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.20.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.20.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.20.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.20.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.20.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.20.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.20.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.20.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.20.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.20.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.20.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.20.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.20.0/user-guides/upgrade.md b/website/versioned_docs/version-3.20.0/user-guides/upgrade.md index 3c6514ab..9b9cdb9a 100644 --- a/website/versioned_docs/version-3.20.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.20.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.21.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.21.0/developer-guide/chaoscenter-developer-guide.md index 73ede222..273b9e9c 100644 --- a/website/versioned_docs/version-3.21.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.21.0/developer-guide/chaoscenter-developer-guide.md @@ -127,7 +127,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -187,7 +187,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.21.0/faq.md b/website/versioned_docs/version-3.21.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.21.0/faq.md +++ b/website/versioned_docs/version-3.21.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.21.0/getting-started/installation.md b/website/versioned_docs/version-3.21.0/getting-started/installation.md index ab53892d..f712e43a 100644 --- a/website/versioned_docs/version-3.21.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.21.0/getting-started/installation.md @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.21.0/integrations/backstage.md b/website/versioned_docs/version-3.21.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.21.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.21.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.21.0/integrations/grafana.md b/website/versioned_docs/version-3.21.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.21.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.21.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.21.0/introduction/community.md b/website/versioned_docs/version-3.21.0/introduction/community.md index a4744bae..6f5ae46e 100644 --- a/website/versioned_docs/version-3.21.0/introduction/community.md +++ b/website/versioned_docs/version-3.21.0/introduction/community.md @@ -71,18 +71,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.21.0/litmusctl/installation.md b/website/versioned_docs/version-3.21.0/litmusctl/installation.md index c0a2d469..0c62e818 100644 --- a/website/versioned_docs/version-3.21.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.21.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.12.0 1.11.0 1.10.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.21.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.21.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.21.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.21.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.21.0/troubleshooting.md b/website/versioned_docs/version-3.21.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.21.0/troubleshooting.md +++ b/website/versioned_docs/version-3.21.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-advanced-installation.md index 52d36cd3..fc944710 100644 --- a/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-oauth-dex-installation.md index 48dd6714..97166827 100644 --- a/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.21.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.21.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.21.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.21.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.21.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.21.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.21.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.21.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.21.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.21.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.21.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.21.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.21.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.21.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.21.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.21.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.21.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.21.0/user-guides/upgrade.md b/website/versioned_docs/version-3.21.0/user-guides/upgrade.md index 3c6514ab..9b9cdb9a 100644 --- a/website/versioned_docs/version-3.21.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.21.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.22.0/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.22.0/developer-guide/chaoscenter-developer-guide.md index 2df27bd9..0d631e2b 100644 --- a/website/versioned_docs/version-3.22.0/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.22.0/developer-guide/chaoscenter-developer-guide.md @@ -131,7 +131,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -191,7 +191,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.22.0/faq.md b/website/versioned_docs/version-3.22.0/faq.md index 8b938e12..0317a292 100644 --- a/website/versioned_docs/version-3.22.0/faq.md +++ b/website/versioned_docs/version-3.22.0/faq.md @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.22.0/getting-started/installation.md b/website/versioned_docs/version-3.22.0/getting-started/installation.md index ab53892d..f712e43a 100644 --- a/website/versioned_docs/version-3.22.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.22.0/getting-started/installation.md @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.22.0/integrations/backstage.md b/website/versioned_docs/version-3.22.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.22.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.22.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.22.0/integrations/grafana.md b/website/versioned_docs/version-3.22.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.22.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.22.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.22.0/introduction/community.md b/website/versioned_docs/version-3.22.0/introduction/community.md index 6b0eceaa..632c9174 100644 --- a/website/versioned_docs/version-3.22.0/introduction/community.md +++ b/website/versioned_docs/version-3.22.0/introduction/community.md @@ -72,18 +72,18 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/). We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured. -Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md). +Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md). ### Contribute to Litmus open source -See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md). +See the Litmus [contribution document](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md). Contributors meet twice a month. See [Contributor meetings](#contributor-meetings). -- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload. -- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md). -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). Other Litmus open source links: diff --git a/website/versioned_docs/version-3.22.0/litmusctl/additional-commands.md b/website/versioned_docs/version-3.22.0/litmusctl/additional-commands.md index 12a7673d..45e47613 100644 --- a/website/versioned_docs/version-3.22.0/litmusctl/additional-commands.md +++ b/website/versioned_docs/version-3.22.0/litmusctl/additional-commands.md @@ -7,7 +7,7 @@ sidebar_label: Additional Commands This guide covers additional litmusctl commands for managing your ChaosCenter account, projects, environments, and chaos infrastructures. -Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#additional-commands) to learn more about litmusctl commands. +Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md#additional-commands) to learn more about litmusctl commands. --- diff --git a/website/versioned_docs/version-3.22.0/litmusctl/connect-chaos-infrastructure.md b/website/versioned_docs/version-3.22.0/litmusctl/connect-chaos-infrastructure.md index eb13f328..cc469b1c 100644 --- a/website/versioned_docs/version-3.22.0/litmusctl/connect-chaos-infrastructure.md +++ b/website/versioned_docs/version-3.22.0/litmusctl/connect-chaos-infrastructure.md @@ -8,4 +8,4 @@ sidebar_label: Connect Chaos Infrastructure This guide walks you through connecting a Chaos Infrastructure to your ChaosCenter using litmusctl. A Chaos Infrastructure is required to run chaos experiments in your Kubernetes cluster. -Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture) to connect a Chaos Infrastructure. +Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture) to connect a Chaos Infrastructure. diff --git a/website/versioned_docs/version-3.22.0/litmusctl/installation.md b/website/versioned_docs/version-3.22.0/litmusctl/installation.md index 8ebfa231..2e38c88c 100644 --- a/website/versioned_docs/version-3.22.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.22.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -37,7 +37,7 @@ To install the latest version of litmusctl follow the below steps: 1.12.0 1.11.0 1.10.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -49,7 +49,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -62,7 +62,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -75,7 +75,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -88,7 +88,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -101,7 +101,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -114,7 +114,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -127,7 +127,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -140,7 +140,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.22.0/troubleshooting.md b/website/versioned_docs/version-3.22.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.22.0/troubleshooting.md +++ b/website/versioned_docs/version-3.22.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-advanced-installation.md index 52d36cd3..fc944710 100644 --- a/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-oauth-dex-installation.md index 95bfe5db..59961841 100644 --- a/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.22.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub client credentials ready. If you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.22.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.22.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.22.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.22.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.22.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.22.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.22.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.22.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.22.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.22.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.22.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.22.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.22.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.22.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.22.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.22.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.22.0/user-guides/upgrade.md b/website/versioned_docs/version-3.22.0/user-guides/upgrade.md index 3c6514ab..9b9cdb9a 100644 --- a/website/versioned_docs/version-3.22.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.22.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.3.0/faq.md b/website/versioned_docs/version-3.3.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.3.0/faq.md +++ b/website/versioned_docs/version-3.3.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.3.0/getting-started/installation.md b/website/versioned_docs/version-3.3.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.3.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.3.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.3.0/getting-started/resources.md b/website/versioned_docs/version-3.3.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.3.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.3.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.3.0/integrations/backstage.md b/website/versioned_docs/version-3.3.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.3.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.3.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.3.0/integrations/grafana.md b/website/versioned_docs/version-3.3.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.3.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.3.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.3.0/introduction/community.md b/website/versioned_docs/version-3.3.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.3.0/introduction/community.md +++ b/website/versioned_docs/version-3.3.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.3.0/litmusctl/installation.md b/website/versioned_docs/version-3.3.0/litmusctl/installation.md index 96728699..278b91ba 100644 --- a/website/versioned_docs/version-3.3.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.3.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 0.22.0 0.21.0 0.20.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.3.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.3.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.3.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.3.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.3.0/troubleshooting.md b/website/versioned_docs/version-3.3.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.3.0/troubleshooting.md +++ b/website/versioned_docs/version-3.3.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-namespace-scope-installation.md index 71da974a..9888950d 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.3.0/litmus-namespaced-3.3.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.3.0/litmus-namespaced-3.3.0.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.3.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.3.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.3.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.3.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.3.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.3.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.3.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.3.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.3.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.3.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.3.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.3.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.3.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.3.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.3.0/user-guides/uninstall-litmus.md index f90063a8..c6a5f802 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.3.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.3.0/user-guides/upgrade.md b/website/versioned_docs/version-3.3.0/user-guides/upgrade.md index ecd66957..452e9bc4 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.3.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.2.0 to 3.3.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.4.0/faq.md b/website/versioned_docs/version-3.4.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.4.0/faq.md +++ b/website/versioned_docs/version-3.4.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.4.0/getting-started/installation.md b/website/versioned_docs/version-3.4.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.4.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.4.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.4.0/getting-started/resources.md b/website/versioned_docs/version-3.4.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.4.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.4.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.4.0/integrations/backstage.md b/website/versioned_docs/version-3.4.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.4.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.4.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.4.0/integrations/grafana.md b/website/versioned_docs/version-3.4.0/integrations/grafana.md index f58b5121..6ab2b0d6 100644 --- a/website/versioned_docs/version-3.4.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.4.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.4.0/introduction/community.md b/website/versioned_docs/version-3.4.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.4.0/introduction/community.md +++ b/website/versioned_docs/version-3.4.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.4.0/litmusctl/installation.md b/website/versioned_docs/version-3.4.0/litmusctl/installation.md index 1958bafa..24838732 100644 --- a/website/versioned_docs/version-3.4.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.4.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 0.23.0 0.22.0 0.21.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.4.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.4.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.4.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.4.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.4.0/troubleshooting.md b/website/versioned_docs/version-3.4.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.4.0/troubleshooting.md +++ b/website/versioned_docs/version-3.4.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-namespace-scope-installation.md index 80754755..35d26c13 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.4.0/litmus-namespaced-3.4.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.4.0/litmus-namespaced-3.4.0.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.4.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.4.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.4.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.4.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.4.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.4.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.4.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.4.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.4.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.4.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.4.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.4.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.4.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.4.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.4.0/user-guides/uninstall-litmus.md index 8862fc2f..a5323420 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.4.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.4.0/user-guides/upgrade.md b/website/versioned_docs/version-3.4.0/user-guides/upgrade.md index 9ee2846d..210dd650 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.4.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.3.0 to 3.4.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.5.0/faq.md b/website/versioned_docs/version-3.5.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.5.0/faq.md +++ b/website/versioned_docs/version-3.5.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.5.0/getting-started/installation.md b/website/versioned_docs/version-3.5.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.5.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.5.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.5.0/getting-started/resources.md b/website/versioned_docs/version-3.5.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.5.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.5.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.5.0/integrations/backstage.md b/website/versioned_docs/version-3.5.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.5.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.5.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.5.0/integrations/grafana.md b/website/versioned_docs/version-3.5.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.5.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.5.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.5.0/introduction/community.md b/website/versioned_docs/version-3.5.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.5.0/introduction/community.md +++ b/website/versioned_docs/version-3.5.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.5.0/litmusctl/installation.md b/website/versioned_docs/version-3.5.0/litmusctl/installation.md index 3da34f6d..1379e29f 100644 --- a/website/versioned_docs/version-3.5.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.5.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 0.24.0 0.23.0 0.22.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.5.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.5.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.5.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.5.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.5.0/troubleshooting.md b/website/versioned_docs/version-3.5.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.5.0/troubleshooting.md +++ b/website/versioned_docs/version-3.5.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-namespace-scope-installation.md index 73f24ab9..992b5670 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.5.0/litmus-namespaced-3.5.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.5.0/litmus-namespaced-3.5.0.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.5.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.5.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.5.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.5.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.5.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.5.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.5.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.5.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.5.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.5.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.5.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.5.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.5.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.5.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.5.0/user-guides/uninstall-litmus.md index 59822ea2..e7976dc5 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.5.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.5.0/user-guides/upgrade.md b/website/versioned_docs/version-3.5.0/user-guides/upgrade.md index 0819e2bd..62de7ce5 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.5.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.4.0 to 3.5.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.6.0/faq.md b/website/versioned_docs/version-3.6.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.6.0/faq.md +++ b/website/versioned_docs/version-3.6.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.6.0/getting-started/installation.md b/website/versioned_docs/version-3.6.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.6.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.6.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.6.0/getting-started/resources.md b/website/versioned_docs/version-3.6.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.6.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.6.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.6.0/integrations/backstage.md b/website/versioned_docs/version-3.6.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.6.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.6.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.6.0/integrations/grafana.md b/website/versioned_docs/version-3.6.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.6.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.6.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.6.0/introduction/community.md b/website/versioned_docs/version-3.6.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.6.0/introduction/community.md +++ b/website/versioned_docs/version-3.6.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.6.0/litmusctl/installation.md b/website/versioned_docs/version-3.6.0/litmusctl/installation.md index 1247616e..20fb6492 100644 --- a/website/versioned_docs/version-3.6.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.6.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.0.0 0.24.0 0.23.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.6.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.6.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.6.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.6.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.6.0/troubleshooting.md b/website/versioned_docs/version-3.6.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.6.0/troubleshooting.md +++ b/website/versioned_docs/version-3.6.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-namespace-scope-installation.md index ba309221..e6e03764 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.6.0/litmus-namespaced-3.6.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.6.0/litmus-namespaced-3.6.0.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.6.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.6.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.6.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.6.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.6.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.6.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.6.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.6.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.6.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.6.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.6.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.6.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.6.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.6.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.6.0/user-guides/uninstall-litmus.md index b5c42e49..d35ae99b 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.6.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.6.0/user-guides/upgrade.md b/website/versioned_docs/version-3.6.0/user-guides/upgrade.md index 8b21f8a3..589c954a 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.6.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.5.0 to 3.6.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.7.0/faq.md b/website/versioned_docs/version-3.7.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.7.0/faq.md +++ b/website/versioned_docs/version-3.7.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.7.0/getting-started/installation.md b/website/versioned_docs/version-3.7.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.7.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.7.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.7.0/getting-started/resources.md b/website/versioned_docs/version-3.7.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.7.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.7.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.7.0/integrations/backstage.md b/website/versioned_docs/version-3.7.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.7.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.7.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.7.0/integrations/grafana.md b/website/versioned_docs/version-3.7.0/integrations/grafana.md index 0df98d56..582236b4 100644 --- a/website/versioned_docs/version-3.7.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.7.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.7.0/introduction/community.md b/website/versioned_docs/version-3.7.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.7.0/introduction/community.md +++ b/website/versioned_docs/version-3.7.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.7.0/litmusctl/installation.md b/website/versioned_docs/version-3.7.0/litmusctl/installation.md index 4712a296..92f7ae20 100644 --- a/website/versioned_docs/version-3.7.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.7.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.1.0 1.0.0 0.24.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.7.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.7.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.7.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.7.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.7.0/troubleshooting.md b/website/versioned_docs/version-3.7.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.7.0/troubleshooting.md +++ b/website/versioned_docs/version-3.7.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-namespace-scope-installation.md index b6bf2b62..01db23b5 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -55,7 +55,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -119,7 +119,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -141,7 +141,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.7.0/litmus-namespaced-3.7.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.7.0/litmus-namespaced-3.7.0.yaml -n ``` > You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation diff --git a/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.7.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.7.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.7.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.7.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.7.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.7.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.7.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.7.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.7.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.7.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.7.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.7.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.7.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.7.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.7.0/user-guides/uninstall-litmus.md index 91889d04..e3fc1f9f 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.7.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.7.0/user-guides/upgrade.md b/website/versioned_docs/version-3.7.0/user-guides/upgrade.md index e606a745..e4b40790 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.7.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.6.0 to 3.7.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.8.0/faq.md b/website/versioned_docs/version-3.8.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.8.0/faq.md +++ b/website/versioned_docs/version-3.8.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.8.0/getting-started/installation.md b/website/versioned_docs/version-3.8.0/getting-started/installation.md index 46267699..bce8f7b8 100644 --- a/website/versioned_docs/version-3.8.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.8.0/getting-started/installation.md @@ -104,7 +104,7 @@ Visit https://docs.litmuschaos.io to find more info. ### **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). --- diff --git a/website/versioned_docs/version-3.8.0/getting-started/resources.md b/website/versioned_docs/version-3.8.0/getting-started/resources.md index 3896c0f8..f240317e 100644 --- a/website/versioned_docs/version-3.8.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.8.0/getting-started/resources.md @@ -12,7 +12,7 @@ sidebar_label: Resources **ChaosCenter comes pre-packaged** as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it. -> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/master/litmus-portal#platforms-support) +> [Get a broader view of which Platforms are supported by Litmus](https://github.com/litmuschaos/litmus/tree/main/litmus-portal#platforms-support) ChaosCenter gives you access to a plethora of features, the major ones include: diff --git a/website/versioned_docs/version-3.8.0/integrations/backstage.md b/website/versioned_docs/version-3.8.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.8.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.8.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.8.0/integrations/grafana.md b/website/versioned_docs/version-3.8.0/integrations/grafana.md index af717f1a..66c2d6a9 100644 --- a/website/versioned_docs/version-3.8.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.8.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.8.0/introduction/community.md b/website/versioned_docs/version-3.8.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.8.0/introduction/community.md +++ b/website/versioned_docs/version-3.8.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.8.0/litmusctl/installation.md b/website/versioned_docs/version-3.8.0/litmusctl/installation.md index c56e52f1..33432680 100644 --- a/website/versioned_docs/version-3.8.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.8.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.2.0 1.1.0 1.0.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.8.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.8.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.8.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.8.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.8.0/troubleshooting.md b/website/versioned_docs/version-3.8.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.8.0/troubleshooting.md +++ b/website/versioned_docs/version-3.8.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md index d07ddcf3..bfde11cc 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -57,7 +57,7 @@ kubectl create ns litmus The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -127,7 +127,7 @@ litmus Active 2s The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/chaoscenter/manifests/litmus-portal-crds.yml +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/chaoscenter/manifests/litmus-portal-crds.yml ``` Expected Output @@ -149,7 +149,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker. Applying the manifest file will install all the required service account configuration and ChaosCenter. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.8.0/litmus-namespaced-3.8.0.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.8.0/litmus-namespaced-3.8.0.yaml -n ``` :::note diff --git a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-oauth-dex-installation.md index 2a47e80a..971d461e 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.8.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.8.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.8.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.8.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.8.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.8.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.8.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.8.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.8.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.8.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.8.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.8.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.8.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.8.0/user-guides/uninstall-litmus.md index bee683dc..28a7e99e 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.8.0/user-guides/uninstall-litmus.md @@ -84,7 +84,7 @@ If the Litmus CRDs are deleted in the Cluster Scope all the respective custom re To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/litmus-portal-crds.yml ``` --- @@ -110,7 +110,7 @@ To uninstall the ChaosCenter from the system, follow these steps - - **Litmus Master Manifest** ```bash - kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/manifests/cluster-k8s-manifest.yml + kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/manifests/cluster-k8s-manifest.yml ``` #### For Namespace Scope diff --git a/website/versioned_docs/version-3.8.0/user-guides/upgrade.md b/website/versioned_docs/version-3.8.0/user-guides/upgrade.md index fb2ad64c..58e57700 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.8.0/user-guides/upgrade.md @@ -23,9 +23,9 @@ To upgrade Litmus ChaosCenter from 3.7.0 to 3.8.0, you can follow these steps: > Note: This step is not required if using Helm, Helm upgrade should work. -To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. +To upgrade the DB schema, deploy the [upgrade-agent](https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml) in your k8s cluster where ChaosCenter is installed. This manifest will create a Job, which will upgrade the mongoDB schema. -`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` +`kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/litmus-portal/upgrade-agents/control-plane/upgrade-agent.yaml` ## Upgrade Chaos Delegate @@ -41,4 +41,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.9.0/faq.md b/website/versioned_docs/version-3.9.0/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.9.0/faq.md +++ b/website/versioned_docs/version-3.9.0/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.9.0/getting-started/installation.md b/website/versioned_docs/version-3.9.0/getting-started/installation.md index 7d68fe32..93945c2d 100644 --- a/website/versioned_docs/version-3.9.0/getting-started/installation.md +++ b/website/versioned_docs/version-3.9.0/getting-started/installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -153,7 +153,7 @@ Litmus supports for HTTP and HTTPS mode of installation. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.0/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.0/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS based and CORS rules apply) diff --git a/website/versioned_docs/version-3.9.0/integrations/backstage.md b/website/versioned_docs/version-3.9.0/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.9.0/integrations/backstage.md +++ b/website/versioned_docs/version-3.9.0/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.9.0/integrations/grafana.md b/website/versioned_docs/version-3.9.0/integrations/grafana.md index af717f1a..66c2d6a9 100644 --- a/website/versioned_docs/version-3.9.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.9.0/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.9.0/introduction/community.md b/website/versioned_docs/version-3.9.0/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.9.0/introduction/community.md +++ b/website/versioned_docs/version-3.9.0/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.9.0/litmusctl/installation.md b/website/versioned_docs/version-3.9.0/litmusctl/installation.md index 2cebf580..2f2adb51 100644 --- a/website/versioned_docs/version-3.9.0/litmusctl/installation.md +++ b/website/versioned_docs/version-3.9.0/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.3.0 1.2.0 1.1.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.9.0/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.9.0/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.9.0/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.9.0/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.9.0/troubleshooting.md b/website/versioned_docs/version-3.9.0/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.9.0/troubleshooting.md +++ b/website/versioned_docs/version-3.9.0/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-advanced-installation.md index ecfdccea..f029a6fd 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret @@ -161,7 +161,7 @@ Litmus supports for HTTP and HTTPS mode of installation. 3. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.0/litmus-installation.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.0/litmus-installation.yaml -n ``` --- diff --git a/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-oauth-dex-installation.md index 8923a565..a36b4024 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.9.0/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.9.0/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.9.0/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.9.0/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.9.0/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.9.0/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.9.0/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.9.0/user-guides/setup-datasource.md b/website/versioned_docs/version-3.9.0/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.9.0/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.9.0/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.9.0/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.9.0/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.9.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.9.0/user-guides/uninstall-litmus.md index 60149e73..c5ac23d5 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.9.0/user-guides/uninstall-litmus.md @@ -70,7 +70,7 @@ kubectl delete sa rolebindings role --all -n To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.0/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.0/litmus-portal-crds.yml ``` --- diff --git a/website/versioned_docs/version-3.9.0/user-guides/upgrade.md b/website/versioned_docs/version-3.9.0/user-guides/upgrade.md index be98e3d9..f9830186 100644 --- a/website/versioned_docs/version-3.9.0/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.9.0/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.0/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.0/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.9.1/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.9.1/developer-guide/chaoscenter-developer-guide.md index 021405ff..bb2413b7 100644 --- a/website/versioned_docs/version-3.9.1/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.9.1/developer-guide/chaoscenter-developer-guide.md @@ -129,7 +129,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -189,7 +189,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.9.1/faq.md b/website/versioned_docs/version-3.9.1/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.9.1/faq.md +++ b/website/versioned_docs/version-3.9.1/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.9.1/getting-started/installation.md b/website/versioned_docs/version-3.9.1/getting-started/installation.md index 01980b2c..eca1c8ac 100644 --- a/website/versioned_docs/version-3.9.1/getting-started/installation.md +++ b/website/versioned_docs/version-3.9.1/getting-started/installation.md @@ -107,7 +107,7 @@ Litmus uses Kubernetes CRDs to define the chaos intent. Helm3 handles CRDs bette ### Install Litmus using kubectl -You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). #### Install Mongo @@ -154,7 +154,7 @@ Litmus supports HTTP and HTTPS mode of installation. Applying the manifest file installs all the required service account configuration and ChaosCenter in the namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS-based and CORS rules apply) diff --git a/website/versioned_docs/version-3.9.1/integrations/backstage.md b/website/versioned_docs/version-3.9.1/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.9.1/integrations/backstage.md +++ b/website/versioned_docs/version-3.9.1/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.9.1/integrations/grafana.md b/website/versioned_docs/version-3.9.1/integrations/grafana.md index af717f1a..66c2d6a9 100644 --- a/website/versioned_docs/version-3.9.1/integrations/grafana.md +++ b/website/versioned_docs/version-3.9.1/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.9.1/introduction/community.md b/website/versioned_docs/version-3.9.1/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.9.1/introduction/community.md +++ b/website/versioned_docs/version-3.9.1/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.9.1/litmusctl/installation.md b/website/versioned_docs/version-3.9.1/litmusctl/installation.md index 2cebf580..2f2adb51 100644 --- a/website/versioned_docs/version-3.9.1/litmusctl/installation.md +++ b/website/versioned_docs/version-3.9.1/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.3.0 1.2.0 1.1.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.9.1/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.9.1/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.9.1/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.9.1/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.9.1/troubleshooting.md b/website/versioned_docs/version-3.9.1/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.9.1/troubleshooting.md +++ b/website/versioned_docs/version-3.9.1/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-advanced-installation.md index 99e02ae0..63e5ab96 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret @@ -161,7 +161,7 @@ Litmus supports for HTTP and HTTPS mode of installation. 3. Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope. ```bash -kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-installation.yaml -n +kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-installation.yaml -n ``` --- diff --git a/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-oauth-dex-installation.md index 8923a565..a36b4024 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.9.1/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.9.1/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.9.1/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.9.1/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.9.1/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.9.1/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.9.1/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.9.1/user-guides/setup-datasource.md b/website/versioned_docs/version-3.9.1/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.9.1/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.9.1/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.9.1/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.9.1/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.9.1/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.9.1/user-guides/uninstall-litmus.md index 14def808..c668ed5b 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.9.1/user-guides/uninstall-litmus.md @@ -70,7 +70,7 @@ kubectl delete sa rolebindings role --all -n To remove all the CRDs Litmus uses, use the following command: ```bash -kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-portal-crds.yml +kubectl delete -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-portal-crds.yml ``` --- diff --git a/website/versioned_docs/version-3.9.1/user-guides/upgrade.md b/website/versioned_docs/version-3.9.1/user-guides/upgrade.md index 51b9b755..5ed9d15c 100644 --- a/website/versioned_docs/version-3.9.1/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.9.1/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required. diff --git a/website/versioned_docs/version-3.9.2/developer-guide/chaoscenter-developer-guide.md b/website/versioned_docs/version-3.9.2/developer-guide/chaoscenter-developer-guide.md index 021405ff..bb2413b7 100644 --- a/website/versioned_docs/version-3.9.2/developer-guide/chaoscenter-developer-guide.md +++ b/website/versioned_docs/version-3.9.2/developer-guide/chaoscenter-developer-guide.md @@ -129,7 +129,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main export ENABLE_INTERNAL_TLS=false export REST_PORT=3000 export GRPC_PORT=3030 @@ -189,7 +189,7 @@ export VERSION=ci export HUB_BRANCH_NAME=v2.0.x export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' -export DEFAULT_HUB_BRANCH_NAME=master +export DEFAULT_HUB_BRANCH_NAME=main ``` Step-2: Run the go application diff --git a/website/versioned_docs/version-3.9.2/faq.md b/website/versioned_docs/version-3.9.2/faq.md index 3586151c..0102ad61 100644 --- a/website/versioned_docs/version-3.9.2/faq.md +++ b/website/versioned_docs/version-3.9.2/faq.md @@ -74,7 +74,7 @@ Once GitOps is enabled, any new chaos experiments created will be stored in the ### Does Litmusctl support actions that are currently performed from the portal dashboard? -Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md). +Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md). ### How to solve `invalid token` issue in litmusctl? diff --git a/website/versioned_docs/version-3.9.2/getting-started/installation.md b/website/versioned_docs/version-3.9.2/getting-started/installation.md index 01980b2c..eca1c8ac 100644 --- a/website/versioned_docs/version-3.9.2/getting-started/installation.md +++ b/website/versioned_docs/version-3.9.2/getting-started/installation.md @@ -107,7 +107,7 @@ Litmus uses Kubernetes CRDs to define the chaos intent. Helm3 handles CRDs bette ### Install Litmus using kubectl -You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). #### Install Mongo @@ -154,7 +154,7 @@ Litmus supports HTTP and HTTPS mode of installation. Applying the manifest file installs all the required service account configuration and ChaosCenter in the namespaced scope. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n ``` ### Advanced installation (HTTPS-based and CORS rules apply) diff --git a/website/versioned_docs/version-3.9.2/integrations/backstage.md b/website/versioned_docs/version-3.9.2/integrations/backstage.md index 92bbf335..0ecb6438 100644 --- a/website/versioned_docs/version-3.9.2/integrations/backstage.md +++ b/website/versioned_docs/version-3.9.2/integrations/backstage.md @@ -16,7 +16,7 @@ sidebar_label: Backstage - See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.). - Provide a direct link to Litmus. -![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png) +![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png) ### EntityLitmusContent @@ -29,7 +29,7 @@ sidebar_label: Backstage - If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status. - We can directly launch chaos experiments by clicking the play button. -![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png) +![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png) ## Before you begin @@ -47,9 +47,9 @@ sidebar_label: Backstage 1. Click "SETTINGS" in the sidebar. 2. Click "+ New Token" Button in the 'API Tokens' section. - ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png) + ![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png) 3. Enter your information and click "Confirm". - ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png) + ![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png) 4. Get the token in the "VALUE" column. 3. In the `app-config.yaml` file root directory, add litmus proxy and info like below diff --git a/website/versioned_docs/version-3.9.2/integrations/grafana.md b/website/versioned_docs/version-3.9.2/integrations/grafana.md index af717f1a..66c2d6a9 100644 --- a/website/versioned_docs/version-3.9.2/integrations/grafana.md +++ b/website/versioned_docs/version-3.9.2/integrations/grafana.md @@ -6,7 +6,7 @@ sidebar_label: Grafana --- -Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards) +Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards) ## Before you begin @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin` #### Chaos Result selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true) #### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true) #### Chaos Engines with Experiments as Chaos Results: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true) #### Chaos event annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true) #### Chaos Result verdict annotations: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true) #### Interleaved Chaos events: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true) #### Interleaved Chaos Result verdicts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true) #### Chaos Result verdict failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true) #### Chaos Result probe failure alerts: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true) #### Systems healthy / in steady state OR no alerts to be issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true) #### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true) #### Alerts issued: -![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) +![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true) ## Chaos interleaving over infra and application metrics diff --git a/website/versioned_docs/version-3.9.2/introduction/community.md b/website/versioned_docs/version-3.9.2/introduction/community.md index 27872b94..59945fad 100644 --- a/website/versioned_docs/version-3.9.2/introduction/community.md +++ b/website/versioned_docs/version-3.9.2/introduction/community.md @@ -68,16 +68,16 @@ We invite contributions in all forms. Join us in writing blogs on DEV.to about e ## How to Contribute -- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-). +- If you are a first-time contributor, please see [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-). - If you would like to suggest new tests to be added to litmus, please go ahead and [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. All you need to do is specify the workload type and the operations that you would like to perform on the workload. - If you would like to work on something more involved, please connect with the Litmus Contributors. -- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work). +- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work). ### Contribute your chaos experiments We are devoted to being an open source driven community and appeal to our community members to contribute chaos experiments, file issues, raise pull requests, and provide feedback to help enhance the user experience and bring in new enhancements to develop LitmusChaos. -Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). +Check out the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md) page on [Litmus repository](https://github.com/litmuschaos/litmus) for instructions on how to contribute. Feel free to discuss about your contributions on [our slack channel](https://slack.litmuschaos.io/). ## Learn more diff --git a/website/versioned_docs/version-3.9.2/litmusctl/installation.md b/website/versioned_docs/version-3.9.2/litmusctl/installation.md index 2cebf580..2f2adb51 100644 --- a/website/versioned_docs/version-3.9.2/litmusctl/installation.md +++ b/website/versioned_docs/version-3.9.2/litmusctl/installation.md @@ -20,7 +20,7 @@ Litmusctl CLI requires the following things: For more information including a complete list of litmusctl operations, see the litmusctl reference documentation. -- For 0.23.0 or latest: Click here +- For 0.23.0 or latest: Click here ## Installation @@ -36,7 +36,7 @@ To install the latest version of litmusctl follow the below steps: 1.3.0 1.2.0 1.1.0 - master(Unreleased) + main(Unreleased) litmusctl-darwin-amd64 (MacOS) Click here @@ -47,7 +47,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-386 @@ -59,7 +59,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-amd64 @@ -71,7 +71,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm @@ -83,7 +83,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-linux-arm64 @@ -95,7 +95,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-386 @@ -107,7 +107,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-amd64 @@ -119,7 +119,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here litmusctl-windows-arm @@ -131,7 +131,7 @@ To install the latest version of litmusctl follow the below steps: Click here Click here Click here - Click here + Click here diff --git a/website/versioned_docs/version-3.9.2/litmusctl/litmusctl-usage.md b/website/versioned_docs/version-3.9.2/litmusctl/litmusctl-usage.md index 251328f2..33719e5f 100644 --- a/website/versioned_docs/version-3.9.2/litmusctl/litmusctl-usage.md +++ b/website/versioned_docs/version-3.9.2/litmusctl/litmusctl-usage.md @@ -13,14 +13,14 @@ sidebar_label: Litmusctl Usage Connect Chaos Infrastructure - Click Here + Click Here Create Chaos Experiment - Click Here + Click Here Additional Commands - Click Here + Click Here diff --git a/website/versioned_docs/version-3.9.2/troubleshooting.md b/website/versioned_docs/version-3.9.2/troubleshooting.md index c87a0530..c1593f98 100644 --- a/website/versioned_docs/version-3.9.2/troubleshooting.md +++ b/website/versioned_docs/version-3.9.2/troubleshooting.md @@ -56,7 +56,7 @@ In the logs of the Helper pod, you may face these error logs below. {"mainLogs":"W1003 08:59:55.273647 1 client_config.go:552] Neither --kubeconfig nor --master was specified. Using the inClusterConfig. This might not work.\n2023/10/03 08:59:55 Error Creating Resource : ChaosEngine.litmuschaos.io 'pod-network-loss-h6srhrls' is invalid: [spec.experiments[0].spec.probe[0].runProperties.interval: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.interval in body must be of type integer: 'string', spec.experiments[0].spec.probe[0].runProperties.probeTimeout: Invalid value: 'string': spec.experiments[0].spec.probe[0].runProperties.probeTimeout in body must be of type integer: 'string']\n"} ``` -It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/master/mkdocs/docs//litmus-portal-crds-.yml). +It's because your cluster using old CRD manifest files. So you need to delete all Litmus' CRDs and reinstall them. The definition for CRDs can be found in the Chaos Infrastructure YAML file or at this [link](https://github.com/litmuschaos/litmus/blob/main/mkdocs/docs//litmus-portal-crds-.yml). ## Chaoshub diff --git a/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-advanced-installation.md b/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-advanced-installation.md index b1c6415d..22d07ecd 100644 --- a/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-advanced-installation.md +++ b/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-advanced-installation.md @@ -106,7 +106,7 @@ Visit https://docs.litmuschaos.io to find more info. ## **Install Litmus using kubectl** -In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9). +In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9). ### **Install mongo** @@ -150,7 +150,7 @@ Litmus supports for HTTP and HTTPS mode of installation. ### Advanced installation (HTTPS based and CORS rules apply) -1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/master/chaoscenter/mtls-helper.sh) bash script. +1. Generate TLS certificates: You can provide your own certificates or can generate using [this](https://github.com/litmuschaos/litmus/blob/main/chaoscenter/mtls-helper.sh) bash script. 2. Create secret diff --git a/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-oauth-dex-installation.md b/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-oauth-dex-installation.md index 8923a565..a36b4024 100644 --- a/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/versioned_docs/version-3.9.2/user-guides/chaoscenter-oauth-dex-installation.md @@ -38,7 +38,7 @@ Make sure you have your Google and GitHub Client credentials ready, if you do no ### Configuring Dex OIDC provider ```bash -curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/master/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml +curl https://raw.githubusercontent.com/litmuschaos/litmus/refs/heads/main/chaoscenter/dex-server/dex-deployment.yaml --output dex-deployment.yaml ``` 1. Open the file with your favorite text-editor diff --git a/website/versioned_docs/version-3.9.2/user-guides/editing-queries-app-dashboard.md b/website/versioned_docs/version-3.9.2/user-guides/editing-queries-app-dashboard.md index 45cd1fa0..d35946af 100644 --- a/website/versioned_docs/version-3.9.2/user-guides/editing-queries-app-dashboard.md +++ b/website/versioned_docs/version-3.9.2/user-guides/editing-queries-app-dashboard.md @@ -14,7 +14,7 @@ In order to edit the queries, you must first have a [data source](configure-data ## Dashboard Structure -For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: +For visualization of the metrics, you need to tune the queries as per your use case. To learn about the dashboard schema [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). The hierarchical structure of the dashboard is defined as follows: ``` Dashboard (root) diff --git a/website/versioned_docs/version-3.9.2/user-guides/manage-app-dashboard.md b/website/versioned_docs/version-3.9.2/user-guides/manage-app-dashboard.md index 4fae3ccb..5a5183d6 100644 --- a/website/versioned_docs/version-3.9.2/user-guides/manage-app-dashboard.md +++ b/website/versioned_docs/version-3.9.2/user-guides/manage-app-dashboard.md @@ -6,7 +6,7 @@ sidebar_label: Manage Application Dashboard --- -Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json) +Observing chaos injections and deriving insights from the chaos events is the core part of Chaos Observability. Whenever a chaos scenario run is performed its impact may be observed across different services and applications. Application dashboards provide a systematic visualization of all such events along with the performance of the individual service/application. To learn more about the dashboard schema architecture [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json) ## Before you begin diff --git a/website/versioned_docs/version-3.9.2/user-guides/setup-datasource.md b/website/versioned_docs/version-3.9.2/user-guides/setup-datasource.md index b40bc148..fa3318ff 100644 --- a/website/versioned_docs/version-3.9.2/user-guides/setup-datasource.md +++ b/website/versioned_docs/version-3.9.2/user-guides/setup-datasource.md @@ -40,9 +40,9 @@ _Scrape jobs:_ - targets: ['kube-state-metrics.monitoring.svc.cluster.local:8080'] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -111,8 +111,8 @@ spec: app.kubernetes.io/name: kube-state-metrics ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus) @@ -249,9 +249,9 @@ _Scrape jobs:_ - targets: [''] ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) -- [cAdvisor](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) +- [cAdvisor](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/prometheus/prometheus-scrape-configuration/02-prometheus-configMap.yaml) [Detailed setup guide for Prometheus deployment with scrape configuration](../integrations/prometheus) @@ -451,8 +451,8 @@ spec: port: tcp ``` -- [Node exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) -- [Black box exporter](https://github.com/litmuschaos/litmus/blob/master/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) +- [Node exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/node-exporter/service-monitor.yaml) +- [Black box exporter](https://github.com/litmuschaos/litmus/blob/main/monitoring/utils/metrics-exporters-with-service-monitors/prometheus-blackbox-exporter-metrics/service-monitor.yaml) [Detailed setup guide for Prometheus operator with service monitors](../integrations/prometheus.md) diff --git a/website/versioned_docs/version-3.9.2/user-guides/share-app-dashboard.md b/website/versioned_docs/version-3.9.2/user-guides/share-app-dashboard.md index 93bf92c6..daefb952 100644 --- a/website/versioned_docs/version-3.9.2/user-guides/share-app-dashboard.md +++ b/website/versioned_docs/version-3.9.2/user-guides/share-app-dashboard.md @@ -8,11 +8,11 @@ sidebar_label: Sharing Application Dashboards ## Uploading and downloading a dashboard -- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/master/monitoring/portal-dashboards/schema.json). +- **Upload the JSON:** During the dashboard creation process, you can upload your JSON file having all the configurations of the dashboard. To read about the configurations and format of the JSON file for the application dashboard. To learn more about the schema of the dashboard JSON [click here](https://raw.githubusercontent.com/litmuschaos/litmus/main/monitoring/portal-dashboards/schema.json). - **Changing configuration step remains the same:** After uploading the JSON file you can make changes in the configuration of the dashboard same. The steps for changing the configuration and tuning the queries remain the same as for pre-defined dashboards. To learn about dashboard configuration and tuning the queries [click here](editing-queries-app-dashboard.md). - **Downloading a dashboard:** To download the dashboard, go to the Application dashboard tab, click on the more options for the particular dashboard from the Table and download the JSON file for the dashboard -To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/master/monitoring/dashboards/litmus-portal) +To learn more about the dashboard and view examples [click here](https://github.com/litmuschaos/chaos-charts/tree/main/monitoring/dashboards/litmus-portal) ## Learn more diff --git a/website/versioned_docs/version-3.9.2/user-guides/upgrade.md b/website/versioned_docs/version-3.9.2/user-guides/upgrade.md index df51461c..de34b9ff 100644 --- a/website/versioned_docs/version-3.9.2/user-guides/upgrade.md +++ b/website/versioned_docs/version-3.9.2/user-guides/upgrade.md @@ -16,7 +16,7 @@ To upgrade Litmus ChaosCenter from 3.8.0 to 3.9.0, you can follow these steps: To upgrade ChaosCenter, you can re-apply the manifest using the kubectl. ```bash - kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.2/litmus-getting-started.yaml + kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.9.2/litmus-getting-started.yaml ``` ## Upgrade Chaos Delegate @@ -33,4 +33,4 @@ Alternatively you can run the following command using litmusctl in the cluster c litmusctl upgrade agent --cluster-id="" --project-id="" ``` -> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/README.md) is required. +> Note: v0.7.0 of [litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/README.md) is required.