Skip to content

Commit abb177e

Browse files
committed
docs: add overall workflow
1 parent dbf3d81 commit abb177e

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

content/docs/tutorials/just-in-time-part2.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,21 @@ This tutorial skips the Bytebase setup part, if you haven't set up the Bytebase
3737

3838
Before you begin, make sure you have:
3939

40-
- Docker installed
40+
- [Docker](https://www.docker.com/) installed
4141
- Slack workspace
4242
- VS Code for port forwarding
4343

44+
## Overall Workflow
45+
46+
1. Create a Slack app. The Slack app listens on the webhook notification when someone submits a database access request.
47+
1. Upon receiving the webhook event, the Slack app will present a message card in the configured channel with request details and approve/deny buttons.
48+
1. Upon clicking the approve/deny button, the Slack app will call the corresponding Bytebase API to approve/deny the request.
49+
4450
## Step 1 - Finished the previous tutorial
4551

4652
Make sure you finished the [previous tutorial](/docs/tutorials/just-in-time-part1) and have the Bytebase instance running. Particularly, pay attention to **Step 4**, which is to request JIT access via Bytebase GUI.
4753

48-
The `Request role` feature is supported by **Enterprise Plan** which will be needed for this tutorial, other plans only allow the `Assign role` feature which is not enough. You may request a trial from [here](https://www.bytebase.com/contact-us/).
54+
The `Request role` feature is supported by **Enterprise Plan** which will be needed for this tutorial, other plans only allow the `Assign role` feature which is not enough. You may request a trial from [here](https://www.bytebase.com/contact-us/).
4955

5056
## Step 2 - Register a service account in Bytebase
5157

@@ -61,7 +67,7 @@ The `Request role` feature is supported by **Enterprise Plan** which will be ne
6167
1. By using VS Code's [Port forwarding](https://code.visualstudio.com/docs/editor/port-forwarding), you can forward the local server's ports:
6268
- `3000` for the `slack-example` app
6369
- `8080` for the Bytebase instance
64-
![vscode-ports](/content/docs/tutorials/just-in-time-part2/vscode-ports.webp)
70+
![vscode-ports](/content/docs/tutorials/just-in-time-part2/vscode-ports.webp)
6571
1. Copy the 8080 port forwarded address to the `.env.local` file as `BB_HOST`.
6672
1. Also, go to Bytebase, click **Settings > General** to set the address as **External URL**.
6773

@@ -116,4 +122,4 @@ If digging into the code is your interest, here is a brief explanation of the co
116122

117123
## Conclusion
118124

119-
In this tutorial, you learned how to set up JIT access via Slack with the help of Bytebase webhooks and APIs. In the next part, we will cover how to request JIT access via Slack.
125+
In this tutorial, you learned how to set up JIT access via Slack with the help of Bytebase webhooks and APIs. In the next part, we will cover how to request JIT access via Slack.

0 commit comments

Comments
 (0)