Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: manual image approval #3649

Merged
merged 5 commits into from
Aug 18, 2023
Merged

doc: manual image approval #3649

merged 5 commits into from
Aug 18, 2023

Conversation

Shubham9t9
Copy link
Contributor

Description

ashokdevtron
ashokdevtron reviewed Aug 7, 2023
View reviewed changes
docs/user-guide/creating-application/workflow/cd-pipeline.md Outdated
### 4. Deployment stage
### 4. Manual approval for deployment

When `manual approval for deployment` is enabled, only approved images are available for deployment through the respective deployment pipeline.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change manual approval for deployment to Manual approval for deployment

ashokdevtron
ashokdevtron reviewed Aug 7, 2023
View reviewed changes
docs/user-guide/creating-application/workflow/cd-pipeline.md Outdated
@@ -84,7 +84,20 @@ Make sure your cluster has `devtron-agent` installed if you check the `Execute i

![](../../../.gitbook/assets/cd_pre_build%20%282%29.jpg)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we put this in s3 instead of our repo?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seems resolved. @ashokdevtron

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now it's done, @prakarsh-dt

ashokdevtron
ashokdevtron reviewed Aug 7, 2023
View reviewed changes
docs/user-guide/creating-application/workflow/cd-pipeline.md Outdated
### 4. Manual approval for deployment

When `manual approval for deployment` is enabled, only approved images are available for deployment through the respective deployment pipeline.
Users can specify the number of approvals required for each deployment, with a minimum of 1 and a maximum of 6.
Copy link
Contributor

@ashokdevtron ashokdevtron Aug 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this to:
Users can specify the number of approvals required for each deployment, where the permissible limit ranges from 1 approval (minimum) to 6 approval (maximum).

ashokdevtron
ashokdevtron requested changes Aug 7, 2023
View reviewed changes
docs/user-guide/creating-application/workflow/cd-pipeline.md Outdated

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/deployment-approval.jpg)

To enable Manual Approval for Deployment, follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To enable manual approval for deployment, follow these steps:

docs/user-guide/creating-application/workflow/cd-pipeline.md Outdated

To enable Manual Approval for Deployment, follow these steps:

1. Click on the deployment pipeline for which you want to enable manual approval for deployment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click the deployment pipeline for which you want to enable manual approval.

docs/user-guide/creating-application/workflow/cd-pipeline.md Outdated
To enable Manual Approval for Deployment, follow these steps:

1. Click on the deployment pipeline for which you want to enable manual approval for deployment.
2. Toggle the ‘Manual approval for deployment’ switch to ‘On’.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turn on the ‘Manual approval for deployment’ toggle button.

docs/user-guide/creating-application/workflow/cd-pipeline.md Outdated
@@ -106,7 +119,7 @@ Devtron's tool has 4 types of deployment strategies. Click on `Add Deployment st

\(d\) Rolling

### 5. Post-deployment Stage
### 6. Post-deployment Stage

If you want to Configure actions like Jira ticket close, that you want to run after the deployment, you can configure such actions in the post-deployment stages.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to run actions like closure of Jira ticket after the deployment, you can configure such actions in the post-deployment stages.

docs/user-guide/deploying-application/triggering-cd.md Outdated

When manual approval is enabled for the deployment pipeline, you are required to request image approval before each deployment. Alternatively, you can only deploy images that have already been approved once.

When no approved image is available or the deployed image is already deployed, you will not see any image available to be deployed when you click on the `Select Image` button.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When no approved image is available or if the image is already deployed, you will not see any image available for deployment upon clicking the Select Image button.

docs/user-guide/global-configurations/user-access.md Outdated
@@ -18,6 +18,7 @@ Devtron supports 5 levels of access:
3. **Admin**: User with `admin` access can create, edit, delete and view permitted applications in permitted projects.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Admin: User with admin privileges can create, edit, delete, and view permitted applications in permitted projects.

