Skip to content

Commit b7080a4

Browse files
authored
[FAI-20020] Add prompt to confirm tenant/workspace when running Faros destination (#179)
1 parent 73d93df commit b7080a4

22 files changed

Lines changed: 2210 additions & 208 deletions

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ Assuming you want to pull data from Github org `my-org` by using GitHub PAT and
163163
"image": "farosai/airbyte-faros-destination",
164164
"config": {
165165
"edition_configs": {
166+
"tenant_id": "<YOUR_TENANT_ID>", <-- Faros tenant Id
166167
"api_key": "<YOUR_FAROS_API_KEY>", <-- Faros API key
167168
"graph": "default" <-- Faros workspace
168169
}
@@ -181,10 +182,26 @@ More resources you can find it in [Faros Documentation](https://docs.faros.ai/),
181182
### 🏁 Step 3. Run it!
182183

183184
```sh
184-
./airbyte-local --config-file 'faros_airbyte_cli_config.json'
185-
./airbyte-local -c 'faros_airbyte_cli_config.json'
185+
./airbyte-local --config-file faros_airbyte_cli_config.json
186+
./airbyte-local -c faros_airbyte_cli_config.json
186187
```
187188

189+
> **Starting from v0.2.0**, when running with a Faros destination, the CLI will prompt you to confirm before writing data:
190+
> ```
191+
> ===========================================================
192+
> ATTENTION: You are about to write data into:
193+
> Tenant: Acme
194+
> Workspace: default
195+
> ===========================================================
196+
> Would you like to proceed? (yes/No):
197+
> ```
198+
> This is a safety check to prevent accidentally writing data to the wrong tenant or workspace.
199+
>
200+
> **Running programmatically (CI/CD)?** Use the `--assume-yes` flag to suppress the prompt — but only after you have verified your config file targets the correct tenant and workspace:
201+
> ```sh
202+
> ./airbyte-local --config-file ‘faros_airbyte_cli_config.json’ --assume-yes
203+
> ```
204+
188205
You’ll see logs and sync progress in the terminal and in the **Faros App** (Data Control > Sources).
189206
190207
## ⚙️ Advanced Settings
@@ -212,6 +229,7 @@ We provide some more CLI optional arguments and optional fields in the Airbyte c
212229
| `--raw-messages` | | Output raw Airbyte messages |
213230
| `--connection-name <name>` | | Sets the origin for data in Faros (used to namespace, query, and delete data by source) and the default state file name (overridden by `--state-file`). Must be unique per source instance to prevent data overwrites or conflicts. |
214231
| `--keep-containers` | | Do not remove source and destination containers after they exit |
232+
| `--assume-yes` | | Skip confirmation prompts (e.g., tenant verification). Use only after verifying your config is correct |
215233
| `--debug` | | Enable debug logging |
216234
| `--src <image>` | | [Deprecated] Airbyte source Docker image |
217235
| `--dst <image>` | | [Deprecated] Airbyte destination Docker image |

0 commit comments

Comments
 (0)