Skip to content

Commit d7d6dcc

Browse files
docs: update aws aurora jit (#498)
* update * update
1 parent 3c3b67c commit d7d6dcc

File tree

5 files changed

+20
-5
lines changed

5 files changed

+20
-5
lines changed

content/docs/tutorials/just-in-time-database-access-amazon-aurora.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,26 @@ Bytebase is an open-source database DevSecOps solution that complements AWS IAM
4545

4646
## Solution Overview
4747

48-
The diagram below shows how Bytebase integrates with IAM Auth to enable Just-in-Time (JIT) end-user access to Amazon Aurora.
48+
The following architecture shows how Bytebase enables Just-in-Time (JIT) database access for Amazon Aurora:
4949

50-
![aws-bb](/content/docs/tutorials/just-in-time-database-access-amazon-aurora/aws-bb.webp)
50+
![aurora-jit-ep](/content/docs/tutorials/just-in-time-database-access-amazon-aurora/aurora-jit-ep.webp)
51+
52+
### Architecture Components
5153

5254
- Bytebase itself can run under an IAM role that can connect to Aurora/RDS using the shared IAM-based user.
5355

5456
- **Developers authenticate to Bytebase** with their corporate IdP (via SSO). Developers don’t need to see or store any DB credentials. Each developer’s actions are tracked individually in Bytebase.
5557

5658
In this model, you don’t have discrete DB users or discrete IAM policies per developer. Bytebase is the gatekeeper, and the real DB connection still use the shared IAM-based user.
5759

58-
Below is a brief walkthrough of the setup:
60+
### JIT Database Access Workflow
5961

60-
1. Install Bytebase using Docker on an EC2 instance.
61-
1. Configure Bytebase to connect to your Amazon Aurora MySQL database (Bytebase also supports other RDS engines).
62+
1. All users can authenticate to Bytebase with their corporate IdP (via SSO).
63+
1. DBAs configure Bytebase to connect to your Amazon Aurora MySQL database (Bytebase also supports other RDS engines).
6264
1. Developer requests Just-in-Time (JIT) table-level access with an expiration time directly through Bytebase.
65+
1. DBAs review the request and approve it.
66+
1. Developer can query data via Bytebase SQL Editor.
67+
1. The developer's actions are tracked in Bytebase audit log.
6368

6469
## Prerequisites
6570

@@ -153,6 +158,8 @@ While creating Aurora MySQL instance, you need to enable AWS IAM authentication.
153158

154159
### Admin assigns developer access to the database (Community and Pro Plan)
155160

161+
![aurora-jit-cp](/content/docs/tutorials/just-in-time-database-access-amazon-aurora/aurora-jit-cp.webp)
162+
156163
In Bytebase **Community** and **Pro Plan**, the Admin/DBA can assign developer access to the database.
157164

158165
1. Login as the `admin` user, go into `Aurora MySQL Project`, click **Manage > Members** on the left sidebar.
@@ -167,6 +174,8 @@ In Bytebase **Community** and **Pro Plan**, the Admin/DBA can assign developer a
167174

168175
### Developer requests JIT access to the database (Enterprise Plan)
169176

177+
![aurora-jit-ep](/content/docs/tutorials/just-in-time-database-access-amazon-aurora/aurora-jit-ep.webp)
178+
170179
In Bytebase **Enterprise Plan**, you can request a JIT access to the production database.
171180

172181
1. Login as `admin` user, go into `Aurora MySQL Project` and revoke the `dev` user's access to the production database.
@@ -177,6 +186,10 @@ In Bytebase **Enterprise Plan**, you can request a JIT access to the production
177186

178187
![bb-assign-license](/content/docs/tutorials/just-in-time-database-access-amazon-aurora/bb-assign-license.webp)
179188

189+
To elaborate on custom approval, take a look at the following diagram. By defining a custom approval flow along with risk policy, Bytebase will automatically trigger the approval flow when the corresponding risk level is met. In our case, we define a high risk policy for `Request Querier Role` which triggers when the environment is `Prod`.
190+
191+
![request-query](/content/docs/tutorials/just-in-time-database-access-amazon-aurora/request-query.webp)
192+
180193
1. Scroll down to **Request Querier Role** section, add `high` risk an approval flow `Project Owner`.
181194

182195
![bb-custom-approval](/content/docs/tutorials/just-in-time-database-access-amazon-aurora/bb-custom-approval.webp)
@@ -207,6 +220,8 @@ In Bytebase **Enterprise Plan**, you can request a JIT access to the production
207220

208221
1. After the `dev` user get the access, he can solve the incident. The admin user can revoke the access directly from the **Manage** > **Members** page or wait for the access expiration.
209222

223+
1. `admin` user can also check the audit log by clicking **IAM&Admin** > **Audit Log** on the left sidebar. The audit log will show all the data access history of the `dev` user.
224+
210225
## Conclusion
211226

212227
In this walkthrough, we explored both the benefits and limitations of using AWS IAM authentication, and demonstrated how Bytebase can complement AWS IAM Auth.
30.2 KB
Loading
32.8 KB
Loading
Binary file not shown.
148 KB
Loading

0 commit comments

Comments
 (0)