11---
2- title : Onboarding Phases 🚠
2+ title : Best Practices 📘
33---
44
5+ ## Onboarding Phases
6+
57<HintBlock type =" info " >
68
79For Enterprise customers, ** we guarantee 100% implementation success in 90 days** . [ Contact us] ( /contact-us/ )
@@ -18,7 +20,7 @@ database operational practices gradually:
18201 . [ Integrate SQL review into CI (1 week)] ( #phase-3-integrate-sql-review-into-ci )
19211 . [ Manage schema migration (4 ~ 8 weeks)] ( #phase-4-manage-schema-migration )
2022
21- ## Phase 1 - Standardize ad-hoc change process
23+ ### Phase 1 - Standardize ad-hoc change process
2224
2325| | |
2426| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -37,7 +39,7 @@ Related features:
3739 - [ Alert when DML attempts to update more than 100 rows] ( /docs/sql-review/review-rules/#limit-affected-row-limit )
3840 - [ Specify explicit columns in INSERT] ( /docs/sql-review/review-rules/#insert-statements-must-specify-columns )
3941
40- ## Phase 2 - Centralize data query access
42+ ### Phase 2 - Centralize data query access
4143
4244| | |
4345| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -53,7 +55,7 @@ Related features:
5355- [ Request Query] ( /docs/security/database-permission/query/ ) and [ Export] ( /docs/security/database-permission/export/ ) access flow
5456- [ Dynamic Data Masking] ( /docs/security/data-masking/overview/ )
5557
56- ## Phase 3 - Integrate SQL review into CI
58+ ### Phase 3 - Integrate SQL review into CI
5759
5860| | |
5961| ------------ | -------------------------------------------------------------------------------------------- |
@@ -69,7 +71,7 @@ Related features:
6971- [ SQL Review API] ( /docs/api/sql-review/ )
7072- [ Service Account] ( /docs/api/authentication/#service-account )
7173
72- ## Phase 4 - Manage schema migration
74+ ### Phase 4 - Manage schema migration
7375
7476| | |
7577| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -95,3 +97,25 @@ Related features (in addition to Phase 1):
95971 . [ Batch Change] ( /docs/change-database/batch-change/ )
96981 . [ Changelist] ( /docs/changelist/ )
97991 . [ Online Schema Migration (MySQL only)] ( /docs/change-database/online-schema-migration-for-mysql/ )
100+
101+ ## Configuration Guideline
102+
103+ Bytebase provides settings at the workspace, environment, project levels. Below we provide a sample configuration settings for a typical scenarios:
104+
105+ - Three environments ` Dev ` , ` UAT ` , ` Prod ` .
106+ - ` Dev ` does not enforce any review and access control.
107+ - ` UAT ` enforces limited review and access control.
108+ - ` Prod ` enforces strict review and access control.
109+
110+ | | | Dev | UAT | Prod |
111+ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ----------- | --------------- | ------------------ |
112+ | [ Environment tier] ( /docs/administration/environment-policy/overview/#environment-tier ) | Environment color | Black | Yellow | Red |
113+ | | Production indicator | ❌ | ❌ | ✅ |
114+ | [ Statement execution mode] ( /docs/administration/environment-policy/overview/#statement-execution-mode ) | Allow running DDL in SQL Editor | ✅ | ❌ | ❌ |
115+ | | Allow running data-modifying DML in SQL Editor | ✅ | ❌ | ❌ |
116+ | Database CI/CD | [ Approval Policy] ( /docs/administration/custom-approval/ ) | No approver | Single approver | Multiple approvers |
117+ | | [ Rollout Policy] ( /docs/administration/environment-policy/rollout-policy/ ) | Automatic | Manual | Manual |
118+ | [ Database Permission] ( /docs/security/database-permission/overview/ ) | EXPLAIN | ✅ | ✅ | ✅ |
119+ | | Query | ✅ | ✅ | Require approval |
120+ | | Export | ✅ | ✅ | Require approval |
121+ | [ Data masking] ( /docs/security/data-masking/global-masking-rule/ ) | | ❌ | ❌ | ✅ |
0 commit comments