diff --git a/cspell.config.yaml b/cspell.config.yaml index c505edaec6..3bb8ef23ba 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -115,6 +115,7 @@ words: - Flexera - finalizer - finalizers + - Firstname - fluentbit - fullname - Fzcw @@ -178,6 +179,7 @@ words: - kuberocketci - kubri - kubrix + - Lastname - ldflags - lifecycles - lintconf diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/add-environment.png b/docs/assets/use-cases/deploy-application-from-feature-branch/add-environment.png new file mode 100644 index 0000000000..183c34a1d1 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/add-environment.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/application-diff.png b/docs/assets/use-cases/deploy-application-from-feature-branch/application-diff.png index c575355621..5dea655010 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/application-diff.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/application-diff.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/application-pod.png b/docs/assets/use-cases/deploy-application-from-feature-branch/application-pod.png index ceb93fb07f..09da2db416 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/application-pod.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/application-pod.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png b/docs/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png index a67a9a0686..976e8c4c2f 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png b/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png new file mode 100644 index 0000000000..4aea9da95f Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png b/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png index 49a3304c8e..085485d2ba 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png b/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png index d1a79be1dd..5c5bd17127 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png b/docs/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png index e6df547354..db5fde39d7 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png b/docs/assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png deleted file mode 100644 index 6e90bbe82a..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/build-application.png b/docs/assets/use-cases/deploy-application-from-feature-branch/build-application.png index 8c909bd417..66e5870e81 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/build-application.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/build-application.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png b/docs/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png index 50817182ab..cd116f609d 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png b/docs/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png index 98aab27d54..66dd6e7e33 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png index f22be44900..27442f1023 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png new file mode 100644 index 0000000000..a21cece01d Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png new file mode 100644 index 0000000000..9711418e03 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png deleted file mode 100644 index 41e11278f8..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png deleted file mode 100644 index 891e3a5258..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png new file mode 100644 index 0000000000..c16e7c4f74 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png new file mode 100644 index 0000000000..e263b7ec89 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png deleted file mode 100644 index fa4b7d760c..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png new file mode 100644 index 0000000000..6866fa8524 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png deleted file mode 100644 index a7fb1032cd..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png new file mode 100644 index 0000000000..09a184e925 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png new file mode 100644 index 0000000000..48c6b1064b Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png new file mode 100644 index 0000000000..480a49041f Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-application.png b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-application.png index 80bd7ab78d..29e507bdc2 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-application.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-application.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png deleted file mode 100644 index 1b045d4fb9..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png new file mode 100644 index 0000000000..e63aa13d33 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png deleted file mode 100644 index 6de9af14d5..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png new file mode 100644 index 0000000000..311ef0bf90 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png index 8a459bece9..3267e9c2fb 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png b/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png index 675ed7103f..979b5a26ec 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png b/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png index 96eb2af34f..e2d1114591 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/deployment-created.png b/docs/assets/use-cases/deploy-application-from-feature-branch/deployment-created.png new file mode 100644 index 0000000000..543c1159da Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/deployment-created.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/edit-codebase-branch.png b/docs/assets/use-cases/deploy-application-from-feature-branch/edit-codebase-branch.png deleted file mode 100644 index d42678c94d..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/edit-codebase-branch.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png b/docs/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png index a3264729d4..5884a94b0b 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png b/docs/assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png new file mode 100644 index 0000000000..899f9ef2d7 Binary files /dev/null and b/docs/assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png b/docs/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png index 6b88bcd58e..ef15046ce2 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png b/docs/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png index 3446db8232..b69bf1ee21 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png b/docs/assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png deleted file mode 100644 index 2b01d94571..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/merge-pull-request-bitbucket.png b/docs/assets/use-cases/deploy-application-from-feature-branch/merge-pull-request-bitbucket.png deleted file mode 100644 index beb8e44fb1..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/merge-pull-request-bitbucket.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png b/docs/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png index 3118ce879d..a056e8d3d5 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/pull-request-details.png b/docs/assets/use-cases/deploy-application-from-feature-branch/pull-request-details.png deleted file mode 100644 index b0d8a340c4..0000000000 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/pull-request-details.png and /dev/null differ diff --git a/docs/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png b/docs/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png index 607c0fc42c..1d3ebb1ef7 100644 Binary files a/docs/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png and b/docs/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png differ diff --git a/docs/use-cases/application-scaffolding.md b/docs/use-cases/application-scaffolding.md index 4c9769e0bd..6421af2fef 100644 --- a/docs/use-cases/application-scaffolding.md +++ b/docs/use-cases/application-scaffolding.md @@ -157,7 +157,7 @@ To succeed with the steps above, follow the instructions below: ![Applications step](../assets/use-cases/fastapi-scaffolding/create-deployment-applications.png "Applications step") - - **Add applications**: + - **Pipeline configuration**: - Pipeline name: `mypipe` - Description: `Deployment for FastAPI application` @@ -190,6 +190,7 @@ To succeed with the steps above, follow the instructions below: ![Basic configuration step](../assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png "Basic configuration step") + - **Pipeline configuration**: - Trigger type: `Manual` - Deploy Pipeline template: `deploy` diff --git a/docs/use-cases/deploy-application-from-feature-branch.md b/docs/use-cases/deploy-application-from-feature-branch.md index ad2e6e6206..61f378b134 100644 --- a/docs/use-cases/deploy-application-from-feature-branch.md +++ b/docs/use-cases/deploy-application-from-feature-branch.md @@ -15,7 +15,7 @@ sidebar_label: "Deploy Application From a Feature Branch" Deploying feature branches is crucial for testing activities, including manual testing of the product's functionality, running quality gates, and verifying dependencies or integrations with other components. -The KubeRocketCI platform enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. +KubeRocketCI enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. For a hands-on, end-to-end walkthrough on a local cluster — covering auto-triggered deployments, proof of namespace isolation, per-environment GitOps values override, and one-click teardown — see the [Ephemeral Environments on Kubernetes: Feature Branch Preview Walkthrough](/blog/ephemeral-preview-environments-kubernetes-feature-branch) blog post. @@ -25,28 +25,28 @@ For a hands-on, end-to-end walkthrough on a local cluster — covering auto-trig ### Preconditions -Before you start passing the use case, ensure to meet the following requirements: +Before you start the use case, ensure to meet the following requirements: - KubeRocketCI instance is [configured](../operator-guide/prerequisites.md) with [GitOps](../user-guide/gitops.md) repository. -- Developer has access to the KubeRocketCI instances using the [Single-Sign-On](../operator-guide/auth/platform-auth-model.md) approach or via token. +- Developer has access to the KubeRocketCI instance using the [Single-Sign-On](../operator-guide/auth/platform-auth-model.md) approach or via token. - Developer has access to the KubeRocketCI platform under the [Developer](../operator-guide/auth/platform-auth-model.md#keycloak-groups) role. -- Developer has merge permissions in [Bitbucket](../user-guide/gitops.md). -- Application you want to add a branch to is onboarded in KubeRocketCI. +- Application you want to add a branch to is [onboarded](../user-guide/add-application.md) in KubeRocketCI. + ### Goals Below are the goals to complete in the use case: - Onboard a feature branch for the application. -- Configure GitOps approach for the environment by adding a values.yaml file with application parameters within it. -- Deploy application with redefined parameters. +- Configure the GitOps approach for the Environment by adding a values.yaml file with application parameters within it. +- Deploy application with overridden parameters. ## Scenario The use case scenario contains the following stages: - **Create a feature branch**: Create a feature branch and build artifact for it. -- **Create a deployment flow**: Create a deployment flow that contains an environment and deploy application within the environment. +- **Create a Deployment**: Create a Deployment that contains an Environment and deploy application within the Environment. - **Configure application parameters**: Adjust a GitOps repository by adding custom application configuration into it. - **Apply custom settings for application**: Deploy application with custom parameters. @@ -54,22 +54,26 @@ The use case scenario contains the following stages: There are two approaches to onboard a feature branch: -1. **Create a Feature Branch via KubeRocketCI**: KubeRocketCI creates a new branch in Bitbucket. -2. **Onboard an Existing Branch in KubeRocketCI**: Manually [create the branch in Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/branch-a-repository/) using the correct naming convention and then onboard it into KubeRocketCI. +1. **Create a Feature Branch via KubeRocketCI**: KubeRocketCI creates a new branch in GitHub. +2. **Onboard an Existing Branch in KubeRocketCI**: Manually [create the branch in GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) using the correct naming convention and then onboard it into KubeRocketCI. In this use case, we will follow the first approach to add a branch. When creating a feature branch, ensure the branch name is lowercase to meet Kubernetes restrictions. As an example, we will use the `feature/` pattern as a naming convention for feature branches. -To create a feature branch via KubeRocketCI. Follow these steps: +To create a feature branch via KubeRocketCI, follow these steps: 1. Open the KubeRocketCI portal and log into the platform: - ![Login page](../assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png "Login page") + ![Login page](../assets/use-cases/general/login-1.png "Login page") + +2. Navigate to the **Projects** section and select the desired Project. + +3. Select the **Branches** tab and click the **Create branch** button: -2. Navigate to the **Components** section and select the desired component by clicking its name. + ![Create branch](../assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png "Create branch") -3. Click the **Create branch** button and fill in the form: +4. Click the **Create branch** button and fill in the form: * **Branch Name**: Specify the name (e.g., `feature/tt-000`). * **From Commit Hash**: Specify the commit hash or leave it empty for the latest commit. @@ -77,21 +81,21 @@ To create a feature branch via KubeRocketCI. Follow these steps: * **Review Pipeline**: Leave the default pipeline. * **Build Pipeline**: Leave the default pipeline. - ![Create branch button](../assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png "Create branch button") + ![Create branch button](../assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png "Create branch button") -4. Click **Create** to finalize the branch creation. +5. Click **Create** to finalize the branch creation. -5. The branch will also be created in Bitbucket. Verify its creation in the repository: +6. The branch will also be created in GitHub. Verify its creation in the repository: - ![Codebase branches in Bitbucket](../assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png "Codebase branches in Bitbucket") + ![Codebase branches in GitHub](../assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png "Codebase branches in GitHub") - Since we don't create merge request to merge our feature with the main branch, we need to manually trigger the build pipeline in KubeRocketCI portal. + Since we don't create a pull request to merge our feature with the main branch, we need to manually trigger the build pipeline in the KubeRocketCI portal. -6. Build the application using the **Build** button: +7. Build the application using the **Build** button: ![Build button](../assets/use-cases/deploy-application-from-feature-branch/build-application.png "Build button") -7. View the build pipeline run details by clicking the pipeline run name: +8. View the build pipeline run details by selecting the PipelineRun name: ![Build pipeline details](../assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png "Build pipeline details") @@ -99,51 +103,92 @@ To create a feature branch via KubeRocketCI. Follow these steps: Once you have completed the onboarding process for the feature branch, you can deploy its artifacts to a dedicated feature environment. -#### Create Deployment Flow +#### Create Deployment -We recommend using initials to name the deployment flow. For example, a user with the email `firstname_lastname@example.com` should use `fl` as the identifier. +We recommend using initials to name the Deployment. For example, a user with the email `firstname_lastname@example.com` should use `fl` as the identifier. To create a feature environment, follow the steps below: -1. Open the **Deployment Flows** section and click **Create Deployment Flow**: +1. Open the **Deployments** section and click **Create Deployment**: + + ![Create deployment button](../assets/use-cases/general/create-cd-pipeline-1.png "Create deployment button") + +2. In the **Create new deployment** dialog, fill in the required fields: + + - **Applications**: + + - Applications: Add `inventory-service` application + - Branch: Select `feature/tt-000` branch + + ![Applications step](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png "Applications step") + + - **Pipeline configuration**: + + - Pipeline name: `fl` + - Description: `Deploy the "inventory-service" application for the "Firstname Lastname" user` + - Deployment type: Select `Container` + - Promote applications: Leave unchecked + + ![Pipeline configuration step](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png "Pipeline configuration step") - ![Create deployment flow button](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png "Create deployment flow button") + - **Review**: -2. Select components and branches for the deployment flow. Disable the **Promote Applications** switcher for environments without Quality Gate promotion and click **Create**: + Verify the Deployment configuration and click **Create deployment**: - ![Enter name window](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png "Enter name window") + ![Review step](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png "Review step") + +3. In the congratulations window, click **Open deployment**: + + ![Deployment created](../assets/use-cases/deploy-application-from-feature-branch/deployment-created.png "Deployment created") #### Create Environment -The next step is to create an environment: +The next step is to create an Environment: + +1. On the Deployment details page, click the **Create Environment** button: + + ![Create environment](../assets/use-cases/deploy-application-from-feature-branch/add-environment.png "Create environment") + +2. Fill in the required fields: + + - **Basic configuration**: + + - Cluster: `in-cluster` + - Environment name: `dev` + - Deploy namespace: `krci-fl-dev` + - Description: `Personal environment for Firstname Lastname user` + + ![Basic configuration step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png "Basic configuration step") + + - **Pipeline configuration**: + + - Trigger type: `Manual` + - Deploy Pipeline template: `deploy` + - Clean Pipeline template: `clean` + + ![Pipeline configuration step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png "Pipeline configuration step") -1. Select the deployment flow from the **Deployment Flows** section. + - **Quality Gates**: -2. Click the **Create Environment** button and fill in the form: + Leave everything as is: - * **Cluster**: Choose the target cluster. - * **Environment Name**: Specify the name (`dev`). - * **Description**: Specify the description for the environment. - * **Deploy Pipeline Template**: Select the deployment pipeline (`deploy`). - * **Namespace**: Use the pre-defined namespace without modifications. - * **Trigger Type**: Select `Manual`. - * **Clean Pipeline Template**: Choose the clean pipeline (`clean`) + ![Quality gates step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png "Quality gates step") -![Create environment menu](../assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png "Create environment menu") + - **Review**: -3. Set Manual as the Quality Gate type and click **Create**: + Review the specified values and click the **Create environment** button: -![Add quality gates menu](../assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png "Add quality gates menu") + ![Review step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png "Review step") -4. On the congratulations window, click **Go to environment**. +3. In the congratulations window, click **Go to environment**. -The feature environment is now ready for deployment. +The feature Environment is now ready for deployment. #### Deploy Application To deploy an application, follow the steps below: -1. Click **Configure Deploy**, select the image tag to be deployed, and proceed with the **Start Deploy** button: +1. Click **Configure deploy**, select the image tag to be deployed, and proceed with the **Start deploy** button: ![Application deployment](../assets/use-cases/deploy-application-from-feature-branch/deploy-application.png "Application deployment") @@ -155,7 +200,7 @@ To deploy an application, follow the steps below: ![View deploy pipeline details](../assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png "View deploy pipeline details") -4. Open application in Argo CD by clicking the **Argo CD** button: +4. Open the application in Argo CD using the **Argo CD** button: ![Check deploy pipeline run](../assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png "Check deploy pipeline run") @@ -165,19 +210,19 @@ To deploy an application, follow the steps below: ### Deploy With Custom Parameters -The platform utilizes a Helm chart found in the **deploy-templates** folder of each component repository. To deploy a feature branch with custom variables, select the **Values override** option on the environment page. The **Values override** option allows to redefine default parameters in the **deploy-templates** folder of the Helm chart. +The platform utilizes a Helm chart found in the **deploy-templates** folder of each Project repository. To deploy a feature branch with custom variables, select the **Values override** option on the Environment page. The **Values override** option allows you to override default parameters in the **deploy-templates** folder of the Helm chart. :::note Before enabling this option, you must provide custom parameters for the application. To do this, please add the required values to the `values.yaml` file in the GitOps repository, ensuring you follow the expected structure. ::: -For the `inventory-service` application, no Helm chart variables are defined yet. So, we will modify the Helm chart to add a parameter. If your Helm chart already has variables to redefine, you can proceed to step 4. +For the `inventory-service` application, no Helm chart variables are defined yet. So, we will modify the Helm chart to add a parameter. If your Helm chart already has variables to override, you can proceed to step 4. 1. In KubeRocketCI, navigate back to the application and open the branch source code: ![Open application source code](../assets/use-cases/deploy-application-from-feature-branch/application-source-code.png "Open application source code") -2. Clone the application repository to the local machine. Checkout to the feature branch and paste the contents below to the `deploy-templates/templates/deployment.yaml` and `deploy-templates/values.yaml` files: +2. Clone the application repository to the local machine. Check out the feature branch and paste the contents below to the `deploy-templates/templates/deployment.yaml` and `deploy-templates/values.yaml` files: ```yaml title="values.yaml" @@ -207,15 +252,15 @@ The resulting difference should look this way: ![Open application source code](../assets/use-cases/deploy-application-from-feature-branch/application-diff.png "Open application source code") -3. Commit your changes and push your branch to the origin. +3. Commit your changes, push your branch to the remote repository, and build the application (feature branch) once again. -4. Open the GitOps repository by clicking the **Go to the source code** button: +4. Open the GitOps repository using the **Go to the source code** button: ![Go to the source code button](../assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png "Go to the source code button") -5. Clone the GitOps repository to the local machine. Checkout to another branch and create a file by the `//-values.yaml` pattern (in our case, `fl/dev/notifications-service-values.yaml`). +5. Clone the GitOps repository to the local machine. Check out another branch and create a file by the `//-values.yaml` pattern (in our case, `fl/dev/inventory-service-values.yaml`). -6. Open the `//-values.yaml` file and paste the contents below: +6. Open the `//-values.yaml` file and paste the contents below: ```yaml title="values.yaml" @@ -225,19 +270,19 @@ extraEnv: ``` -7. Commit your changes, push your branch to the origin and create a pull request: +7. Commit your changes, push your branch to the remote repository and create a pull request: ![Pull request details](../assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png "Pull request details") 8. Merge the pull request. -9. On the environment page, click the **Configure Deploy** button. When deploying an application, enable the **Values Override** option in the environment settings: +9. On the Environment page, click the **Configure deploy** button. When deploying an application, enable the **Values override** option in the Environment settings: ![Enable values override option](../assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png "Enable values override option") - When the **Values Override** option is enabled, the platform navigates to the GitOps repository to pull the parameters from the `-values.yaml` file and then redefines them in an Argo CD application accordingly. + When the **Values override** option is enabled, the platform navigates to the GitOps repository to pull the parameters from the `-values.yaml` file and then overrides them in an Argo CD application accordingly. -10. If the application is deployed in the "in-cluster", open the pod terminal using a dedicated button in the environment details page: +10. If the application is deployed in the "in-cluster", open the pod terminal using a dedicated button on the Environment details page: ![Show logs button](../assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png "Show logs button") @@ -249,7 +294,7 @@ env | grep NAME ![Show logs button](../assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png "Show logs button") -12. (Optional) If you deploy the application in the [remote cluster](../user-guide/add-cluster.md), you can open the deployed application in Argo CD and click the pod block: +12. (Optional) If you deploy the application in the [remote cluster](../user-guide/add-cluster.md), you can open the deployed application in Argo CD and select the pod block: ![Enable values override option](../assets/use-cases/deploy-application-from-feature-branch/application-pod.png "Enable values override option") @@ -259,44 +304,44 @@ env | grep NAME env | grep NAME ``` - ![Application terminal (Argo CD)](../assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png "Application terminal (Argo CD)") + ![Application terminal (Argo CD)](../assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png "Application terminal (Argo CD)") ### Cleanup -After merging the feature branch, please delete the branch and environment. +After merging the feature branch, please delete the branch and Environment. #### Delete Feature Environment -1. In the KubeRocketCI portal, return to the environment. +1. In the KubeRocketCI portal, return to the Environment. -2. Select application from the **Applications** tab and click the **Delete** button to remove the application from the environment: +2. Select the application from the **Applications** tab and click the **Delete** button to remove the application from the Environment: ![Delete application from environment](../assets/use-cases/deploy-application-from-feature-branch/delete-application.png "Delete application from environment") -3. Navigate to the **Deployment Flows** section. Click the actions button and select **Delete**: +3. Navigate to the **Deployments** section. Click the actions button and select **Delete**: - ![Delete deployment flow](../assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png "Delete deployment flow") + ![Delete deployment](../assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png "Delete deployment") #### Delete Feature Branch The last step is to delete a feature branch for the application: -1. Navigate to the **Components** section. +1. Navigate to the **Projects** section. -2. Open to the component where you want to delete the feature branch. +2. Open the Project that contains the feature branch. 3. Delete the branch from the **Branches** tab: ![Delete branch in KubeRocketCI](../assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png "Delete branch in KubeRocketCI") -4. Delete the feature branch from Bitbucket: +4. Delete the feature branch from GitHub: - ![Delete branch in Bitbucket](../assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png "Delete branch in Bitbucket") + ![Delete branch in GitHub](../assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png "Delete branch in GitHub") ## Related Articles - [Use Cases](./index.md) - [Add Application](../user-guide/add-application.md) -- [Add Deployment Flow](../user-guide/add-cd-pipeline.md) -- [Manage Deployment Flows](../user-guide/manage-environments.md) +- [Add Deployment](../user-guide/add-cd-pipeline.md) +- [Manage Deployments](../user-guide/manage-environments.md) - [Manage GitOps](../user-guide/gitops.md) diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/add-environment.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/add-environment.png new file mode 100644 index 0000000000..183c34a1d1 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/add-environment.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-diff.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-diff.png index c575355621..5dea655010 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-diff.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-diff.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-pod.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-pod.png index ceb93fb07f..09da2db416 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-pod.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-pod.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png index a67a9a0686..976e8c4c2f 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-source-code.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png new file mode 100644 index 0000000000..4aea9da95f Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png index 49a3304c8e..085485d2ba 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png index d1a79be1dd..5c5bd17127 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/application-terminal.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png index e6df547354..db5fde39d7 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/argo-cd-state.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png deleted file mode 100644 index 6e90bbe82a..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-application.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-application.png index 8c909bd417..66e5870e81 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-application.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-application.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png index 50817182ab..cd116f609d 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png index 98aab27d54..66dd6e7e33 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/check-deploy-pipeline.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png index f22be44900..27442f1023 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png new file mode 100644 index 0000000000..a21cece01d Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png new file mode 100644 index 0000000000..9711418e03 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png deleted file mode 100644 index 41e11278f8..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png deleted file mode 100644 index 891e3a5258..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png new file mode 100644 index 0000000000..c16e7c4f74 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png new file mode 100644 index 0000000000..e263b7ec89 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png deleted file mode 100644 index fa4b7d760c..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png new file mode 100644 index 0000000000..6866fa8524 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png deleted file mode 100644 index a7fb1032cd..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png new file mode 100644 index 0000000000..09a184e925 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png new file mode 100644 index 0000000000..48c6b1064b Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png new file mode 100644 index 0000000000..480a49041f Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-application.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-application.png index 80bd7ab78d..29e507bdc2 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-application.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-application.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png deleted file mode 100644 index 1b045d4fb9..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png new file mode 100644 index 0000000000..e63aa13d33 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png deleted file mode 100644 index 6de9af14d5..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png new file mode 100644 index 0000000000..311ef0bf90 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png index 8a459bece9..3267e9c2fb 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png index 675ed7103f..979b5a26ec 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-application.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png index 96eb2af34f..e2d1114591 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deployment-created.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deployment-created.png new file mode 100644 index 0000000000..543c1159da Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/deployment-created.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/edit-codebase-branch.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/edit-codebase-branch.png deleted file mode 100644 index d42678c94d..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/edit-codebase-branch.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png index a3264729d4..5884a94b0b 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png new file mode 100644 index 0000000000..899f9ef2d7 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png index 6b88bcd58e..ef15046ce2 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png index 3446db8232..b69bf1ee21 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png deleted file mode 100644 index 2b01d94571..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/merge-pull-request-bitbucket.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/merge-pull-request-bitbucket.png deleted file mode 100644 index beb8e44fb1..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/merge-pull-request-bitbucket.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png index 3118ce879d..a056e8d3d5 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/pull-request-details.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/pull-request-details.png deleted file mode 100644 index b0d8a340c4..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/pull-request-details.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png index 607c0fc42c..1d3ebb1ef7 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png and b/versioned_docs/version-3.13/assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png differ diff --git a/versioned_docs/version-3.13/use-cases/application-scaffolding.md b/versioned_docs/version-3.13/use-cases/application-scaffolding.md index 4c9769e0bd..7625959a33 100644 --- a/versioned_docs/version-3.13/use-cases/application-scaffolding.md +++ b/versioned_docs/version-3.13/use-cases/application-scaffolding.md @@ -157,7 +157,7 @@ To succeed with the steps above, follow the instructions below: ![Applications step](../assets/use-cases/fastapi-scaffolding/create-deployment-applications.png "Applications step") - - **Add applications**: + - **Pipeline configuration**: - Pipeline name: `mypipe` - Description: `Deployment for FastAPI application` diff --git a/versioned_docs/version-3.13/use-cases/deploy-application-from-feature-branch.md b/versioned_docs/version-3.13/use-cases/deploy-application-from-feature-branch.md index ad2e6e6206..61f378b134 100644 --- a/versioned_docs/version-3.13/use-cases/deploy-application-from-feature-branch.md +++ b/versioned_docs/version-3.13/use-cases/deploy-application-from-feature-branch.md @@ -15,7 +15,7 @@ sidebar_label: "Deploy Application From a Feature Branch" Deploying feature branches is crucial for testing activities, including manual testing of the product's functionality, running quality gates, and verifying dependencies or integrations with other components. -The KubeRocketCI platform enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. +KubeRocketCI enables the deployment of feature environments straight from feature branches. This guide offers comprehensive instructions for managing and deploying these branches. For a hands-on, end-to-end walkthrough on a local cluster — covering auto-triggered deployments, proof of namespace isolation, per-environment GitOps values override, and one-click teardown — see the [Ephemeral Environments on Kubernetes: Feature Branch Preview Walkthrough](/blog/ephemeral-preview-environments-kubernetes-feature-branch) blog post. @@ -25,28 +25,28 @@ For a hands-on, end-to-end walkthrough on a local cluster — covering auto-trig ### Preconditions -Before you start passing the use case, ensure to meet the following requirements: +Before you start the use case, ensure to meet the following requirements: - KubeRocketCI instance is [configured](../operator-guide/prerequisites.md) with [GitOps](../user-guide/gitops.md) repository. -- Developer has access to the KubeRocketCI instances using the [Single-Sign-On](../operator-guide/auth/platform-auth-model.md) approach or via token. +- Developer has access to the KubeRocketCI instance using the [Single-Sign-On](../operator-guide/auth/platform-auth-model.md) approach or via token. - Developer has access to the KubeRocketCI platform under the [Developer](../operator-guide/auth/platform-auth-model.md#keycloak-groups) role. -- Developer has merge permissions in [Bitbucket](../user-guide/gitops.md). -- Application you want to add a branch to is onboarded in KubeRocketCI. +- Application you want to add a branch to is [onboarded](../user-guide/add-application.md) in KubeRocketCI. + ### Goals Below are the goals to complete in the use case: - Onboard a feature branch for the application. -- Configure GitOps approach for the environment by adding a values.yaml file with application parameters within it. -- Deploy application with redefined parameters. +- Configure the GitOps approach for the Environment by adding a values.yaml file with application parameters within it. +- Deploy application with overridden parameters. ## Scenario The use case scenario contains the following stages: - **Create a feature branch**: Create a feature branch and build artifact for it. -- **Create a deployment flow**: Create a deployment flow that contains an environment and deploy application within the environment. +- **Create a Deployment**: Create a Deployment that contains an Environment and deploy application within the Environment. - **Configure application parameters**: Adjust a GitOps repository by adding custom application configuration into it. - **Apply custom settings for application**: Deploy application with custom parameters. @@ -54,22 +54,26 @@ The use case scenario contains the following stages: There are two approaches to onboard a feature branch: -1. **Create a Feature Branch via KubeRocketCI**: KubeRocketCI creates a new branch in Bitbucket. -2. **Onboard an Existing Branch in KubeRocketCI**: Manually [create the branch in Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/branch-a-repository/) using the correct naming convention and then onboard it into KubeRocketCI. +1. **Create a Feature Branch via KubeRocketCI**: KubeRocketCI creates a new branch in GitHub. +2. **Onboard an Existing Branch in KubeRocketCI**: Manually [create the branch in GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) using the correct naming convention and then onboard it into KubeRocketCI. In this use case, we will follow the first approach to add a branch. When creating a feature branch, ensure the branch name is lowercase to meet Kubernetes restrictions. As an example, we will use the `feature/` pattern as a naming convention for feature branches. -To create a feature branch via KubeRocketCI. Follow these steps: +To create a feature branch via KubeRocketCI, follow these steps: 1. Open the KubeRocketCI portal and log into the platform: - ![Login page](../assets/use-cases/deploy-application-from-feature-branch/kuberocketci-login-page.png "Login page") + ![Login page](../assets/use-cases/general/login-1.png "Login page") + +2. Navigate to the **Projects** section and select the desired Project. + +3. Select the **Branches** tab and click the **Create branch** button: -2. Navigate to the **Components** section and select the desired component by clicking its name. + ![Create branch](../assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png "Create branch") -3. Click the **Create branch** button and fill in the form: +4. Click the **Create branch** button and fill in the form: * **Branch Name**: Specify the name (e.g., `feature/tt-000`). * **From Commit Hash**: Specify the commit hash or leave it empty for the latest commit. @@ -77,21 +81,21 @@ To create a feature branch via KubeRocketCI. Follow these steps: * **Review Pipeline**: Leave the default pipeline. * **Build Pipeline**: Leave the default pipeline. - ![Create branch button](../assets/use-cases/deploy-application-from-feature-branch/create-branch-button.png "Create branch button") + ![Create branch button](../assets/use-cases/deploy-application-from-feature-branch/create-branch-window.png "Create branch button") -4. Click **Create** to finalize the branch creation. +5. Click **Create** to finalize the branch creation. -5. The branch will also be created in Bitbucket. Verify its creation in the repository: +6. The branch will also be created in GitHub. Verify its creation in the repository: - ![Codebase branches in Bitbucket](../assets/use-cases/deploy-application-from-feature-branch/bitbucket-codebase-branches.png "Codebase branches in Bitbucket") + ![Codebase branches in GitHub](../assets/use-cases/deploy-application-from-feature-branch/github-codebase-branches.png "Codebase branches in GitHub") - Since we don't create merge request to merge our feature with the main branch, we need to manually trigger the build pipeline in KubeRocketCI portal. + Since we don't create a pull request to merge our feature with the main branch, we need to manually trigger the build pipeline in the KubeRocketCI portal. -6. Build the application using the **Build** button: +7. Build the application using the **Build** button: ![Build button](../assets/use-cases/deploy-application-from-feature-branch/build-application.png "Build button") -7. View the build pipeline run details by clicking the pipeline run name: +8. View the build pipeline run details by selecting the PipelineRun name: ![Build pipeline details](../assets/use-cases/deploy-application-from-feature-branch/build-pipeline-details.png "Build pipeline details") @@ -99,51 +103,92 @@ To create a feature branch via KubeRocketCI. Follow these steps: Once you have completed the onboarding process for the feature branch, you can deploy its artifacts to a dedicated feature environment. -#### Create Deployment Flow +#### Create Deployment -We recommend using initials to name the deployment flow. For example, a user with the email `firstname_lastname@example.com` should use `fl` as the identifier. +We recommend using initials to name the Deployment. For example, a user with the email `firstname_lastname@example.com` should use `fl` as the identifier. To create a feature environment, follow the steps below: -1. Open the **Deployment Flows** section and click **Create Deployment Flow**: +1. Open the **Deployments** section and click **Create Deployment**: + + ![Create deployment button](../assets/use-cases/general/create-cd-pipeline-1.png "Create deployment button") + +2. In the **Create new deployment** dialog, fill in the required fields: + + - **Applications**: + + - Applications: Add `inventory-service` application + - Branch: Select `feature/tt-000` branch + + ![Applications step](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-applications.png "Applications step") + + - **Pipeline configuration**: + + - Pipeline name: `fl` + - Description: `Deploy the "inventory-service" application for the "Firstname Lastname" user` + - Deployment type: Select `Container` + - Promote applications: Leave unchecked + + ![Pipeline configuration step](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-pipeline-configuration.png "Pipeline configuration step") - ![Create deployment flow button](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-enter-name.png "Create deployment flow button") + - **Review**: -2. Select components and branches for the deployment flow. Disable the **Promote Applications** switcher for environments without Quality Gate promotion and click **Create**: + Verify the Deployment configuration and click **Create deployment**: - ![Enter name window](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-flow-add-application.png "Enter name window") + ![Review step](../assets/use-cases/deploy-application-from-feature-branch/create-deployment-review.png "Review step") + +3. In the congratulations window, click **Open deployment**: + + ![Deployment created](../assets/use-cases/deploy-application-from-feature-branch/deployment-created.png "Deployment created") #### Create Environment -The next step is to create an environment: +The next step is to create an Environment: + +1. On the Deployment details page, click the **Create Environment** button: + + ![Create environment](../assets/use-cases/deploy-application-from-feature-branch/add-environment.png "Create environment") + +2. Fill in the required fields: + + - **Basic configuration**: + + - Cluster: `in-cluster` + - Environment name: `dev` + - Deploy namespace: `krci-fl-dev` + - Description: `Personal environment for Firstname Lastname user` + + ![Basic configuration step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-basic-configuration.png "Basic configuration step") + + - **Pipeline configuration**: + + - Trigger type: `Manual` + - Deploy Pipeline template: `deploy` + - Clean Pipeline template: `clean` + + ![Pipeline configuration step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-pipeline-configuration.png "Pipeline configuration step") -1. Select the deployment flow from the **Deployment Flows** section. + - **Quality Gates**: -2. Click the **Create Environment** button and fill in the form: + Leave everything as is: - * **Cluster**: Choose the target cluster. - * **Environment Name**: Specify the name (`dev`). - * **Description**: Specify the description for the environment. - * **Deploy Pipeline Template**: Select the deployment pipeline (`deploy`). - * **Namespace**: Use the pre-defined namespace without modifications. - * **Trigger Type**: Select `Manual`. - * **Clean Pipeline Template**: Choose the clean pipeline (`clean`) + ![Quality gates step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-quality-gates.png "Quality gates step") -![Create environment menu](../assets/use-cases/deploy-application-from-feature-branch/create-environment-configure-stage.png "Create environment menu") + - **Review**: -3. Set Manual as the Quality Gate type and click **Create**: + Review the specified values and click the **Create environment** button: -![Add quality gates menu](../assets/use-cases/deploy-application-from-feature-branch/create-environment-add-qg.png "Add quality gates menu") + ![Review step](../assets/use-cases/deploy-application-from-feature-branch/create-environment-review.png "Review step") -4. On the congratulations window, click **Go to environment**. +3. In the congratulations window, click **Go to environment**. -The feature environment is now ready for deployment. +The feature Environment is now ready for deployment. #### Deploy Application To deploy an application, follow the steps below: -1. Click **Configure Deploy**, select the image tag to be deployed, and proceed with the **Start Deploy** button: +1. Click **Configure deploy**, select the image tag to be deployed, and proceed with the **Start deploy** button: ![Application deployment](../assets/use-cases/deploy-application-from-feature-branch/deploy-application.png "Application deployment") @@ -155,7 +200,7 @@ To deploy an application, follow the steps below: ![View deploy pipeline details](../assets/use-cases/deploy-application-from-feature-branch/deploy-pipeline-details.png "View deploy pipeline details") -4. Open application in Argo CD by clicking the **Argo CD** button: +4. Open the application in Argo CD using the **Argo CD** button: ![Check deploy pipeline run](../assets/use-cases/deploy-application-from-feature-branch/open-in-argo-cd.png "Check deploy pipeline run") @@ -165,19 +210,19 @@ To deploy an application, follow the steps below: ### Deploy With Custom Parameters -The platform utilizes a Helm chart found in the **deploy-templates** folder of each component repository. To deploy a feature branch with custom variables, select the **Values override** option on the environment page. The **Values override** option allows to redefine default parameters in the **deploy-templates** folder of the Helm chart. +The platform utilizes a Helm chart found in the **deploy-templates** folder of each Project repository. To deploy a feature branch with custom variables, select the **Values override** option on the Environment page. The **Values override** option allows you to override default parameters in the **deploy-templates** folder of the Helm chart. :::note Before enabling this option, you must provide custom parameters for the application. To do this, please add the required values to the `values.yaml` file in the GitOps repository, ensuring you follow the expected structure. ::: -For the `inventory-service` application, no Helm chart variables are defined yet. So, we will modify the Helm chart to add a parameter. If your Helm chart already has variables to redefine, you can proceed to step 4. +For the `inventory-service` application, no Helm chart variables are defined yet. So, we will modify the Helm chart to add a parameter. If your Helm chart already has variables to override, you can proceed to step 4. 1. In KubeRocketCI, navigate back to the application and open the branch source code: ![Open application source code](../assets/use-cases/deploy-application-from-feature-branch/application-source-code.png "Open application source code") -2. Clone the application repository to the local machine. Checkout to the feature branch and paste the contents below to the `deploy-templates/templates/deployment.yaml` and `deploy-templates/values.yaml` files: +2. Clone the application repository to the local machine. Check out the feature branch and paste the contents below to the `deploy-templates/templates/deployment.yaml` and `deploy-templates/values.yaml` files: ```yaml title="values.yaml" @@ -207,15 +252,15 @@ The resulting difference should look this way: ![Open application source code](../assets/use-cases/deploy-application-from-feature-branch/application-diff.png "Open application source code") -3. Commit your changes and push your branch to the origin. +3. Commit your changes, push your branch to the remote repository, and build the application (feature branch) once again. -4. Open the GitOps repository by clicking the **Go to the source code** button: +4. Open the GitOps repository using the **Go to the source code** button: ![Go to the source code button](../assets/use-cases/deploy-application-from-feature-branch/go-to-the-source-code.png "Go to the source code button") -5. Clone the GitOps repository to the local machine. Checkout to another branch and create a file by the `//-values.yaml` pattern (in our case, `fl/dev/notifications-service-values.yaml`). +5. Clone the GitOps repository to the local machine. Check out another branch and create a file by the `//-values.yaml` pattern (in our case, `fl/dev/inventory-service-values.yaml`). -6. Open the `//-values.yaml` file and paste the contents below: +6. Open the `//-values.yaml` file and paste the contents below: ```yaml title="values.yaml" @@ -225,19 +270,19 @@ extraEnv: ``` -7. Commit your changes, push your branch to the origin and create a pull request: +7. Commit your changes, push your branch to the remote repository and create a pull request: ![Pull request details](../assets/use-cases/deploy-application-from-feature-branch/gitops-difference.png "Pull request details") 8. Merge the pull request. -9. On the environment page, click the **Configure Deploy** button. When deploying an application, enable the **Values Override** option in the environment settings: +9. On the Environment page, click the **Configure deploy** button. When deploying an application, enable the **Values override** option in the Environment settings: ![Enable values override option](../assets/use-cases/deploy-application-from-feature-branch/enable-values-override.png "Enable values override option") - When the **Values Override** option is enabled, the platform navigates to the GitOps repository to pull the parameters from the `-values.yaml` file and then redefines them in an Argo CD application accordingly. + When the **Values override** option is enabled, the platform navigates to the GitOps repository to pull the parameters from the `-values.yaml` file and then overrides them in an Argo CD application accordingly. -10. If the application is deployed in the "in-cluster", open the pod terminal using a dedicated button in the environment details page: +10. If the application is deployed in the "in-cluster", open the pod terminal using a dedicated button on the Environment details page: ![Show logs button](../assets/use-cases/deploy-application-from-feature-branch/show-terminal-button.png "Show logs button") @@ -249,7 +294,7 @@ env | grep NAME ![Show logs button](../assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png "Show logs button") -12. (Optional) If you deploy the application in the [remote cluster](../user-guide/add-cluster.md), you can open the deployed application in Argo CD and click the pod block: +12. (Optional) If you deploy the application in the [remote cluster](../user-guide/add-cluster.md), you can open the deployed application in Argo CD and select the pod block: ![Enable values override option](../assets/use-cases/deploy-application-from-feature-branch/application-pod.png "Enable values override option") @@ -259,44 +304,44 @@ env | grep NAME env | grep NAME ``` - ![Application terminal (Argo CD)](../assets/use-cases/deploy-application-from-feature-branch/application-terminal-krci.png "Application terminal (Argo CD)") + ![Application terminal (Argo CD)](../assets/use-cases/deploy-application-from-feature-branch/application-terminal-argo-cd.png "Application terminal (Argo CD)") ### Cleanup -After merging the feature branch, please delete the branch and environment. +After merging the feature branch, please delete the branch and Environment. #### Delete Feature Environment -1. In the KubeRocketCI portal, return to the environment. +1. In the KubeRocketCI portal, return to the Environment. -2. Select application from the **Applications** tab and click the **Delete** button to remove the application from the environment: +2. Select the application from the **Applications** tab and click the **Delete** button to remove the application from the Environment: ![Delete application from environment](../assets/use-cases/deploy-application-from-feature-branch/delete-application.png "Delete application from environment") -3. Navigate to the **Deployment Flows** section. Click the actions button and select **Delete**: +3. Navigate to the **Deployments** section. Click the actions button and select **Delete**: - ![Delete deployment flow](../assets/use-cases/deploy-application-from-feature-branch/delete-deployment-flow.png "Delete deployment flow") + ![Delete deployment](../assets/use-cases/deploy-application-from-feature-branch/delete-deployment.png "Delete deployment") #### Delete Feature Branch The last step is to delete a feature branch for the application: -1. Navigate to the **Components** section. +1. Navigate to the **Projects** section. -2. Open to the component where you want to delete the feature branch. +2. Open the Project that contains the feature branch. 3. Delete the branch from the **Branches** tab: ![Delete branch in KubeRocketCI](../assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-portal.png "Delete branch in KubeRocketCI") -4. Delete the feature branch from Bitbucket: +4. Delete the feature branch from GitHub: - ![Delete branch in Bitbucket](../assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-bitbucket.png "Delete branch in Bitbucket") + ![Delete branch in GitHub](../assets/use-cases/deploy-application-from-feature-branch/delete-feature-branch-github.png "Delete branch in GitHub") ## Related Articles - [Use Cases](./index.md) - [Add Application](../user-guide/add-application.md) -- [Add Deployment Flow](../user-guide/add-cd-pipeline.md) -- [Manage Deployment Flows](../user-guide/manage-environments.md) +- [Add Deployment](../user-guide/add-cd-pipeline.md) +- [Manage Deployments](../user-guide/manage-environments.md) - [Manage GitOps](../user-guide/gitops.md)