diff --git a/docs/operator-guide/cd/customize-deploy-pipeline.md b/docs/operator-guide/cd/customize-deploy-pipeline.md index a6682f3ef..01c03ed31 100644 --- a/docs/operator-guide/cd/customize-deploy-pipeline.md +++ b/docs/operator-guide/cd/customize-deploy-pipeline.md @@ -17,6 +17,10 @@ When deploying applications into environments, it's important to automate both ` This page provides comprehensive guidelines on how to adjust the deployment logic to cater your needs. +
+ +
+ ## Deploy Custom Pipeline Overall, the custom pipeline creation involves the following steps: diff --git a/docs/operator-guide/cd/customize-environment-deletion.md b/docs/operator-guide/cd/customize-environment-deletion.md index 0155942ea..7b9907c68 100644 --- a/docs/operator-guide/cd/customize-environment-deletion.md +++ b/docs/operator-guide/cd/customize-environment-deletion.md @@ -13,6 +13,10 @@ sidebar_label: "Customize Environment Cleanup" KubeRocketCI provides capabilities to fully operate the CI/CD flow, starting from building applications to deploying its new release. The operation flow is designed to be seamless for most of the users. However, there may be cases where more specialized actions are necessary. These might include custom procedures for managing the deletion of application resources. +
+ +
+ ## Create Custom Clean Pipeline Delete pipeline is a typical Tekton pipeline but with its own instructions. The custom delete pipeline creation involves the following steps: diff --git a/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md b/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md index ce0209e2e..00d08d077 100644 --- a/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md +++ b/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; KubeRocketCI enables secure deployment of applications to remote AWS EKS clusters using IAM Roles for Service Accounts (IRSA). This guide explains how to configure cross-account access between Kubernetes clusters, allowing applications to be deployed from one AWS account to another without storing long-term credentials. IRSA provides temporary, scoped credentials by allowing Kubernetes service accounts to assume specific IAM roles with precisely defined permissions, enhancing both security and operational efficiency when working with multi-account AWS environments. +
+ +
+ ## Prerequisites Before implementing IRSA for cross-account deployments, the following requirements must be met: diff --git a/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md b/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md index b27bdadaf..b8c684d42 100644 --- a/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md +++ b/docs/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md @@ -14,6 +14,10 @@ import TabItem from '@theme/TabItem'; This section enables the creation of the necessary resources to configure access to a remote cluster using a static token. +
+ +
+ ## Using Kubernetes RBAC To configure application deployment in remote cluster using Kubernetes RBAC, follow the steps below: diff --git a/docs/use-cases/autotest-as-quality-gate.md b/docs/use-cases/autotest-as-quality-gate.md index 4ffa300c0..116cffb3b 100644 --- a/docs/use-cases/autotest-as-quality-gate.md +++ b/docs/use-cases/autotest-as-quality-gate.md @@ -18,6 +18,10 @@ This use case outlines the process of integrating an autotest as a quality gate In the KubeRocketCI platform, users can seamlessly add autotests as quality gates to their CD pipelines, enabling them to validate the application's stability and functionality before promoting it to the next stage. This ensures that only reliable versions of the application are deployed, improving the overall quality and reliability of the software. +
+ +
+ ## Roles This documentation is tailored for the Developers and Quality Assurance specialists. diff --git a/docs/use-cases/custom-pipelines-flow.md b/docs/use-cases/custom-pipelines-flow.md index 38a39d4b1..22725a2ca 100644 --- a/docs/use-cases/custom-pipelines-flow.md +++ b/docs/use-cases/custom-pipelines-flow.md @@ -17,6 +17,10 @@ sidebar_label: "Create and Use Custom Tekton Pipelines" This use case explains how to create and use custom Tekton pipelines on the KubeRocketCI Platform. While KubeRocketCI offers pre-configured Tekton pipelines for common use cases, custom pipelines allow you to adapt workflows to meet unique project requirements. It also provides guidance on integrating and using these custom Tekton pipelines within your development processes. +
+ +
+ ## Goals - Provide a clear method for creating and configuring custom Tekton tasks and pipelines for build, review, deployment, and clean processes within KubeRocketCI. diff --git a/docs/use-cases/deploy-application-from-feature-branch.md b/docs/use-cases/deploy-application-from-feature-branch.md index 80a0e86cc..3b94bb5c4 100644 --- a/docs/use-cases/deploy-application-from-feature-branch.md +++ b/docs/use-cases/deploy-application-from-feature-branch.md @@ -17,6 +17,10 @@ Deploying feature branches is crucial for testing activities, including manual t The KubeRocketCI platform enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. +
+ +
+ ### Preconditions Before you start passing the use case, ensure to meet the following requirements: diff --git a/docs/user-guide/add-autotest.md b/docs/user-guide/add-autotest.md index 250779915..cd5c24c70 100644 --- a/docs/user-guide/add-autotest.md +++ b/docs/user-guide/add-autotest.md @@ -14,6 +14,11 @@ description: "Learn how to add autotests in KubeRocketCI, integrating them into KubeRocketCI portal allows you to clone an existing repository with the autotest to your Version Control System (VCS), or using an external repository and adding an autotest for further running in stages or using them as quality gates for applications. + +
+ +
+ When an autotest is cloned, the system automatically generates a corresponding repository within the integrated VCS. You can create an autotest [in YAML](#create-autotest-in-yaml) or [via the two-step menu](#create-autotest-via-ui) in the dialog. :::info diff --git a/docs/user-guide/add-cluster.md b/docs/user-guide/add-cluster.md index d5ec238b9..c41eac944 100644 --- a/docs/user-guide/add-cluster.md +++ b/docs/user-guide/add-cluster.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; This page provides comprehensive instructions on how to integrate an external cluster into the KubeRocketCI workloads. By doing so, it creates an opportunity for users to employ multi-cluster deployment, thereby facilitating the segregation of different environments across various clusters. +
+ +
+ ## Prerequisites Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. Besides, user needs to have a cluster admin role to add clusters. diff --git a/docs/user-guide/components.md b/docs/user-guide/components.md index 8a20adeaf..016f4f090 100644 --- a/docs/user-guide/components.md +++ b/docs/user-guide/components.md @@ -15,6 +15,10 @@ description: "Explore the essentials of codebases and onboarding strategies in K In this section, we will introduce you to the different types of codebases and strategies for onboarding codebases onto the KubeRocketCI. +
+ +
+ ## Component and Codebase From a business perspective, `Components` represent the functional building blocks of software projects. They define the purpose and functionality of different parts of a business application, such as core applications, libraries, automated tests, and infrastructure settings. Components are about what software does and how it aligns with business goals. diff --git a/docs/user-guide/gitops.md b/docs/user-guide/gitops.md index 90a3d927b..54fb4e7dd 100644 --- a/docs/user-guide/gitops.md +++ b/docs/user-guide/gitops.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; This page is dedicated to the `GitOps` section of the `Configuration` tab, the process of establishing the GitOps repository, outline benefits it extends to users within the platform capabilities. GitOps, short for "Git Operations", is a modern approach to managing and automating infrastructure and application deployments. In GitOps, the desired state of your environment is declared and stored in a Git repository. With GitOps, you can ensure that your infrastructure and applications are always in sync with your intended configurations and readily adapt to changing requirements. +
+ +
+ ## Overview The purpose of the `GitOps` section is to provide users with the ability to customize the state of their environments with the help of GitOps approach that enables you to store your entire deployment configuration in a Git repository, providing version control for changes, consistent collaboration, and automated deployments. Enforcing GitOps allows you to declaratively define and automate your configurations, ensuring consistency, version control, and collaboration within your team. diff --git a/docs/user-guide/manage-branches.md b/docs/user-guide/manage-branches.md index 4a54a9eb0..83cadf8d1 100644 --- a/docs/user-guide/manage-branches.md +++ b/docs/user-guide/manage-branches.md @@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem'; This page describes how to manage branches in the created component, whether it is an application, library, autotest or infrastructure. It also briefly explains two approaches of managing custom pipelines for codebases.
- +
## Pipeline Management diff --git a/docs/user-guide/tekton-pipelines.md b/docs/user-guide/tekton-pipelines.md index 18717ec04..118c1c229 100644 --- a/docs/user-guide/tekton-pipelines.md +++ b/docs/user-guide/tekton-pipelines.md @@ -19,6 +19,10 @@ import TabItem from '@theme/TabItem'; KubeRocketCI is a platform that utilizes the Tekton stack to implement continuous integration and continuous delivery (CI/CD) pipelines, offering access to all Tekton features. It comes pre-configured with various Tekton resources, including pipelines, tasks, triggers, and other components. This documentation outlines how to interact with these Tekton resources within the KubeRocketCI platform, addressing common use cases, pipeline configuration, and execution processes. +
+ +
+ ## Prerequisites Before executing pipelines, ensure that the project is onboarded to the KubeRocketCI platform and that the relevant branches are properly configured. diff --git a/versioned_docs/version-3.10/operator-guide/cd/customize-deploy-pipeline.md b/versioned_docs/version-3.10/operator-guide/cd/customize-deploy-pipeline.md index a6682f3ef..01c03ed31 100644 --- a/versioned_docs/version-3.10/operator-guide/cd/customize-deploy-pipeline.md +++ b/versioned_docs/version-3.10/operator-guide/cd/customize-deploy-pipeline.md @@ -17,6 +17,10 @@ When deploying applications into environments, it's important to automate both ` This page provides comprehensive guidelines on how to adjust the deployment logic to cater your needs. +
+ +
+ ## Deploy Custom Pipeline Overall, the custom pipeline creation involves the following steps: diff --git a/versioned_docs/version-3.10/operator-guide/cd/customize-environment-deletion.md b/versioned_docs/version-3.10/operator-guide/cd/customize-environment-deletion.md index 0155942ea..7b9907c68 100644 --- a/versioned_docs/version-3.10/operator-guide/cd/customize-environment-deletion.md +++ b/versioned_docs/version-3.10/operator-guide/cd/customize-environment-deletion.md @@ -13,6 +13,10 @@ sidebar_label: "Customize Environment Cleanup" KubeRocketCI provides capabilities to fully operate the CI/CD flow, starting from building applications to deploying its new release. The operation flow is designed to be seamless for most of the users. However, there may be cases where more specialized actions are necessary. These might include custom procedures for managing the deletion of application resources. +
+ +
+ ## Create Custom Clean Pipeline Delete pipeline is a typical Tekton pipeline but with its own instructions. The custom delete pipeline creation involves the following steps: diff --git a/versioned_docs/version-3.10/use-cases/autotest-as-quality-gate.md b/versioned_docs/version-3.10/use-cases/autotest-as-quality-gate.md index 7e1543f54..385b9b02b 100644 --- a/versioned_docs/version-3.10/use-cases/autotest-as-quality-gate.md +++ b/versioned_docs/version-3.10/use-cases/autotest-as-quality-gate.md @@ -18,6 +18,10 @@ This use case outlines the process of integrating an autotest as a quality gate In the KubeRocketCI platform, users can seamlessly add autotests as quality gates to their CD pipelines, enabling them to validate the application's stability and functionality before promoting it to the next stage. This ensures that only reliable versions of the application are deployed, improving the overall quality and reliability of the software. +
+ +
+ ## Roles This documentation is tailored for the Developers and Quality Assurance specialists. diff --git a/versioned_docs/version-3.10/use-cases/custom-pipelines-flow.md b/versioned_docs/version-3.10/use-cases/custom-pipelines-flow.md index 2b149d69d..073b052a0 100644 --- a/versioned_docs/version-3.10/use-cases/custom-pipelines-flow.md +++ b/versioned_docs/version-3.10/use-cases/custom-pipelines-flow.md @@ -17,6 +17,10 @@ sidebar_label: "Create and Use Custom Tekton Pipelines" This use case explains how to create and use custom Tekton pipelines on the KubeRocketCI Platform. While KubeRocketCI offers pre-configured Tekton pipelines for common use cases, custom pipelines allow you to adapt workflows to meet unique project requirements. It also provides guidance on integrating and using these custom Tekton pipelines within your development processes. +
+ +
+ ## Goals - Provide a clear method for creating and configuring custom Tekton tasks and pipelines for build, review, deployment, and clean processes within KubeRocketCI. diff --git a/versioned_docs/version-3.10/use-cases/deploy-application-from-feature-branch.md b/versioned_docs/version-3.10/use-cases/deploy-application-from-feature-branch.md index 80a0e86cc..3b94bb5c4 100644 --- a/versioned_docs/version-3.10/use-cases/deploy-application-from-feature-branch.md +++ b/versioned_docs/version-3.10/use-cases/deploy-application-from-feature-branch.md @@ -17,6 +17,10 @@ Deploying feature branches is crucial for testing activities, including manual t The KubeRocketCI platform enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. +
+ +
+ ### Preconditions Before you start passing the use case, ensure to meet the following requirements: diff --git a/versioned_docs/version-3.10/user-guide/add-autotest.md b/versioned_docs/version-3.10/user-guide/add-autotest.md index 8931a26fa..ea4732dd3 100644 --- a/versioned_docs/version-3.10/user-guide/add-autotest.md +++ b/versioned_docs/version-3.10/user-guide/add-autotest.md @@ -14,6 +14,11 @@ description: "Learn how to add autotests in KubeRocketCI, integrating them into KubeRocketCI portal allows you to clone an existing repository with the autotest to your Version Control System (VCS), or using an external repository and adding an autotest for further running in stages or using them as quality gates for applications. + +
+ +
+ When an autotest is cloned, the system automatically generates a corresponding repository within the integrated VCS. You can create an autotest [in YAML](#create-autotest-in-yaml) or [via the two-step menu](#create-autotest-via-ui) in the dialog. :::info diff --git a/versioned_docs/version-3.10/user-guide/add-cluster.md b/versioned_docs/version-3.10/user-guide/add-cluster.md index 4baf2e204..347815a76 100644 --- a/versioned_docs/version-3.10/user-guide/add-cluster.md +++ b/versioned_docs/version-3.10/user-guide/add-cluster.md @@ -15,6 +15,10 @@ description: "Step-by-step guide on integrating new clusters into KubeRocketCI f This page provides comprehensive instructions on how to integrate a new cluster into the KubeRocketCI workloads. By doing so, it creates an opportunity for users to employ multi-cluster deployment, thereby facilitating the segregation of different environments across various clusters. +
+ +
+ ## Prerequisites Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. Besides, user needs to have a cluster admin role to add clusters. diff --git a/versioned_docs/version-3.10/user-guide/components.md b/versioned_docs/version-3.10/user-guide/components.md index fdaf2be80..74f696300 100644 --- a/versioned_docs/version-3.10/user-guide/components.md +++ b/versioned_docs/version-3.10/user-guide/components.md @@ -15,6 +15,10 @@ description: "Explore the essentials of codebases and onboarding strategies in K In this section, we will introduce you to the different types of codebases and strategies for onboarding codebases onto the KubeRocketCI. +
+ +
+ ## Component and Codebase From a business perspective, `Components` represent the functional building blocks of software projects. They define the purpose and functionality of different parts of a business application, such as core applications, libraries, automated tests, and infrastructure settings. Components are about what software does and how it aligns with business goals. diff --git a/versioned_docs/version-3.10/user-guide/gitops.md b/versioned_docs/version-3.10/user-guide/gitops.md index d23cf39a8..9709cf164 100644 --- a/versioned_docs/version-3.10/user-guide/gitops.md +++ b/versioned_docs/version-3.10/user-guide/gitops.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; This page is dedicated to the `GitOps` section of the `Configuration` tab, the process of establishing the GitOps repository, outline benefits it extends to users within the platform capabilities. GitOps, short for "Git Operations", is a modern approach to managing and automating infrastructure and application deployments. In GitOps, the desired state of your environment is declared and stored in a Git repository. With GitOps, you can ensure that your infrastructure and applications are always in sync with your intended configurations and readily adapt to changing requirements. +
+ +
+ ## Overview The purpose of the `GitOps` section is to provide users with the ability to customize the state of their environments with the help of GitOps approach that enables you to store your entire deployment configuration in a Git repository, providing version control for changes, consistent collaboration, and automated deployments. Enforcing GitOps allows you to declaratively define and automate your configurations, ensuring consistency, version control, and collaboration within your team. diff --git a/versioned_docs/version-3.10/user-guide/manage-branches.md b/versioned_docs/version-3.10/user-guide/manage-branches.md index 788835b57..3c3e67973 100644 --- a/versioned_docs/version-3.10/user-guide/manage-branches.md +++ b/versioned_docs/version-3.10/user-guide/manage-branches.md @@ -16,7 +16,7 @@ description: "Explore branch management in KubeRocketCI, from adding new branche This page describes how to manage branches in the created component, whether it is an application, library, autotest or infrastructure. It also briefly explains two approaches of managing custom pipelines for codebases.
- +
## Pipeline Management diff --git a/versioned_docs/version-3.10/user-guide/tekton-pipelines.md b/versioned_docs/version-3.10/user-guide/tekton-pipelines.md index b68a9f600..ee3e2cb07 100644 --- a/versioned_docs/version-3.10/user-guide/tekton-pipelines.md +++ b/versioned_docs/version-3.10/user-guide/tekton-pipelines.md @@ -16,6 +16,10 @@ description: "KubeRocketCI is a platform that utilizes the Tekton stack to imple KubeRocketCI is a platform that utilizes the Tekton stack to implement continuous integration and continuous delivery (CI/CD) pipelines, offering access to all Tekton features. It comes pre-configured with various Tekton resources, including pipelines, tasks, triggers, and other components. This documentation outlines how to interact with these Tekton resources within the KubeRocketCI platform, addressing common use cases, pipeline configuration, and execution processes. +
+ +
+ ## Prerequisites Before executing pipelines, ensure that the project is onboarded to the KubeRocketCI platform and that the relevant branches are properly configured. diff --git a/versioned_docs/version-3.11/operator-guide/cd/customize-deploy-pipeline.md b/versioned_docs/version-3.11/operator-guide/cd/customize-deploy-pipeline.md index a6682f3ef..01c03ed31 100644 --- a/versioned_docs/version-3.11/operator-guide/cd/customize-deploy-pipeline.md +++ b/versioned_docs/version-3.11/operator-guide/cd/customize-deploy-pipeline.md @@ -17,6 +17,10 @@ When deploying applications into environments, it's important to automate both ` This page provides comprehensive guidelines on how to adjust the deployment logic to cater your needs. +
+ +
+ ## Deploy Custom Pipeline Overall, the custom pipeline creation involves the following steps: diff --git a/versioned_docs/version-3.11/operator-guide/cd/customize-environment-deletion.md b/versioned_docs/version-3.11/operator-guide/cd/customize-environment-deletion.md index 0155942ea..7b9907c68 100644 --- a/versioned_docs/version-3.11/operator-guide/cd/customize-environment-deletion.md +++ b/versioned_docs/version-3.11/operator-guide/cd/customize-environment-deletion.md @@ -13,6 +13,10 @@ sidebar_label: "Customize Environment Cleanup" KubeRocketCI provides capabilities to fully operate the CI/CD flow, starting from building applications to deploying its new release. The operation flow is designed to be seamless for most of the users. However, there may be cases where more specialized actions are necessary. These might include custom procedures for managing the deletion of application resources. +
+ +
+ ## Create Custom Clean Pipeline Delete pipeline is a typical Tekton pipeline but with its own instructions. The custom delete pipeline creation involves the following steps: diff --git a/versioned_docs/version-3.11/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md b/versioned_docs/version-3.11/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md index ce0209e2e..00d08d077 100644 --- a/versioned_docs/version-3.11/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md +++ b/versioned_docs/version-3.11/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; KubeRocketCI enables secure deployment of applications to remote AWS EKS clusters using IAM Roles for Service Accounts (IRSA). This guide explains how to configure cross-account access between Kubernetes clusters, allowing applications to be deployed from one AWS account to another without storing long-term credentials. IRSA provides temporary, scoped credentials by allowing Kubernetes service accounts to assume specific IAM roles with precisely defined permissions, enhancing both security and operational efficiency when working with multi-account AWS environments. +
+ +
+ ## Prerequisites Before implementing IRSA for cross-account deployments, the following requirements must be met: diff --git a/versioned_docs/version-3.11/use-cases/autotest-as-quality-gate.md b/versioned_docs/version-3.11/use-cases/autotest-as-quality-gate.md index 4ffa300c0..116cffb3b 100644 --- a/versioned_docs/version-3.11/use-cases/autotest-as-quality-gate.md +++ b/versioned_docs/version-3.11/use-cases/autotest-as-quality-gate.md @@ -18,6 +18,10 @@ This use case outlines the process of integrating an autotest as a quality gate In the KubeRocketCI platform, users can seamlessly add autotests as quality gates to their CD pipelines, enabling them to validate the application's stability and functionality before promoting it to the next stage. This ensures that only reliable versions of the application are deployed, improving the overall quality and reliability of the software. +
+ +
+ ## Roles This documentation is tailored for the Developers and Quality Assurance specialists. diff --git a/versioned_docs/version-3.11/use-cases/custom-pipelines-flow.md b/versioned_docs/version-3.11/use-cases/custom-pipelines-flow.md index 38a39d4b1..22725a2ca 100644 --- a/versioned_docs/version-3.11/use-cases/custom-pipelines-flow.md +++ b/versioned_docs/version-3.11/use-cases/custom-pipelines-flow.md @@ -17,6 +17,10 @@ sidebar_label: "Create and Use Custom Tekton Pipelines" This use case explains how to create and use custom Tekton pipelines on the KubeRocketCI Platform. While KubeRocketCI offers pre-configured Tekton pipelines for common use cases, custom pipelines allow you to adapt workflows to meet unique project requirements. It also provides guidance on integrating and using these custom Tekton pipelines within your development processes. +
+ +
+ ## Goals - Provide a clear method for creating and configuring custom Tekton tasks and pipelines for build, review, deployment, and clean processes within KubeRocketCI. diff --git a/versioned_docs/version-3.11/use-cases/deploy-application-from-feature-branch.md b/versioned_docs/version-3.11/use-cases/deploy-application-from-feature-branch.md index 80a0e86cc..3b94bb5c4 100644 --- a/versioned_docs/version-3.11/use-cases/deploy-application-from-feature-branch.md +++ b/versioned_docs/version-3.11/use-cases/deploy-application-from-feature-branch.md @@ -17,6 +17,10 @@ Deploying feature branches is crucial for testing activities, including manual t The KubeRocketCI platform enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. +
+ +
+ ### Preconditions Before you start passing the use case, ensure to meet the following requirements: diff --git a/versioned_docs/version-3.11/user-guide/add-autotest.md b/versioned_docs/version-3.11/user-guide/add-autotest.md index e5c32eb17..61515d80b 100644 --- a/versioned_docs/version-3.11/user-guide/add-autotest.md +++ b/versioned_docs/version-3.11/user-guide/add-autotest.md @@ -14,6 +14,11 @@ description: "Learn how to add autotests in KubeRocketCI, integrating them into KubeRocketCI portal allows you to clone an existing repository with the autotest to your Version Control System (VCS), or using an external repository and adding an autotest for further running in stages or using them as quality gates for applications. + +
+ +
+ When an autotest is cloned, the system automatically generates a corresponding repository within the integrated VCS. You can create an autotest [in YAML](#create-autotest-in-yaml) or [via the two-step menu](#create-autotest-via-ui) in the dialog. :::info diff --git a/versioned_docs/version-3.11/user-guide/add-cluster.md b/versioned_docs/version-3.11/user-guide/add-cluster.md index 1c7ecbd08..35c57bbc6 100644 --- a/versioned_docs/version-3.11/user-guide/add-cluster.md +++ b/versioned_docs/version-3.11/user-guide/add-cluster.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; This page provides comprehensive instructions on how to integrate an external cluster into the KubeRocketCI workloads. By doing so, it creates an opportunity for users to employ multi-cluster deployment, thereby facilitating the segregation of different environments across various clusters. +
+ +
+ ## Prerequisites Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. Besides, user needs to have a cluster admin role to add clusters. diff --git a/versioned_docs/version-3.11/user-guide/components.md b/versioned_docs/version-3.11/user-guide/components.md index 8a20adeaf..016f4f090 100644 --- a/versioned_docs/version-3.11/user-guide/components.md +++ b/versioned_docs/version-3.11/user-guide/components.md @@ -15,6 +15,10 @@ description: "Explore the essentials of codebases and onboarding strategies in K In this section, we will introduce you to the different types of codebases and strategies for onboarding codebases onto the KubeRocketCI. +
+ +
+ ## Component and Codebase From a business perspective, `Components` represent the functional building blocks of software projects. They define the purpose and functionality of different parts of a business application, such as core applications, libraries, automated tests, and infrastructure settings. Components are about what software does and how it aligns with business goals. diff --git a/versioned_docs/version-3.11/user-guide/gitops.md b/versioned_docs/version-3.11/user-guide/gitops.md index 90a3d927b..54fb4e7dd 100644 --- a/versioned_docs/version-3.11/user-guide/gitops.md +++ b/versioned_docs/version-3.11/user-guide/gitops.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; This page is dedicated to the `GitOps` section of the `Configuration` tab, the process of establishing the GitOps repository, outline benefits it extends to users within the platform capabilities. GitOps, short for "Git Operations", is a modern approach to managing and automating infrastructure and application deployments. In GitOps, the desired state of your environment is declared and stored in a Git repository. With GitOps, you can ensure that your infrastructure and applications are always in sync with your intended configurations and readily adapt to changing requirements. +
+ +
+ ## Overview The purpose of the `GitOps` section is to provide users with the ability to customize the state of their environments with the help of GitOps approach that enables you to store your entire deployment configuration in a Git repository, providing version control for changes, consistent collaboration, and automated deployments. Enforcing GitOps allows you to declaratively define and automate your configurations, ensuring consistency, version control, and collaboration within your team. diff --git a/versioned_docs/version-3.11/user-guide/manage-branches.md b/versioned_docs/version-3.11/user-guide/manage-branches.md index 788835b57..3c3e67973 100644 --- a/versioned_docs/version-3.11/user-guide/manage-branches.md +++ b/versioned_docs/version-3.11/user-guide/manage-branches.md @@ -16,7 +16,7 @@ description: "Explore branch management in KubeRocketCI, from adding new branche This page describes how to manage branches in the created component, whether it is an application, library, autotest or infrastructure. It also briefly explains two approaches of managing custom pipelines for codebases.
- +
## Pipeline Management diff --git a/versioned_docs/version-3.11/user-guide/tekton-pipelines.md b/versioned_docs/version-3.11/user-guide/tekton-pipelines.md index 0c6fa16fc..a91a63558 100644 --- a/versioned_docs/version-3.11/user-guide/tekton-pipelines.md +++ b/versioned_docs/version-3.11/user-guide/tekton-pipelines.md @@ -16,6 +16,10 @@ description: "KubeRocketCI is a platform that utilizes the Tekton stack to imple KubeRocketCI is a platform that utilizes the Tekton stack to implement continuous integration and continuous delivery (CI/CD) pipelines, offering access to all Tekton features. It comes pre-configured with various Tekton resources, including pipelines, tasks, triggers, and other components. This documentation outlines how to interact with these Tekton resources within the KubeRocketCI platform, addressing common use cases, pipeline configuration, and execution processes. +
+ +
+ ## Prerequisites Before executing pipelines, ensure that the project is onboarded to the KubeRocketCI platform and that the relevant branches are properly configured. diff --git a/versioned_docs/version-3.12/operator-guide/cd/customize-deploy-pipeline.md b/versioned_docs/version-3.12/operator-guide/cd/customize-deploy-pipeline.md index a6682f3ef..01c03ed31 100644 --- a/versioned_docs/version-3.12/operator-guide/cd/customize-deploy-pipeline.md +++ b/versioned_docs/version-3.12/operator-guide/cd/customize-deploy-pipeline.md @@ -17,6 +17,10 @@ When deploying applications into environments, it's important to automate both ` This page provides comprehensive guidelines on how to adjust the deployment logic to cater your needs. +
+ +
+ ## Deploy Custom Pipeline Overall, the custom pipeline creation involves the following steps: diff --git a/versioned_docs/version-3.12/operator-guide/cd/customize-environment-deletion.md b/versioned_docs/version-3.12/operator-guide/cd/customize-environment-deletion.md index 0155942ea..7b9907c68 100644 --- a/versioned_docs/version-3.12/operator-guide/cd/customize-environment-deletion.md +++ b/versioned_docs/version-3.12/operator-guide/cd/customize-environment-deletion.md @@ -13,6 +13,10 @@ sidebar_label: "Customize Environment Cleanup" KubeRocketCI provides capabilities to fully operate the CI/CD flow, starting from building applications to deploying its new release. The operation flow is designed to be seamless for most of the users. However, there may be cases where more specialized actions are necessary. These might include custom procedures for managing the deletion of application resources. +
+ +
+ ## Create Custom Clean Pipeline Delete pipeline is a typical Tekton pipeline but with its own instructions. The custom delete pipeline creation involves the following steps: diff --git a/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md b/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md index ce0209e2e..00d08d077 100644 --- a/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md +++ b/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-irsa.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; KubeRocketCI enables secure deployment of applications to remote AWS EKS clusters using IAM Roles for Service Accounts (IRSA). This guide explains how to configure cross-account access between Kubernetes clusters, allowing applications to be deployed from one AWS account to another without storing long-term credentials. IRSA provides temporary, scoped credentials by allowing Kubernetes service accounts to assume specific IAM roles with precisely defined permissions, enhancing both security and operational efficiency when working with multi-account AWS environments. +
+ +
+ ## Prerequisites Before implementing IRSA for cross-account deployments, the following requirements must be met: diff --git a/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md b/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md index b27bdadaf..b8c684d42 100644 --- a/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md +++ b/versioned_docs/version-3.12/operator-guide/cd/deploy-application-in-remote-cluster-via-token.md @@ -14,6 +14,10 @@ import TabItem from '@theme/TabItem'; This section enables the creation of the necessary resources to configure access to a remote cluster using a static token. +
+ +
+ ## Using Kubernetes RBAC To configure application deployment in remote cluster using Kubernetes RBAC, follow the steps below: diff --git a/versioned_docs/version-3.12/use-cases/autotest-as-quality-gate.md b/versioned_docs/version-3.12/use-cases/autotest-as-quality-gate.md index 4ffa300c0..116cffb3b 100644 --- a/versioned_docs/version-3.12/use-cases/autotest-as-quality-gate.md +++ b/versioned_docs/version-3.12/use-cases/autotest-as-quality-gate.md @@ -18,6 +18,10 @@ This use case outlines the process of integrating an autotest as a quality gate In the KubeRocketCI platform, users can seamlessly add autotests as quality gates to their CD pipelines, enabling them to validate the application's stability and functionality before promoting it to the next stage. This ensures that only reliable versions of the application are deployed, improving the overall quality and reliability of the software. +
+ +
+ ## Roles This documentation is tailored for the Developers and Quality Assurance specialists. diff --git a/versioned_docs/version-3.12/use-cases/custom-pipelines-flow.md b/versioned_docs/version-3.12/use-cases/custom-pipelines-flow.md index 38a39d4b1..22725a2ca 100644 --- a/versioned_docs/version-3.12/use-cases/custom-pipelines-flow.md +++ b/versioned_docs/version-3.12/use-cases/custom-pipelines-flow.md @@ -17,6 +17,10 @@ sidebar_label: "Create and Use Custom Tekton Pipelines" This use case explains how to create and use custom Tekton pipelines on the KubeRocketCI Platform. While KubeRocketCI offers pre-configured Tekton pipelines for common use cases, custom pipelines allow you to adapt workflows to meet unique project requirements. It also provides guidance on integrating and using these custom Tekton pipelines within your development processes. +
+ +
+ ## Goals - Provide a clear method for creating and configuring custom Tekton tasks and pipelines for build, review, deployment, and clean processes within KubeRocketCI. diff --git a/versioned_docs/version-3.12/use-cases/deploy-application-from-feature-branch.md b/versioned_docs/version-3.12/use-cases/deploy-application-from-feature-branch.md index 80a0e86cc..3b94bb5c4 100644 --- a/versioned_docs/version-3.12/use-cases/deploy-application-from-feature-branch.md +++ b/versioned_docs/version-3.12/use-cases/deploy-application-from-feature-branch.md @@ -17,6 +17,10 @@ Deploying feature branches is crucial for testing activities, including manual t The KubeRocketCI platform enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. +
+ +
+ ### Preconditions Before you start passing the use case, ensure to meet the following requirements: diff --git a/versioned_docs/version-3.12/user-guide/add-autotest.md b/versioned_docs/version-3.12/user-guide/add-autotest.md index 19993b9dd..b6f616ae5 100644 --- a/versioned_docs/version-3.12/user-guide/add-autotest.md +++ b/versioned_docs/version-3.12/user-guide/add-autotest.md @@ -14,6 +14,11 @@ description: "Learn how to add autotests in KubeRocketCI, integrating them into KubeRocketCI portal allows you to clone an existing repository with the autotest to your Version Control System (VCS), or using an external repository and adding an autotest for further running in stages or using them as quality gates for applications. + +
+ +
+ When an autotest is cloned, the system automatically generates a corresponding repository within the integrated VCS. You can create an autotest [in YAML](#create-autotest-in-yaml) or [via the two-step menu](#create-autotest-via-ui) in the dialog. :::info diff --git a/versioned_docs/version-3.12/user-guide/add-cluster.md b/versioned_docs/version-3.12/user-guide/add-cluster.md index d5ec238b9..c41eac944 100644 --- a/versioned_docs/version-3.12/user-guide/add-cluster.md +++ b/versioned_docs/version-3.12/user-guide/add-cluster.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; This page provides comprehensive instructions on how to integrate an external cluster into the KubeRocketCI workloads. By doing so, it creates an opportunity for users to employ multi-cluster deployment, thereby facilitating the segregation of different environments across various clusters. +
+ +
+ ## Prerequisites Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. Besides, user needs to have a cluster admin role to add clusters. diff --git a/versioned_docs/version-3.12/user-guide/components.md b/versioned_docs/version-3.12/user-guide/components.md index 8a20adeaf..016f4f090 100644 --- a/versioned_docs/version-3.12/user-guide/components.md +++ b/versioned_docs/version-3.12/user-guide/components.md @@ -15,6 +15,10 @@ description: "Explore the essentials of codebases and onboarding strategies in K In this section, we will introduce you to the different types of codebases and strategies for onboarding codebases onto the KubeRocketCI. +
+ +
+ ## Component and Codebase From a business perspective, `Components` represent the functional building blocks of software projects. They define the purpose and functionality of different parts of a business application, such as core applications, libraries, automated tests, and infrastructure settings. Components are about what software does and how it aligns with business goals. diff --git a/versioned_docs/version-3.12/user-guide/gitops.md b/versioned_docs/version-3.12/user-guide/gitops.md index 90a3d927b..54fb4e7dd 100644 --- a/versioned_docs/version-3.12/user-guide/gitops.md +++ b/versioned_docs/version-3.12/user-guide/gitops.md @@ -18,6 +18,10 @@ import TabItem from '@theme/TabItem'; This page is dedicated to the `GitOps` section of the `Configuration` tab, the process of establishing the GitOps repository, outline benefits it extends to users within the platform capabilities. GitOps, short for "Git Operations", is a modern approach to managing and automating infrastructure and application deployments. In GitOps, the desired state of your environment is declared and stored in a Git repository. With GitOps, you can ensure that your infrastructure and applications are always in sync with your intended configurations and readily adapt to changing requirements. +
+ +
+ ## Overview The purpose of the `GitOps` section is to provide users with the ability to customize the state of their environments with the help of GitOps approach that enables you to store your entire deployment configuration in a Git repository, providing version control for changes, consistent collaboration, and automated deployments. Enforcing GitOps allows you to declaratively define and automate your configurations, ensuring consistency, version control, and collaboration within your team. diff --git a/versioned_docs/version-3.12/user-guide/manage-branches.md b/versioned_docs/version-3.12/user-guide/manage-branches.md index 4a54a9eb0..83cadf8d1 100644 --- a/versioned_docs/version-3.12/user-guide/manage-branches.md +++ b/versioned_docs/version-3.12/user-guide/manage-branches.md @@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem'; This page describes how to manage branches in the created component, whether it is an application, library, autotest or infrastructure. It also briefly explains two approaches of managing custom pipelines for codebases.
- +
## Pipeline Management diff --git a/versioned_docs/version-3.12/user-guide/tekton-pipelines.md b/versioned_docs/version-3.12/user-guide/tekton-pipelines.md index 60d5a77d7..11366f9c3 100644 --- a/versioned_docs/version-3.12/user-guide/tekton-pipelines.md +++ b/versioned_docs/version-3.12/user-guide/tekton-pipelines.md @@ -19,6 +19,10 @@ import TabItem from '@theme/TabItem'; KubeRocketCI is a platform that utilizes the Tekton stack to implement continuous integration and continuous delivery (CI/CD) pipelines, offering access to all Tekton features. It comes pre-configured with various Tekton resources, including pipelines, tasks, triggers, and other components. This documentation outlines how to interact with these Tekton resources within the KubeRocketCI platform, addressing common use cases, pipeline configuration, and execution processes. +
+ +
+ ## Prerequisites Before executing pipelines, ensure that the project is onboarded to the KubeRocketCI platform and that the relevant branches are properly configured.