docs/user-guide/global-configurations/user-access.md Outdated
@@ -18,6 +18,7 @@ Devtron supports 5 levels of access:
3. **Admin**: User with `admin` access can create, edit, delete and view permitted applications in permitted projects.
4. **Manager**: User with `manager` access can do everything that an `admin` type user can do, in addition they can also give and revoke access of users for the applications and environments of which they are `manager`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users with manager privileges can do everything that an admin user can do. Additionally they can also give and revoke access of users for the applications and environments of which they are the manager.

docs/user-guide/global-configurations/user-access.md Outdated
@@ -18,6 +18,7 @@ Devtron supports 5 levels of access:
3. **Admin**: User with `admin` access can create, edit, delete and view permitted applications in permitted projects.
4. **Manager**: User with `manager` access can do everything that an `admin` type user can do, in addition they can also give and revoke access of users for the applications and environments of which they are `manager`.
5. **Super Admin**: User with `super admin` privilege has unrestricted access to all Devtron resources. Super admin can create, modify, delete and view any Devtron resource without any restriction; its like Superman without the weakness of Kryptonite. Super Admin can also add and delete user access across any Devtron resource, add delete git repository credentials, container registry credentials, cluster and environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super Admin: Users with super admin privileges have unrestricted access to all the Devtron resources. Super Admins can create, modify, delete and view any Devtron resource without any restriction; it's like Superman without the weakness of Kryptonite. Moreover, they can add and delete user access across any Devtron resource, add delete git repository credentials, container registry credentials, cluster, and environment.

docs/user-guide/global-configurations/user-access.md Outdated
@@ -18,6 +18,7 @@ Devtron supports 5 levels of access:
3. **Admin**: User with `admin` access can create, edit, delete and view permitted applications in permitted projects.
4. **Manager**: User with `manager` access can do everything that an `admin` type user can do, in addition they can also give and revoke access of users for the applications and environments of which they are `manager`.
5. **Super Admin**: User with `super admin` privilege has unrestricted access to all Devtron resources. Super admin can create, modify, delete and view any Devtron resource without any restriction; its like Superman without the weakness of Kryptonite. Super Admin can also add and delete user access across any Devtron resource, add delete git repository credentials, container registry credentials, cluster and environment.
6. **Approver**: Users with Approver access have the authority to approve requests for image deployment. However, the user who built the image and/or requested approval cannot self-approve, even if they have Approver or super-admin privileges.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approver: Users with approver privileges have the authority to approve requests for image deployment. However, the user who built the image and/or requested approval cannot self-approve, even if they have approver or super-admin privileges.

docs/user-guide/deploying-application/triggering-cd.md Outdated

2. Switch to the `Approval Pending` tab. Here, you will find all the images that are awaiting approval.

3. Click on the `Approve` button and the click on `Approve Request` to grant the approval for the request.
Copy link
Contributor

@ashokdevtron ashokdevtron Aug 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click the Approve button, and then Approve Request to grant approval to the request.

