From 6af5338b46995e23598d95b702249a52f5072f7f Mon Sep 17 00:00:00 2001 From: Soumya Ghosh Dastidar Date: Mon, 15 Mar 2021 21:45:56 +0530 Subject: [PATCH 1/2] Added documentation for GitOps Signed-off-by: Soumya Ghosh Dastidar --- website/docs/gitops.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/website/docs/gitops.md b/website/docs/gitops.md index 7e1580d..6a27037 100644 --- a/website/docs/gitops.md +++ b/website/docs/gitops.md @@ -3,3 +3,25 @@ id: gitops title: GitOps sidebar_label: GitOps --- + +--- +GitOps feature in Litmus enables the users to configure a single source of truth for their chaos workflows and experiments, any changes made either to the artifacts stored in the configured git repository or the portal will be synced. This allows creation and execution of workflows directly from git enabling a vast scope of automation in CI/CD pipelines. + +Besides the sync feature GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(statefulsets, deployments etc.) can be configured to automatically trigger chaos workflows with any changes in the resource spec. Currently the event supported for chaos injection is resource **image change**, but in the future releases a wide variety of policies will be added to configure various events for chaos injection. + +The event driven chaos injection allows Litmus to be integrated with traditional GitOps flow that involves automated deployment of applications or workloads, for example users can now automatically trigger chaos workflows whenever a new release is created for their application and is deployed by a continuous delivery system. + +GitOps is by default disabled for the projects created in Litmus, but it can be enabled and configured in from the **GitOps** tab in Litmus portal **Settings** + +## Configuring a Git repository for GitOps + +To configure a git repo a user must provide the Git URL of the repository and the Branch name and the authentication credentials which are of two types: + +#### a. Access Token +Personal Access Tokens are used as an alternative to the password for authentication to Git services. + +#### b. SSH Key +Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with the user. +SSH link of the repository should be provided if the user selects this method. + +Once GitOps is enabled, any new workflows created will be stored in the configured repo in the path `litmus//.yaml`. From d784ac05c6b58e548803ca6c60010fc1654ed636 Mon Sep 17 00:00:00 2001 From: Soumya Ghosh Dastidar Date: Mon, 15 Mar 2021 22:30:29 +0530 Subject: [PATCH 2/2] minor changes Signed-off-by: Soumya Ghosh Dastidar --- website/docs/gitops.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/gitops.md b/website/docs/gitops.md index 6a27037..08fcea3 100644 --- a/website/docs/gitops.md +++ b/website/docs/gitops.md @@ -11,17 +11,17 @@ Besides the sync feature GitOps in Litmus provides a way of using Event-Driven C The event driven chaos injection allows Litmus to be integrated with traditional GitOps flow that involves automated deployment of applications or workloads, for example users can now automatically trigger chaos workflows whenever a new release is created for their application and is deployed by a continuous delivery system. -GitOps is by default disabled for the projects created in Litmus, but it can be enabled and configured in from the **GitOps** tab in Litmus portal **Settings** +GitOps is by default disabled for the projects created in Litmus, but it can be enabled and configured from the **GitOps** tab in Litmus portal **Settings** ## Configuring a Git repository for GitOps -To configure a git repo a user must provide the Git URL of the repository and the Branch name and the authentication credentials which are of two types: +To configure a git repo the user must provide the Git URL of the repository and the Branch name and the authentication credentials which are of two types: #### a. Access Token Personal Access Tokens are used as an alternative to the password for authentication to Git services. #### b. SSH Key -Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with the user. +Just like the Access Token, SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored in the server. SSH link of the repository should be provided if the user selects this method. Once GitOps is enabled, any new workflows created will be stored in the configured repo in the path `litmus//.yaml`.