diff --git a/docs/assets/use-cases/fastapi-scaffolding/add-environment.png b/docs/assets/use-cases/fastapi-scaffolding/add-environment.png index 62432bd420..fba6e88322 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/add-environment.png and b/docs/assets/use-cases/fastapi-scaffolding/add-environment.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/add-gitops-button.png b/docs/assets/use-cases/fastapi-scaffolding/add-gitops-button.png new file mode 100644 index 0000000000..0461c881f0 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/add-gitops-button.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/add-gitops-repo.png b/docs/assets/use-cases/fastapi-scaffolding/add-gitops-repo.png new file mode 100644 index 0000000000..c378df0750 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/add-gitops-repo.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/add_gitops_button.png b/docs/assets/use-cases/fastapi-scaffolding/add_gitops_button.png deleted file mode 100644 index cadaf4ca21..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/add_gitops_button.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/add_gitops_repo.png b/docs/assets/use-cases/fastapi-scaffolding/add_gitops_repo.png deleted file mode 100644 index 3286c1302a..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/add_gitops_repo.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/build-application.png b/docs/assets/use-cases/fastapi-scaffolding/build-application.png index 35809c756a..f8924c7526 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/build-application.png and b/docs/assets/use-cases/fastapi-scaffolding/build-application.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/build-details.png b/docs/assets/use-cases/fastapi-scaffolding/build-details.png new file mode 100644 index 0000000000..c7bcd6d3af Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/build-details.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/build-in-process.png b/docs/assets/use-cases/fastapi-scaffolding/build-in-process.png index 3262f354cf..726c73a19b 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/build-in-process.png and b/docs/assets/use-cases/fastapi-scaffolding/build-in-process.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/build_details.png b/docs/assets/use-cases/fastapi-scaffolding/build_details.png deleted file mode 100644 index 47d027cc88..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/build_details.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-application-advance.png b/docs/assets/use-cases/fastapi-scaffolding/create-application-advance.png index 375e338a02..93312c32ae 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/create-application-advance.png and b/docs/assets/use-cases/fastapi-scaffolding/create-application-advance.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-application.png b/docs/assets/use-cases/fastapi-scaffolding/create-application.png index 2ca80c1e5d..7b3e1aa189 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/create-application.png and b/docs/assets/use-cases/fastapi-scaffolding/create-application.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png b/docs/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png deleted file mode 100644 index 8597c0c945..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png b/docs/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png deleted file mode 100644 index 58b31e560a..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-deployment-applications.png b/docs/assets/use-cases/fastapi-scaffolding/create-deployment-applications.png new file mode 100644 index 0000000000..6d00b7324b Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-deployment-applications.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png b/docs/assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png new file mode 100644 index 0000000000..b145360310 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-deployment-review.png b/docs/assets/use-cases/fastapi-scaffolding/create-deployment-review.png new file mode 100644 index 0000000000..ef779610de Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-deployment-review.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png b/docs/assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png new file mode 100644 index 0000000000..1706004480 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png b/docs/assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png new file mode 100644 index 0000000000..66eb918030 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png b/docs/assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png new file mode 100644 index 0000000000..3ad3c5879a Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-environment-review.png b/docs/assets/use-cases/fastapi-scaffolding/create-environment-review.png new file mode 100644 index 0000000000..a5b94a03d8 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-environment-review.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-gitops.png b/docs/assets/use-cases/fastapi-scaffolding/create-gitops.png new file mode 100644 index 0000000000..2e83584de7 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/create-gitops.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create-stage.png b/docs/assets/use-cases/fastapi-scaffolding/create-stage.png deleted file mode 100644 index 610096efde..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/create-stage.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/create_gitops.png b/docs/assets/use-cases/fastapi-scaffolding/create_gitops.png deleted file mode 100644 index b59e2a5770..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/create_gitops.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png b/docs/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png index 3f52290311..f7c688c12c 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png and b/docs/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png b/docs/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png index 41903873c7..1dcff4f7db 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png and b/docs/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png b/docs/assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png new file mode 100644 index 0000000000..db1e6fae46 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png b/docs/assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png new file mode 100644 index 0000000000..d95cc4a107 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/deploy-with-override.png b/docs/assets/use-cases/fastapi-scaffolding/deploy-with-override.png index 9aa7d65f0b..87d1fa5b10 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/deploy-with-override.png and b/docs/assets/use-cases/fastapi-scaffolding/deploy-with-override.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/deployment-created.png b/docs/assets/use-cases/fastapi-scaffolding/deployment-created.png new file mode 100644 index 0000000000..20481ac33c Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/deployment-created.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/flow-created.png b/docs/assets/use-cases/fastapi-scaffolding/flow-created.png deleted file mode 100644 index 22964292d0..0000000000 Binary files a/docs/assets/use-cases/fastapi-scaffolding/flow-created.png and /dev/null differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/open-environment.png b/docs/assets/use-cases/fastapi-scaffolding/open-environment.png new file mode 100644 index 0000000000..66e4023d0d Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/open-environment.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/ready-component.png b/docs/assets/use-cases/fastapi-scaffolding/ready-component.png index 25abe17bfe..a740cafafd 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/ready-component.png and b/docs/assets/use-cases/fastapi-scaffolding/ready-component.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/review-and-create.png b/docs/assets/use-cases/fastapi-scaffolding/review-and-create.png new file mode 100644 index 0000000000..7f01136cb4 Binary files /dev/null and b/docs/assets/use-cases/fastapi-scaffolding/review-and-create.png differ diff --git a/docs/assets/use-cases/fastapi-scaffolding/start-deploy.png b/docs/assets/use-cases/fastapi-scaffolding/start-deploy.png index 8314fb32a2..0c75a92e3e 100644 Binary files a/docs/assets/use-cases/fastapi-scaffolding/start-deploy.png and b/docs/assets/use-cases/fastapi-scaffolding/start-deploy.png differ diff --git a/docs/assets/use-cases/general/component-type-1.png b/docs/assets/use-cases/general/component-type-1.png new file mode 100644 index 0000000000..fbc591bb34 Binary files /dev/null and b/docs/assets/use-cases/general/component-type-1.png differ diff --git a/docs/assets/use-cases/general/components-1.png b/docs/assets/use-cases/general/components-1.png new file mode 100644 index 0000000000..3d79813e35 Binary files /dev/null and b/docs/assets/use-cases/general/components-1.png differ diff --git a/docs/assets/use-cases/general/create-cd-pipeline-1.png b/docs/assets/use-cases/general/create-cd-pipeline-1.png new file mode 100644 index 0000000000..b0e14b05fb Binary files /dev/null and b/docs/assets/use-cases/general/create-cd-pipeline-1.png differ diff --git a/docs/assets/use-cases/general/login-1.png b/docs/assets/use-cases/general/login-1.png new file mode 100644 index 0000000000..aa0099de20 Binary files /dev/null and b/docs/assets/use-cases/general/login-1.png differ diff --git a/docs/assets/use-cases/general/settings-1.png b/docs/assets/use-cases/general/settings-1.png new file mode 100644 index 0000000000..e42eb9a34e Binary files /dev/null and b/docs/assets/use-cases/general/settings-1.png differ diff --git a/docs/use-cases/application-scaffolding.md b/docs/use-cases/application-scaffolding.md index 2a15145310..4c9769e0bd 100644 --- a/docs/use-cases/application-scaffolding.md +++ b/docs/use-cases/application-scaffolding.md @@ -47,54 +47,56 @@ To scaffold and deploy FastAPI Application, follow the steps below. 1. Log in to the KubeRocketCI portal: - ![Logging Page](../assets/use-cases/general/login.png "Logging screen") + ![Logging Page](../assets/use-cases/general/login-1.png "Logging screen") -2. Navigate to the user's **Account settings** tab: +2. On the main menu, click the **Manage Namespaces** button: - ![Settings](../assets/use-cases/general/settings.png "Settings button") + ![Manage Namespaces](../assets/use-cases/general/settings-1.png "Manage Namespaces button") 3. Ensure the `Namespace` value points to the namespace with the KubeRocketCI installation: ![Default and allowed namespaces](../assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png "Default and allowed namespaces") :::note - Don't forget to click the **+ Add** button to add the namespace to the allowed namespaces list. + Don't forget to press Enter to add the namespace to the allowed namespaces list. ::: -4. Create a new Codebase with the `Application` type using the `Create from template` strategy. Select the **Components** section and click **+ Create component**: +4. Create a new Project with the `Application` type using the `Create` strategy. Select the **Projects** section and click **+ Create project**: - ![Components Overview](../assets/use-cases/general/components.png "Components tab") + ![Components Overview](../assets/use-cases/general/components-1.png "Components tab") -5. Choose the `Application` Codebase type as we intend to deliver our application as a container and deploy it within the Kubernetes cluster. Click the **Next** button: +5. Select the **Custom configuration** option, choose the `Application` Codebase type as we intend to deliver our application as a container and deploy it within the Kubernetes cluster. Select the **Create** strategy to scaffold our application from the template provided by the KubeRocketCI and click **Continue**: - ![Codebase Type](../assets/use-cases/general/component-type.png "Step codebase type") + ![Initial setup](../assets/use-cases/general/component-type-1.png "Initial setup") -6. Opt for the **Create from template** strategy to scaffold our application from the template provided by the KubeRocketCI and click **Create**: +6. On the **Git & project info** tab, define the following values and click **Continue**: - ![Codebase Strategy](../assets/use-cases/general/component-strategy.png "Step codebase strategy") + - Git server: `github` + - Owner: `github_account_name` + - Repository name: `fastapi-demo` + - Default branch: `main` + - Project name: `fastapi-demo` + - Description: `FastAPI application for demo purposes` -7. On the **Add component info** tab, define the following values and click **Next**: + ![Application info](../assets/use-cases/fastapi-scaffolding/create-application.png "Application info") - - Git server: `github` - - Repository name: `{github_account_name}/fastapi-demo` - - Component name: `fastapi-demo` - - Description: `fastapi-demo` - - Application code language: `Python` +7. On the **Build config** tab, define the values and click **Continue**: + + - Code language: `Python` - Language version/framework: `FastAPI` - Build tool: `Python` + - Deployment options: `helm-chart` + - Codebase versioning type: `semver` + - Start version from: `0.1.0` + - Suffix: `SNAPSHOT` - ![Application Info](../assets/use-cases/fastapi-scaffolding/create-application.png "Application info") + ![Build config](../assets/use-cases/fastapi-scaffolding/create-application-advance.png "Build config") -8. On the **Specify advanced settings** tab, define the values and click **Create**: +8. On the **Review** tab, verify the project configuration and click **Create project**: - - Default branch: `main` - - Deployment Options: `helm-chart` - - Codebase versioning type: `edp` - - Start version from: `0.1.0` and `SNAPSHOT` - - ![Advanced Settings](../assets/use-cases/fastapi-scaffolding/create-application-advance.png "Advanced settings") + ![Review and create](../assets/use-cases/fastapi-scaffolding/review-and-create.png "Review and create") -9. Check the application status. It should be green: +9. On the congratulations menu, click **Open project**: ![Components overview page](../assets/use-cases/fastapi-scaffolding/ready-component.png "Application status") @@ -110,95 +112,130 @@ This section outlines the approach for deploying the application from the latest To succeed with the steps above, follow the instructions below: -1. Build Container from the latest branch commit. To build the initial version of the application's `main` branch, go to the **Components** -> **fastapi-demo** -> **Branches** -> **main** and click the **Build** button: +1. Build Container from the latest branch commit. To build the initial version of the application's `main` branch, go to the **Branches** -> **main** and click the **Build** button: ![Build Main Branch](../assets/use-cases/fastapi-scaffolding/build-application.png "Application building") -2. Build pipeline for the `fastapi-demo` application starts: +2. Build pipeline for the `fastapi-demo` application starts. Track Pipeline's status by clicking the **build-fastapi-demo-main-xxxx** pipeline link or **Go to page**: ![Branch Build Pipeline](../assets/use-cases/fastapi-scaffolding/build-in-process.png "Pipeline building") -3. Track Pipeline's status by clicking the **build-fastapi-demo-main-6ef1** pipeline link. +3. Observe the build pipeline details: - ![Pipeline details](../assets/use-cases/fastapi-scaffolding/build_details.png "Pipeline details") + ![Pipeline details](../assets/use-cases/fastapi-scaffolding/build-details.png "Pipeline details") -4. Ensure that Build Pipeline was successfully completed. +4. Ensure that build pipeline was successfully completed. -5. To enable application deployment create a Deployment Flow with a single environment - Development (with the name `dev`). +5. To enable application deployment, create a Deployment with a single environment - Development (with the name `dev`). :::note To utilize and manage various environments through the KubeRocketCI platform, the initial step is to onboard a new GitOps repository. ::: -6. Navigate to the **Deployment Flows** tab and click the corresponding button to create new GitOps repository: +6. Navigate to the **Deployments** tab and click the corresponding button to create new GitOps repository: - ![Deployment flow tab](../assets/use-cases/fastapi-scaffolding/add_gitops_repo.png "Deployment flow tab") + ![Deployment flow tab](../assets/use-cases/fastapi-scaffolding/add-gitops-repo.png "Deployment flow tab") 7. Click to the **+ Add GitOps repository**: - ![Onboard gitops repository](../assets/use-cases/fastapi-scaffolding/add_gitops_button.png "Onboard GitOps repository") + ![Onboard gitops repository](../assets/use-cases/fastapi-scaffolding/add-gitops-button.png "Onboard GitOps repository") 8. Select the `Create` strategy and `github` server, enter GitHub account name and click **Save**: - ![Configure gitops repository](../assets/use-cases/fastapi-scaffolding/create_gitops.png "Configure gitops repository") + ![Configure gitops repository](../assets/use-cases/fastapi-scaffolding/create-gitops.png "Configure gitops repository") -9. In the KubeRocketCI portal, navigate to **Deployment FLows** tab and click the **+ Create deployment flow** button to create pipeline: +9. In the KubeRocketCI portal, navigate to **Deployments** tab and click the **+ Create deployment** button: - ![Create deployment flow](../assets/use-cases/general/create-cd-pipeline.png "Create deployment flow") + ![Create deployment](../assets/use-cases/general/create-cd-pipeline-1.png "Create deployment") -10. In the **Create deployment flow** dialog, fill in the required fields: +10. In the **Create new deployment** dialog, fill in the required fields: - - **Enter name**: + - **Applications**: - - Pipeline name: `mypipe` - - Description: `Deployment flow for fasapi application` + - Applications: Add `fastapi-demo` application + - Branch: Select `main` branch - ![Deployment flow tab with parameters](../assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png "Deployment flow tab with parameters") + ![Applications step](../assets/use-cases/fastapi-scaffolding/create-deployment-applications.png "Applications step") - **Add applications**: - - Applications: Add `fastapi-demo` application - - Branch: Select `main` branch + - Pipeline name: `mypipe` + - Description: `Deployment for FastAPI application` + - Deployment type: Select `Container` - Promote applications: Leave unchecked - ![Deployment flow tab with parameters](../assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png "Deployment flow tab with parameters") + ![Pipeline configuration step](../assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png "Pipeline configuration step") + + - **Review**: + + Verify the Deployment configuration and click **Create deployment**: + + ![Review step](../assets/use-cases/fastapi-scaffolding/create-deployment-review.png "Review step") + -11. Now click the `Go to deployment flow` button to continue creating the environment: +11. Now click the `Open deployment` button to continue creating the environment: - ![Deployment flow created](../assets/use-cases/fastapi-scaffolding/flow-created.png "Deployment flow created") + ![Deployment created](../assets/use-cases/fastapi-scaffolding/deployment-created.png "Deployment created") -12. In the Deployment Flow details page, click the **+ Create environment** button to create new environment and fill in the required fields: +12. In the Deployment details page, click the **+ Create environment** button to create new environment and fill in the required fields: ![Create environment](../assets/use-cases/fastapi-scaffolding/add-environment.png "Create environment") + - **Basic configuration**: + - Cluster: `in-cluster` - Environment name: `dev` + - Deploy namespace: `krci-mypipe-dev` - Description: `Development Environment` + + ![Basic configuration step](../assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png "Basic configuration step") + + - Trigger type: `Manual` - Deploy Pipeline template: `deploy` - Clean Pipeline template: `clean` - - Quality gate type: `Manual` - ![Environment tab with parameters](../assets/use-cases/fastapi-scaffolding/create-stage.png "Environment tab with parameters") + ![Pipeline configuration step](../assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png "Pipeline configuration step") + + - **Quality Gates**: + + Leave everything as is: + + ![Quality gates step](../assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png "Quality gates step") + + - **Review**: - As soon as the values is defined, click the **Create** button. + Review the specified values and click the **Create environment** button: -13. Deploy the initial version of the application to the development environment: + ![Review step](../assets/use-cases/fastapi-scaffolding/create-environment-review.png "Review step") - - Open deployment flow with the name `mypipe`. - - Select the `dev` environment from the **Environment** tab. +13. As soon as the Environment is created, click **Open environment**: + + ![Open environment](../assets/use-cases/fastapi-scaffolding/open-environment.png "Open environment") + +14. Deploy the initial version of the application to the development environment: + + - Select **Applications** tab. - Click the **Configure deploy** button. - In the **Select image tag** field select version `0.1.0-SNAPSHOT.1` and click the **Start deploy** button. ![CD Pipeline Deploy initial version](../assets/use-cases/fastapi-scaffolding/start-deploy.png "CD Pipeline deploy") +15. Navigate to the **Pipelines** tab and click the pipeline name to view its details: + + ![Deploy pipeline (clickable)](../assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png "Deploy pipeline (clickable)") + +16. View the Pipeline details until it finishes: + + ![Deploy pipeline details](../assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png "Deploy pipeline details") + ### Check the Application Status To ensure the application is deployed successfully, follow the steps below: 1. Ensure application status is `Healthy` and `Synced`, and the `Deployed version` points to `0.1.0-SNAPSHOT.1`: - ![CD Pipeline health status](../assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png "Pipeline health status") + ![Deployment health status](../assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png "Deployment health status") 2. Check that the selected version of the container is deployed on the `dev` environment. `${KRCI_ENV}` - is the KRCI namespace name: @@ -235,7 +272,7 @@ Within the [GitOps](../user-guide/gitops.md) repository, follow the naming conve To ensure our application recognizes the changes in the GitOps repository related to enabling the creation of the `Ingress` resource, we need to set the **Override values** checkbox to `true` before deploying. - - Go to the **Environments** section of the KubeRocketCI portal, select `mypipe` and choose **dev** stage. + - Go to the **Deployments** section of the KubeRocketCI portal, select `mypipe` and choose the **dev** Environment. - In the **Select image tag** section select the version `0.1.0-SNAPSHOT.1`. - Set the **Values override** checkbox to `true` and click the **Start deploy** button. - Check that the application is deployed and application status is `Healthy` and `Synced`. diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-environment.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-environment.png index 62432bd420..fba6e88322 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-environment.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-environment.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-gitops-button.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-gitops-button.png new file mode 100644 index 0000000000..0461c881f0 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-gitops-button.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-gitops-repo.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-gitops-repo.png new file mode 100644 index 0000000000..c378df0750 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add-gitops-repo.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add_gitops_button.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add_gitops_button.png deleted file mode 100644 index cadaf4ca21..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add_gitops_button.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add_gitops_repo.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add_gitops_repo.png deleted file mode 100644 index 3286c1302a..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/add_gitops_repo.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-application.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-application.png index 35809c756a..f8924c7526 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-application.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-application.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-details.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-details.png new file mode 100644 index 0000000000..c7bcd6d3af Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-details.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-in-process.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-in-process.png index 3262f354cf..726c73a19b 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-in-process.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build-in-process.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build_details.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build_details.png deleted file mode 100644 index 47d027cc88..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/build_details.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application-advance.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application-advance.png index 375e338a02..93312c32ae 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application-advance.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application-advance.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application.png index 2ca80c1e5d..7b3e1aa189 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-application.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png deleted file mode 100644 index 8597c0c945..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png deleted file mode 100644 index 58b31e560a..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-applications.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-applications.png new file mode 100644 index 0000000000..6d00b7324b Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-applications.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png new file mode 100644 index 0000000000..b145360310 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-review.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-review.png new file mode 100644 index 0000000000..ef779610de Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-deployment-review.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png new file mode 100644 index 0000000000..1706004480 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png new file mode 100644 index 0000000000..66eb918030 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png new file mode 100644 index 0000000000..3ad3c5879a Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-review.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-review.png new file mode 100644 index 0000000000..a5b94a03d8 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-environment-review.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-gitops.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-gitops.png new file mode 100644 index 0000000000..2e83584de7 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-gitops.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-stage.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-stage.png deleted file mode 100644 index 610096efde..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create-stage.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create_gitops.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create_gitops.png deleted file mode 100644 index b59e2a5770..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/create_gitops.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png index 3f52290311..f7c688c12c 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png index 41903873c7..1dcff4f7db 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png new file mode 100644 index 0000000000..db1e6fae46 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png new file mode 100644 index 0000000000..d95cc4a107 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-with-override.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-with-override.png index 9aa7d65f0b..87d1fa5b10 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-with-override.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deploy-with-override.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deployment-created.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deployment-created.png new file mode 100644 index 0000000000..20481ac33c Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/deployment-created.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/flow-created.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/flow-created.png deleted file mode 100644 index 22964292d0..0000000000 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/flow-created.png and /dev/null differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/open-environment.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/open-environment.png new file mode 100644 index 0000000000..66e4023d0d Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/open-environment.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/ready-component.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/ready-component.png index 25abe17bfe..a740cafafd 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/ready-component.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/ready-component.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/review-and-create.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/review-and-create.png new file mode 100644 index 0000000000..7f01136cb4 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/review-and-create.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/start-deploy.png b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/start-deploy.png index 8314fb32a2..0c75a92e3e 100644 Binary files a/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/start-deploy.png and b/versioned_docs/version-3.13/assets/use-cases/fastapi-scaffolding/start-deploy.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/general/component-type-1.png b/versioned_docs/version-3.13/assets/use-cases/general/component-type-1.png new file mode 100644 index 0000000000..fbc591bb34 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/general/component-type-1.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/general/components-1.png b/versioned_docs/version-3.13/assets/use-cases/general/components-1.png new file mode 100644 index 0000000000..3d79813e35 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/general/components-1.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/general/create-cd-pipeline-1.png b/versioned_docs/version-3.13/assets/use-cases/general/create-cd-pipeline-1.png new file mode 100644 index 0000000000..b0e14b05fb Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/general/create-cd-pipeline-1.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/general/login-1.png b/versioned_docs/version-3.13/assets/use-cases/general/login-1.png new file mode 100644 index 0000000000..aa0099de20 Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/general/login-1.png differ diff --git a/versioned_docs/version-3.13/assets/use-cases/general/settings-1.png b/versioned_docs/version-3.13/assets/use-cases/general/settings-1.png new file mode 100644 index 0000000000..e42eb9a34e Binary files /dev/null and b/versioned_docs/version-3.13/assets/use-cases/general/settings-1.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 2a15145310..4c9769e0bd 100644 --- a/versioned_docs/version-3.13/use-cases/application-scaffolding.md +++ b/versioned_docs/version-3.13/use-cases/application-scaffolding.md @@ -47,54 +47,56 @@ To scaffold and deploy FastAPI Application, follow the steps below. 1. Log in to the KubeRocketCI portal: - ![Logging Page](../assets/use-cases/general/login.png "Logging screen") + ![Logging Page](../assets/use-cases/general/login-1.png "Logging screen") -2. Navigate to the user's **Account settings** tab: +2. On the main menu, click the **Manage Namespaces** button: - ![Settings](../assets/use-cases/general/settings.png "Settings button") + ![Manage Namespaces](../assets/use-cases/general/settings-1.png "Manage Namespaces button") 3. Ensure the `Namespace` value points to the namespace with the KubeRocketCI installation: ![Default and allowed namespaces](../assets/use-cases/fastapi-scaffolding/default-allowed-namespace.png "Default and allowed namespaces") :::note - Don't forget to click the **+ Add** button to add the namespace to the allowed namespaces list. + Don't forget to press Enter to add the namespace to the allowed namespaces list. ::: -4. Create a new Codebase with the `Application` type using the `Create from template` strategy. Select the **Components** section and click **+ Create component**: +4. Create a new Project with the `Application` type using the `Create` strategy. Select the **Projects** section and click **+ Create project**: - ![Components Overview](../assets/use-cases/general/components.png "Components tab") + ![Components Overview](../assets/use-cases/general/components-1.png "Components tab") -5. Choose the `Application` Codebase type as we intend to deliver our application as a container and deploy it within the Kubernetes cluster. Click the **Next** button: +5. Select the **Custom configuration** option, choose the `Application` Codebase type as we intend to deliver our application as a container and deploy it within the Kubernetes cluster. Select the **Create** strategy to scaffold our application from the template provided by the KubeRocketCI and click **Continue**: - ![Codebase Type](../assets/use-cases/general/component-type.png "Step codebase type") + ![Initial setup](../assets/use-cases/general/component-type-1.png "Initial setup") -6. Opt for the **Create from template** strategy to scaffold our application from the template provided by the KubeRocketCI and click **Create**: +6. On the **Git & project info** tab, define the following values and click **Continue**: - ![Codebase Strategy](../assets/use-cases/general/component-strategy.png "Step codebase strategy") + - Git server: `github` + - Owner: `github_account_name` + - Repository name: `fastapi-demo` + - Default branch: `main` + - Project name: `fastapi-demo` + - Description: `FastAPI application for demo purposes` -7. On the **Add component info** tab, define the following values and click **Next**: + ![Application info](../assets/use-cases/fastapi-scaffolding/create-application.png "Application info") - - Git server: `github` - - Repository name: `{github_account_name}/fastapi-demo` - - Component name: `fastapi-demo` - - Description: `fastapi-demo` - - Application code language: `Python` +7. On the **Build config** tab, define the values and click **Continue**: + + - Code language: `Python` - Language version/framework: `FastAPI` - Build tool: `Python` + - Deployment options: `helm-chart` + - Codebase versioning type: `semver` + - Start version from: `0.1.0` + - Suffix: `SNAPSHOT` - ![Application Info](../assets/use-cases/fastapi-scaffolding/create-application.png "Application info") + ![Build config](../assets/use-cases/fastapi-scaffolding/create-application-advance.png "Build config") -8. On the **Specify advanced settings** tab, define the values and click **Create**: +8. On the **Review** tab, verify the project configuration and click **Create project**: - - Default branch: `main` - - Deployment Options: `helm-chart` - - Codebase versioning type: `edp` - - Start version from: `0.1.0` and `SNAPSHOT` - - ![Advanced Settings](../assets/use-cases/fastapi-scaffolding/create-application-advance.png "Advanced settings") + ![Review and create](../assets/use-cases/fastapi-scaffolding/review-and-create.png "Review and create") -9. Check the application status. It should be green: +9. On the congratulations menu, click **Open project**: ![Components overview page](../assets/use-cases/fastapi-scaffolding/ready-component.png "Application status") @@ -110,95 +112,130 @@ This section outlines the approach for deploying the application from the latest To succeed with the steps above, follow the instructions below: -1. Build Container from the latest branch commit. To build the initial version of the application's `main` branch, go to the **Components** -> **fastapi-demo** -> **Branches** -> **main** and click the **Build** button: +1. Build Container from the latest branch commit. To build the initial version of the application's `main` branch, go to the **Branches** -> **main** and click the **Build** button: ![Build Main Branch](../assets/use-cases/fastapi-scaffolding/build-application.png "Application building") -2. Build pipeline for the `fastapi-demo` application starts: +2. Build pipeline for the `fastapi-demo` application starts. Track Pipeline's status by clicking the **build-fastapi-demo-main-xxxx** pipeline link or **Go to page**: ![Branch Build Pipeline](../assets/use-cases/fastapi-scaffolding/build-in-process.png "Pipeline building") -3. Track Pipeline's status by clicking the **build-fastapi-demo-main-6ef1** pipeline link. +3. Observe the build pipeline details: - ![Pipeline details](../assets/use-cases/fastapi-scaffolding/build_details.png "Pipeline details") + ![Pipeline details](../assets/use-cases/fastapi-scaffolding/build-details.png "Pipeline details") -4. Ensure that Build Pipeline was successfully completed. +4. Ensure that build pipeline was successfully completed. -5. To enable application deployment create a Deployment Flow with a single environment - Development (with the name `dev`). +5. To enable application deployment, create a Deployment with a single environment - Development (with the name `dev`). :::note To utilize and manage various environments through the KubeRocketCI platform, the initial step is to onboard a new GitOps repository. ::: -6. Navigate to the **Deployment Flows** tab and click the corresponding button to create new GitOps repository: +6. Navigate to the **Deployments** tab and click the corresponding button to create new GitOps repository: - ![Deployment flow tab](../assets/use-cases/fastapi-scaffolding/add_gitops_repo.png "Deployment flow tab") + ![Deployment flow tab](../assets/use-cases/fastapi-scaffolding/add-gitops-repo.png "Deployment flow tab") 7. Click to the **+ Add GitOps repository**: - ![Onboard gitops repository](../assets/use-cases/fastapi-scaffolding/add_gitops_button.png "Onboard GitOps repository") + ![Onboard gitops repository](../assets/use-cases/fastapi-scaffolding/add-gitops-button.png "Onboard GitOps repository") 8. Select the `Create` strategy and `github` server, enter GitHub account name and click **Save**: - ![Configure gitops repository](../assets/use-cases/fastapi-scaffolding/create_gitops.png "Configure gitops repository") + ![Configure gitops repository](../assets/use-cases/fastapi-scaffolding/create-gitops.png "Configure gitops repository") -9. In the KubeRocketCI portal, navigate to **Deployment FLows** tab and click the **+ Create deployment flow** button to create pipeline: +9. In the KubeRocketCI portal, navigate to **Deployments** tab and click the **+ Create deployment** button: - ![Create deployment flow](../assets/use-cases/general/create-cd-pipeline.png "Create deployment flow") + ![Create deployment](../assets/use-cases/general/create-cd-pipeline-1.png "Create deployment") -10. In the **Create deployment flow** dialog, fill in the required fields: +10. In the **Create new deployment** dialog, fill in the required fields: - - **Enter name**: + - **Applications**: - - Pipeline name: `mypipe` - - Description: `Deployment flow for fasapi application` + - Applications: Add `fastapi-demo` application + - Branch: Select `main` branch - ![Deployment flow tab with parameters](../assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window.png "Deployment flow tab with parameters") + ![Applications step](../assets/use-cases/fastapi-scaffolding/create-deployment-applications.png "Applications step") - **Add applications**: - - Applications: Add `fastapi-demo` application - - Branch: Select `main` branch + - Pipeline name: `mypipe` + - Description: `Deployment for FastAPI application` + - Deployment type: Select `Container` - Promote applications: Leave unchecked - ![Deployment flow tab with parameters](../assets/use-cases/fastapi-scaffolding/create-cd-pipeline-window-2.png "Deployment flow tab with parameters") + ![Pipeline configuration step](../assets/use-cases/fastapi-scaffolding/create-deployment-pipeline-configuration.png "Pipeline configuration step") + + - **Review**: + + Verify the Deployment configuration and click **Create deployment**: + + ![Review step](../assets/use-cases/fastapi-scaffolding/create-deployment-review.png "Review step") + -11. Now click the `Go to deployment flow` button to continue creating the environment: +11. Now click the `Open deployment` button to continue creating the environment: - ![Deployment flow created](../assets/use-cases/fastapi-scaffolding/flow-created.png "Deployment flow created") + ![Deployment created](../assets/use-cases/fastapi-scaffolding/deployment-created.png "Deployment created") -12. In the Deployment Flow details page, click the **+ Create environment** button to create new environment and fill in the required fields: +12. In the Deployment details page, click the **+ Create environment** button to create new environment and fill in the required fields: ![Create environment](../assets/use-cases/fastapi-scaffolding/add-environment.png "Create environment") + - **Basic configuration**: + - Cluster: `in-cluster` - Environment name: `dev` + - Deploy namespace: `krci-mypipe-dev` - Description: `Development Environment` + + ![Basic configuration step](../assets/use-cases/fastapi-scaffolding/create-environment-basic-configuration.png "Basic configuration step") + + - Trigger type: `Manual` - Deploy Pipeline template: `deploy` - Clean Pipeline template: `clean` - - Quality gate type: `Manual` - ![Environment tab with parameters](../assets/use-cases/fastapi-scaffolding/create-stage.png "Environment tab with parameters") + ![Pipeline configuration step](../assets/use-cases/fastapi-scaffolding/create-environment-pipeline-configuration.png "Pipeline configuration step") + + - **Quality Gates**: + + Leave everything as is: + + ![Quality gates step](../assets/use-cases/fastapi-scaffolding/create-environment-quality-gates.png "Quality gates step") + + - **Review**: - As soon as the values is defined, click the **Create** button. + Review the specified values and click the **Create environment** button: -13. Deploy the initial version of the application to the development environment: + ![Review step](../assets/use-cases/fastapi-scaffolding/create-environment-review.png "Review step") - - Open deployment flow with the name `mypipe`. - - Select the `dev` environment from the **Environment** tab. +13. As soon as the Environment is created, click **Open environment**: + + ![Open environment](../assets/use-cases/fastapi-scaffolding/open-environment.png "Open environment") + +14. Deploy the initial version of the application to the development environment: + + - Select **Applications** tab. - Click the **Configure deploy** button. - In the **Select image tag** field select version `0.1.0-SNAPSHOT.1` and click the **Start deploy** button. ![CD Pipeline Deploy initial version](../assets/use-cases/fastapi-scaffolding/start-deploy.png "CD Pipeline deploy") +15. Navigate to the **Pipelines** tab and click the pipeline name to view its details: + + ![Deploy pipeline (clickable)](../assets/use-cases/fastapi-scaffolding/deploy-pipeline-clickable.png "Deploy pipeline (clickable)") + +16. View the Pipeline details until it finishes: + + ![Deploy pipeline details](../assets/use-cases/fastapi-scaffolding/deploy-pipeline-details.png "Deploy pipeline details") + ### Check the Application Status To ensure the application is deployed successfully, follow the steps below: 1. Ensure application status is `Healthy` and `Synced`, and the `Deployed version` points to `0.1.0-SNAPSHOT.1`: - ![CD Pipeline health status](../assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png "Pipeline health status") + ![Deployment health status](../assets/use-cases/fastapi-scaffolding/deploy-is-healthy.png "Deployment health status") 2. Check that the selected version of the container is deployed on the `dev` environment. `${KRCI_ENV}` - is the KRCI namespace name: @@ -235,7 +272,7 @@ Within the [GitOps](../user-guide/gitops.md) repository, follow the naming conve To ensure our application recognizes the changes in the GitOps repository related to enabling the creation of the `Ingress` resource, we need to set the **Override values** checkbox to `true` before deploying. - - Go to the **Environments** section of the KubeRocketCI portal, select `mypipe` and choose **dev** stage. + - Go to the **Deployments** section of the KubeRocketCI portal, select `mypipe` and choose the **dev** Environment. - In the **Select image tag** section select the version `0.1.0-SNAPSHOT.1`. - Set the **Values override** checkbox to `true` and click the **Start deploy** button. - Check that the application is deployed and application status is `Healthy` and `Synced`.