@prakarsh-dt prakarsh-dt changed the title docs: manual image approval doc: manual image approval Aug 17, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@prakarsh-dt prakarsh-dt merged commit d17aa9a into devtron-labs:main Aug 18, 2023
Ash-exp pushed a commit that referenced this pull request Aug 21, 2023
@Shubham9t9 @ashokdevtron @Ash-exp
doc: manual image approval (#3649)
cba9cd1 
* image manual approval doc

* Proofread cd-pipeline.md

* Proofread triggering-cd.md

* Proofread user-access.md

* doc-images moved to s3 + fixes

---------

Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>
iamayushm added a commit that referenced this pull request Sep 4, 2023
@Ash-exp @iamayushm
@kartik-579 @gireesh-naidu @kamal-devtron @prakarsh-dt @systemsdt @pawan-mehta-dt @prakash100198 @kripanshdevtron @Ashish-devtron @Shubham9t9 @ashokdevtron
feat: Virtual cluster v3 (#3764)
edbf624 
* fix: updated ValidateRegistryStorageType for OCI registry configs

* feat: added pull support for registry

* feat: fetch the updated struct for registry

* fix: fetch registry list

* fix: fetch registry list

* updated: migration script

* updated: migration comments

* added APIs: chart provider list, update enable/disable

* feat: chart sync support with oci registry

* AppStore repository structure

* feat: updated FindWithFilter api for chart store

* feat: updated FindChartDetailsById api for chart store

* feat: query error on updateFindWithFilterQuery

* feat: Service extraction for EA mode

* fix: FindWithFilter query

* fix: fetching registry OCI config nil

* fix: registry validation added

* feat: chart sync on registry update and toggle chart repo feature

* fix: FindWithFilter query for chart store list

* fixed: join query for FindWithFilter

* fixed: registry validation

* feat: modified helm apps query

* feat: helm apps list query

* oci chart installation changes and api fixes

* fixing sql queries

* update code

* fixing query

* chart group api installation

* chart group list api

* app group installation detail api

* bulk chart group fix

* adding app store active flag

* feat: registry support for virtual cluster v3 (#3702)

* feat: added pull support for registry

* feat: fetch the updated struct for registry

* fix: fetch registry list

* updated: migration script

* updated: migration comments

* fix: fetching registry OCI config nil

* feat: chart provider APIs and registry validation (#3703)

* fix: updated ValidateRegistryStorageType for OCI registry configs

* feat: added pull support for registry

* feat: fetch the updated struct for registry

* fix: fetch registry list

* fix: fetch registry list

* updated: migration script

* updated: migration comments

* added APIs: chart provider list, update enable/disable

* feat: chart sync support with oci registry

* AppStore repository structure

* feat: updated FindWithFilter api for chart store

* feat: updated FindChartDetailsById api for chart store

* feat: query error on updateFindWithFilterQuery

* feat: Service extraction for EA mode

* fix: FindWithFilter query

* fix: fetching registry OCI config nil

* fix: registry validation added

* feat: chart sync on registry update and toggle chart repo feature

* fix: FindWithFilter query for chart store list

* fixed: join query for FindWithFilter

* fixed: registry validation

* feat: modified helm apps query

* feat: helm apps list query

* feat: wire integration, registry delete validation (#3720)

* fix: updated ValidateRegistryStorageType for OCI registry configs

* feat: added pull support for registry

* feat: fetch the updated struct for registry

* fix: fetch registry list

* fix: fetch registry list

* updated: migration script

* updated: migration comments

* added APIs: chart provider list, update enable/disable

* feat: chart sync support with oci registry

* AppStore repository structure

* feat: updated FindWithFilter api for chart store

* feat: updated FindChartDetailsById api for chart store

* feat: query error on updateFindWithFilterQuery

* feat: Service extraction for EA mode

* fix: FindWithFilter query

* fix: fetching registry OCI config nil

* fix: registry validation added

* feat: chart sync on registry update and toggle chart repo feature

* fix: FindWithFilter query for chart store list

* fixed: join query for FindWithFilter

* fixed: registry validation

* feat: modified helm apps query

* feat: helm apps list query

* feat: integrated docker registry to EA mod

* feat: delete validation for registry

* fix: updated is_pull_active and deleted condition to the query

* fix: interface injection for chart providers

* updated: app store list issues

* fix: chart provider list query fixed

* feat: public registry url handling

* feat: added validation registry API

* feat: added IsOCICompliantChart flag to chart details API

* feat: added IsOCICompliantChart flag to chart details API

* feat: registry disabled action list added

* feat: disabled registry action list added

* feat: Refactored docker registry IP config and added integration test cases (#3728)

* fix: updated ValidateRegistryStorageType for OCI registry configs

* feat: added pull support for registry

* feat: fetch the updated struct for registry

* fix: fetch registry list

* fix: fetch registry list

* updated: migration script

* updated: migration comments

* added APIs: chart provider list, update enable/disable

* feat: chart sync support with oci registry

* AppStore repository structure

* feat: updated FindWithFilter api for chart store

* feat: updated FindChartDetailsById api for chart store

* feat: query error on updateFindWithFilterQuery

* feat: Service extraction for EA mode

* fix: FindWithFilter query

* fix: fetching registry OCI config nil

* fix: registry validation added

* feat: chart sync on registry update and toggle chart repo feature

* fix: FindWithFilter query for chart store list

* fixed: join query for FindWithFilter

* fixed: registry validation

* feat: modified helm apps query

* feat: helm apps list query

* feat: integrated docker registry to EA mod

* feat: delete validation for registry

* fix: updated is_pull_active and deleted condition to the query

* fix: interface injection for chart providers

* updated: app store list issues

* fix: chart provider list query fixed

* feat: public registry url handling

* feat: added validation registry API

* feat: added IsOCICompliantChart flag to chart details API

* feat: added IsOCICompliantChart flag to chart details API

* feat: registry disabled action list added

* feat: disabled registry action list added

* feat: registry ip config updated

* feat: updated integration test cases

* feat: updated registry update test cases

* feat: fixed Ip Config Query and integration test cases

* feat: fixed IpConfig Join query

* feat: added validation and removed app_store.active condition

* updated: RegistryBean request obj, FindDeploymentCount query

* feat: chart provider service test cases updated

* feat: added registry update validation

* feat: updated chart sync order

* feat: validation api update

* migration script fix

* updated migration

* fixed: ip config update

* feat: removed super admin RBAC for chart provider list

* feat: removed GCR and GAR validation

* fix: FindWithFilter query

* fix: FindWithFilter query with delete condition

* fix: FindWithFilter query with delete condition

* fix: LinkHelmApplicationToChartStore nil pointer handled

* fix: ipconfig inject skipped for virtual env

* feat: removed validation for other type registry

* wip: modifying search api

* panic fix: hibernation

* updated unlock condition (#3770)

* remove use-buildx flag to use k8s buildx driver (#3773)

* fix: resource tree panic fix (#3775)

* resource tree panic fix

* panic fix

* chore: Addition of K9s image in cluster terminal (#3779)

* k9s image added

* k9s image changes

---------

Co-authored-by: Kamal Acharya <kamalacharya@Kamals-MacBook-Pro.local>

* release: PR for v0.6.20 (#3620)

* Updated release-notes files

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated latest image of ci-runner in installer

* Updated release notes

* Updated release notes

* Updated release notes

* Updated latest image of ci-runner in installer

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated latest image of ci-runner in installer

* Updated latest image of ci-runner in installer

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated latest image of hyperion in installer

* Updated latest image of lens in installer

* Updated latest image of git-sensor in installer

* Updated latest image of devtron in installer

* Updated latest image of kubelink in installer

* Updated latest image of kubewatch in installer

* Updated release notes

* Updated release notes

* Updated latest image of dashboard in installer

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated pending release-notes

* enabled file stats in gitsensor

* Updated release notes

* Updated release notes

* Updated release notes

* Updated release notes

* Updated latest image of ci-runner in installer

* Updated release notes

* Updated release notes

* Updated latest image of git-sensor in installer

* Updated latest image of kubelink in installer

* Updated latest image of dashboard in installer

* Updated latest image of kubelink in installer

* Updated release notes

* Updated latest image of kubelink in installer

* Updated latest image of devtron in installer

* Updated latest image of dashboard in installer

* Updated latest image of dashboard in installer

* Updated latest image of dashboard in installer

* Update release.txt

* Updated release notes

* Updated latest image of devtron in installer

* Updated latest image of kubewatch in installer

* Updated latest image of dashboard in installer

* Updated release notes

* Updated latest image of devtron in installer

* Updated latest image of dashboard in installer

* Updated latest image of dashboard in installer

* Updated release notes

* Updated latest image of devtron in installer

* Updated release notes

* Updated latest image of devtron in installer

* Updated latest image of kubelink in installer

* Updated latest image of dashboard in installer

* Updated latest image of dashboard in installer

* Updated release notes

* Updated release notes

* Updated latest image of devtron in installer

* Updated latest image of devtron in installer

* Updated latest image of ci-runner in installer

* Updated latest image of kubewatch in installer

* Updated release notes

* Updated latest image of devtron in installer

* Updated latest image of dashboard in installer

* Updated latest image of dashboard in installer

* Updated release notes

* Updated latest image of ci-runner in installer

* Update Chart.yaml

* Update values.yaml

* Updated latest image of devtron in installer

* Updated release notes

* Updated latest image of hyperion in installer

* Updated latest image of devtron in installer

* Updated latest image of hyperion in installer

* Updated latest image of ci-runner in installer

* Updated release notes

* Updated latest image of hyperion in installer

* Updated latest image of devtron in installer

* Updated latest image of dashboard in installer

* Updated release notes

* Updated latest image of hyperion in installer

* Updated latest image of devtron in installer

* Updated latest image of devtron in installer

* Updated latest image of hyperion in installer

* Updated latest image of devtron in installer

* Updated latest image of devtron in installer

* Updated latest image of hyperion in installer

* Updated latest image of hyperion in installer

* Updated latest image of devtron in installer

* Updated latest image of dashboard in installer

* Updated release notes

* Updated latest image of hyperion in installer

* Updated latest image of devtron in installer

* Enabled file include exclude feature

* Enabled file include exclude feature in devtron-bom

* Updated release-notes files

---------

Co-authored-by: ReleaseBot <systems@devtron.ai>
Co-authored-by: Pawan Mehta <117346502+pawan-mehta-dt@users.noreply.github.com>

* delete all pre-post cd at one time (#3786)

* perf: hibernate check optimisation (#3788)

* check for kind

* hibernation replica parallelism

* clean dead code

* refactoring

---------

Co-authored-by: Ashish-devtron <ashish.kumar@devtron.ai>

* doc: HashiCorp external secret operator (#3608)

* doc for hashicorp eso

* edited summary.md

* Proofread aws-eso.md

* Proofread hashicorp-eso.md

---------

Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>

* doc: security feature doc (#3622)

* security feature doc rewrite

* Proofread security-features.md

---------

Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>

* docs: container lifecycle  (#3623)

* container lifecycle doc

* minor corrections

* Proofread deployment.md

---------

Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>

* doc: ci-trigger documentation update (#3629)

* updated ci-trigger documentation

* Proofread triggering-ci.md

---------

Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>

* doc: mandatory tags feature (#3630)

* added doc for mandatory tags feature

* changed title from mandatory tags to tags policy

* minor correction

* Proofread SUMMARY.md

Replaced mandatory-tags.md with tags-policy.md

* Proofread tags-policy.md

---------

Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>

* doc: manual image approval (#3649)

* image manual approval doc

* Proofread cd-pipeline.md

* Proofread triggering-cd.md

* Proofread user-access.md

* doc-images moved to s3 + fixes

---------

Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>

* Added purpose of admin login (#3790)

* chore: Config approval scripts and refactoring (#3762)

* config approval scripts

* approver role resource added

* migration version updated

* overriden flag introduced

* down script commited

* cm fetch for edit

* app level fetch instead of env level

* cm bean refactoring

* clean dead code

* env props bean refactoring

* refactoring

* script version updated

* config approval down sql

* table deletion order fix

* script number update

* chore: updated migration number

* migration script updated

---------

Co-authored-by: ayushmaheshwari <ayush@devtron.ai>
Co-authored-by: kartik-579 <84493919+kartik-579@users.noreply.github.com>
Co-authored-by: Gireesh Naidu <111440205+gireesh-devtron@users.noreply.github.com>
Co-authored-by: iamayushm <32041961+iamayushm@users.noreply.github.com>
Co-authored-by: kamal-devtron <128121299+kamal-devtron@users.noreply.github.com>
Co-authored-by: Kamal Acharya <kamalacharya@Kamals-MacBook-Pro.local>
Co-authored-by: Prakarsh <71125043+prakarsh-dt@users.noreply.github.com>
Co-authored-by: ReleaseBot <systems@devtron.ai>
Co-authored-by: Pawan Mehta <117346502+pawan-mehta-dt@users.noreply.github.com>
Co-authored-by: Prakash <prakash.kumar@devtron.ai>
Co-authored-by: kripanshdevtron <107392309+kripanshdevtron@users.noreply.github.com>
Co-authored-by: Ashish-devtron <ashish.kumar@devtron.ai>
Co-authored-by: Shubham Kumar <87755583+Shubham9t9@users.noreply.github.com>
Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com>
Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ashokdevtron ashokdevtron ashokdevtron requested changes

@prakarsh-dt prakarsh-dt prakarsh-dt approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Shubham9t9 @prakarsh-dt @ashokdevtron