Dev 338/integrated cd #3020
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,62 @@ | ||||||||||||||||||||
| # CI/CD Information | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Architecture Overview | ||||||||||||||||||||
|
|
||||||||||||||||||||
|  | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The CI/CD pipeline consists of three main stages: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - Dev Environment | ||||||||||||||||||||
| - SB Environments | ||||||||||||||||||||
| - Prod Environments | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## List of Workflows | ||||||||||||||||||||
| | Scenarios | Actions | | ||||||||||||||||||||
| |-----------|---------| | ||||||||||||||||||||
| | **Deploy to Dev Environment** | [Build and Deploy to Dev](https://github.com/ballerine-io/ballerine/actions/workflows/) | | ||||||||||||||||||||
| | **Promote to SB** | [Promote Action](https://github.com/ballerine-io/ballerine/actions/workflows/deploy-wf-service.yml) | | ||||||||||||||||||||
| | **Promote to Prod** | [Promote Action](https://github.com/ballerine-io/ballerine/actions/workflows/deploy-wf-service.yml) | | ||||||||||||||||||||
| | **Run Migrations** | [Run Migrations Action](https://github.com/ballerine-io/wf-data-migration/actions/workflows/CD-v2.yml) | | ||||||||||||||||||||
| | **Perform Hotfix** | [Hotfix Action](https://github.com/ballerine-io/ballerine/actions/workflows/hotfix-wf-service.yml) | | ||||||||||||||||||||
| | **Create Preview Environment** | [Preview Environment](https://github.com/ballerine-io/ballerine/actions/workflows/build-preview-environment.yml) | | ||||||||||||||||||||
| | **Deploy Backoffice** | [Backoffice action](https://github.com/ballerine-io/ballerine/actions/workflows/deploy-backoffice.yml) | | ||||||||||||||||||||
| | **Deploy KYB** | [KYB action](https://github.com/ballerine-io/ballerine/blob/dev/.github/workflows/deploy-kyb.yml) | | ||||||||||||||||||||
| | **Deploy Dashboard** | [Dashboard action](https://github.com/ballerine-io/ballerine/blob/dev/.github/workflows/) | | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Workflow Scenarios | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 1. **Deploy to Dev Environment**: [Build and Deploy to Dev](https://github.com/ballerine-io/ballerine/actions/workflows/push-workflows-service-image.yml) | ||||||||||||||||||||
| - Push code to dev branch | ||||||||||||||||||||
| OR | ||||||||||||||||||||
| Manually trigger workflow_dispatch with `dev` branch | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 2. **Promote to SB**: [Promote Action](https://github.com/ballerine-io/ballerine/actions/workflows/deploy-wf-service.yml) | ||||||||||||||||||||
| - Pass the environment input value as `SB`. | ||||||||||||||||||||
| - this will deploy the latest present version in `dev` to `SB`. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 3. **Promote to Prod**: [Promote Action](https://github.com/ballerine-io/ballerine/actions/workflows/deploy-wf-service.yml) | ||||||||||||||||||||
| - Pass the environment input value as `prod`. | ||||||||||||||||||||
| - this will deploy the latest present version in `sb` to `prod`. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 4. **Run Migrations** from a specific branch in `wf-data-migration` repo in a specific environment: [Run Migrations Action](https://github.com/ballerine-io/wf-data-migration/actions/workflows/CD-v2.yml) | ||||||||||||||||||||
| - Pass the branch from which you want to run the migration code and the environment name on which you want to run the action. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 5. **Perform Hotfix** on any environment: [Hotfix Action](https://github.com/ballerine-io/ballerine/actions/workflows/hotfix-wf-service.yml) | ||||||||||||||||||||
| - Pass the branch and the environment on which you want to perform the hotfix and run the workflow. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 6. **Create Preview Environment** from specific branch: [Preview Environment](https://github.com/ballerine-io/ballerine/actions/workflows/build-preview-environment.yml) | ||||||||||||||||||||
| - Add a label `deploy-pr` in your Pull request. (runs the workflow automatically) | ||||||||||||||||||||
| - Run the workflow manually with the provided branch name and the preview environment build and deployment will start. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| 7. **Deploy Front-end Apps**: | ||||||||||||||||||||
| - Deploy **Backoffice** Manually: [Backoffice action](https://github.com/ballerine-io/ballerine/actions/workflows/deploy-backoffice.yml) | ||||||||||||||||||||
| - Deploy **KYB** Manually: [KYB action](https://github.com/ballerine-io/ballerine/blob/dev/.github/workflows/deploy-kyb.yml) | ||||||||||||||||||||
| - Deploy **Dashboard** Manually: [Dashboard action](https://github.com/ballerine-io/ballerine/blob/dev/.github/workflows/deploy-dashboard.yml) | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - Note: Provide the environment name on which you want to trigger the deployment. | ||||||||||||||||||||
|
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Prerequisites | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - Github Actions access | ||||||||||||||||||||
| - Repository permissions | ||||||||||||||||||||
|
Comment on lines
+61
to
+62
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance prerequisites with specific requirements. The current prerequisites are too vague. Consider adding more details: - Github Actions access
- Repository permissions
+ GitHub Actions access:
+ - Workflow read/write permissions
+ - Environment deployment permissions
+ Repository permissions:
+ - Write access to deployment branches
+ - Access to environment secrets
+ - ArgoCD access tokens (if required)📝 Committable suggestion
Suggested change
|
||||||||||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix incomplete workflow URLs.
The following workflow links are incomplete:
Please update with the correct workflow filenames.
Also applies to: 24-24