ドキュメントを探す
ガイド
Linux または Docker でアプリやエージェントの CLI タスクを実行し、再起動後にアクセスと結果の再利用を確認します。
このページの内容
1. 実行時間を選択してください
利用する Linux ホストと Bash とりあえず jq, 所有者 API キーと google_search 許可。 タスクを実行する OS ユーザとしてセットアップを実行します。 1–4 のステップのためのこの私的なタスク フォルダーを作成します。 ファイル ラベルは、任意のサブフォルダを表示します。
umask 077
mkdir -p "$HOME/flashdata-tasks/deployment-check"
cd "$HOME/flashdata-tasks/deployment-check"ネイティブCLIを最初にインストールします。 コマンド -v flashdata を実行して、絶対パスを見つけ、runtime.sh でそのパスに FLASHDATA_BIN を設定します。 プロファイル名と永続状態のパスをここに置き、ファイルを保存します。
# runtime.sh — edit the executable and persistent state paths.
export FLASHDATA_BIN=/usr/local/bin/flashdata
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"
run_flashdata() {
env -u FLASHDATA_API_KEY "$FLASHDATA_BIN" "$@" \
--profile "$FLASHDATA_PROFILE" \
--state-dir "$FLASHDATA_STATE_DIR"
}Linux Dockerホストでは、curl、tar、sha256sum では、ホストCPU用のピン付き CLI をダウンロードします。 image/Dockerfile と image/.dockerignore を以下に保存し、画像をビルドし、runtime.sh を保存します。 ヘルパーは、UID/GIDとして実行し、各新しいコンテナに状態とタスクフォルダをマウントします。
(
set -euo pipefail
case "$(uname -m)" in
x86_64) arch=amd64 ;;
aarch64|arm64) arch=arm64 ;;
*) echo 'Use a Linux amd64 or arm64 host.' >&2; exit 1 ;;
esac
mkdir -p image
cd image
archive="flashdata_1.2.1_linux_$arch.tar.gz"
base='https://github.com/flashdatadev/flashdata-cli/releases/download/v1.2.1'
curl --fail --show-error --location "$base/$archive" -o "$archive"
curl --fail --show-error --location "$base/SHA256SUMS" -o SHA256SUMS
awk -v file="$archive" '$2 == file { print }' SHA256SUMS | sha256sum -c -
tar -xzf "$archive" flashdata
)FROM debian:bookworm-slim
RUN apt-get update \
&& apt-get install -y --no-install-recommends ca-certificates \
&& rm -rf /var/lib/apt/lists/*
COPY --chmod=0755 flashdata /usr/local/bin/flashdata
USER 10001:10001
ENTRYPOINT ["/usr/local/bin/flashdata"]*
!Dockerfile
!flashdatadocker build --tag flashdata-runtime:1.2.1 ./image
docker run --rm flashdata-runtime:1.2.1 --version# runtime.sh — use the local image built above.
export FLASHDATA_IMAGE='flashdata-runtime:1.2.1'
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"
run_flashdata() {
docker run --rm -i --user "$(id -u):$(id -g)" \
--env FLASHDATA_API_KEY= \
--mount "type=bind,src=$FLASHDATA_STATE_DIR,dst=/state" \
--mount "type=bind,src=$PWD,dst=/work" --workdir /work \
--entrypoint /usr/local/bin/flashdata "$FLASHDATA_IMAGE" \
"$@" --profile "$FLASHDATA_PROFILE" --state-dir /state
}選択したランタイムをチェックする
タスクフォルダから実行します。 run_flashdataは、runtime.shで保存されたヘルパーです。 その後、すべてのコマンドは、そのプロファイルと状態ディレクトリを使用します。 FLASHDATA_API_KEYを無視して、保存したプロファイルを置き換えることができません。 CLI と jq のバージョンを期待します。
set -euo pipefail
umask 077
. ./runtime.sh
mkdir -p "$FLASHDATA_STATE_DIR"
chmod 700 "$FLASHDATA_STATE_DIR"
run_flashdata --version
jq --version2. オーナーのアクセスを一度インストールする
プロフィールがすでに所有者のアクセスを持っている場合は、インポートをスキップし、下のチェックを実行します。 それ以外の場合は、サービスユーザが読みやすいオーナーキーシークレットファイルをマウントし、その場所にある例のパスを置き換えます。 インポートは、stdinを介してそれを読み込みます。 Dockerは画像にコピーしません。
export FLASHDATA_KEY_FILE='/run/secrets/flashdata_api_key'set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Set the path to your mounted owner-key secret}"
run_flashdata auth login --api-key-stdin --non-interactive \
< "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactiveアカウントと権限の確認
チェックは、アカウントID、許可されたソースと認証保護、その後trueを印刷します。 IDは、継続する前に意図した所有者であることを確認します。 access.jsonは、検査のためのタスクフォルダに滞在します。
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata auth status --json --non-interactive > access.json
jq '{accountId: .data.identity.identity.accountId,
sources: .data.identity.permittedSources,
credentialProtection: .data.credentialProtection}' access.json
jq -e '.ok and .data.accessVerified
and (.data.identity.identity.recurringAllowed == true)
and (.data.identity.permittedSources | index("google_search") != null)' access.json認証ストレージと永続ファイル
インスペクト data.credentialProtection でん auth status. Linuxは、ロック解除されたシークレットサービスを利用することができます。 ヘッドレスホストまたは上記のコンテナは、所有者のみのプレーンテキストファイルを使用する可能性があります。 ステートディレクトリをプライベートで永続的に保持します。 ノートパソコンの暗号化されたプロファイルとは別にデプロイされたユーザーをプロビジョニングします。
| 保存する | 地域 |
|---|---|
| 犯罪者とジャーナルの実行 | FLASHDATA_STATE_DIR |
| 入力、領収書および結果 | Dockerのタスクフォルダ;/workとしてマウント。 |
3. リクエストとコストを検証
runtime.shの横にあるrequest.jsonを保存します。 以下のチェックは、再発アクセスとリクエストを検証し、現在の価格設定を読み込み、利用可能な残高と比較します。 クレジットの登録は行っておりません。 フィルターがtrueを印刷するときだけ続けて下さい。
{
"source": "google_search",
"query": "battery recycling research",
"params": {
"num": 5
}
}set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata account balance --json --non-interactive > balance.json
run_flashdata query --input request.json --mode realtime --dry-run --recurring \
--run-id deployment-first-task --json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
.ok and .data.dryRun and .data.estimateAvailable
and ($balance[0].ok == true)
and any(.data.estimate.prices[]?;
.source == "google_search" and .available == true
and (.estimatedCredits | type == "number")
and ($balance[0].data.availableCredits | type == "number")
and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json4. 一度実行し、再使用を確認
deployment-check.shを以下に保存します。 新しいデプロイメント・ファースト・タスクが ID を実行すると、最初の実行は 1 つの有料検索を提出します。 2 つは新しいプロセスを開始し、保存された結果を読みます。 このIDが同じプロファイルで既に完了している場合は、両方の試みが再利用できます。
保存 deployment-check.sh
作成する deployment-check.sh そばに runtime.sh とりあえず request.json ホストのプライベートタスクフォルダに。 以下に完全なスクリプトをコピーして保存します。
#!/usr/bin/env bash
set -euo pipefail
umask 077
cd -- "$(dirname -- "$0")"
. ./runtime.sh
attempt=$(mktemp -d ./deployment-check.XXXXXX)
printf 'Attempt files: %s\n' "$attempt" >&2
cp -- request.json "$attempt/request.json"
if ! run_flashdata query --input "$attempt/request.json" --mode realtime --recurring \
--run-id deployment-first-task --timeout 2m --json --non-interactive \
--output "$attempt/result.json" \
> "$attempt/receipt.json" 2> "$attempt/error.json"; then
cat "$attempt/error.json" >&2
exit 1
fi
jq -e '.ok == true' "$attempt/receipt.json" >/dev/null
jq -e '.source == "google_search" and .status == "done"
and (.results[0].organic | type == "array")' "$attempt/result.json" >/dev/null
jq '{runId, cached, usage}' "$attempt/receipt.json"
printf 'Saved result: %s\n' "$attempt/result.json"保存したチェックを2回実行する
同じサービスユーザーと同じタスクフォルダから実行します。 どちらのプロセスも、runtime.sh をステップで保存します。 1。
# A new run ID submits one paid search; a completed ID reuses its result.
bash deployment-check.sh
# New process; Docker uses a new container with the same mounts.
# Same account, input and state: cached: true, no new search.
bash deployment-check.sh2番目のレシートを確認します。
新しい実行のために、cached: falseを、そしてcached: true期待して下さい。 各試みはdeployment-check.XXXXXXフォルダを印刷し、request.json、receipt.json、error.json、および成功のresult.jsonを、救って下さい。 キャッシュされたレシートは元の使用法を報告します。 失敗した試みは回復のためにファイルを保ちます。
{
"ok": true,
"runId": "deployment-first-task",
"cached": true
}保存された検索結果を読む
ATTEMPT_DIR を上記で印刷した2番目の成功したフォルダーにセットします。たとえば、ATTEMPT_DIR='./deployment-check.ABC123' をエクスポートします。 これらのコマンドはローカルファイルのみを読みます。
# Use one attempt folder printed by deployment-check.sh.
: "${ATTEMPT_DIR:?Set a saved deployment-check.XXXXXX folder}"
jq '{runId, cached, usage}' "$ATTEMPT_DIR/receipt.json"
jq '.results[0].organic[] | {title, link, snippet}' "$ATTEMPT_DIR/result.json"展開から移動する 再発タスクにチェック
このチェックは、ID を固定している。 再帰作業のために、それぞれが独自のIDを発生させ、選択したランタイム、アカウント、入力スナップショット、状態マウントを保持します。 run_flashdata を使うために、再発ランナーのクエリコマンドを適応させるので、Docker タスクはコンテナ内で保持されます。
GitHubアクションからのアクセスを確認する
信頼される、永続的使用して下さい Linux ランナーと Bash, jq そして、 CLI すでにランナーの下部にインストールされているプロファイル OS ユーザ。 アプリケーションリポジトリでこのワークフローを保存します。 有料タスクを実行せずにホストCLIをチェックします。
- Flashdata-research ラベルをそのランナーに割り当てます。
- リポジトリ変数を FLASHDATA_BIN と FLASHDATA_STATE_DIR を絶対パスに設定し、FLASHDATA_PROFILE をインストールしたプロファイル名に指定します。
name: FlashData access check
on: workflow_dispatch
permissions: {}
concurrency:
group: flashdata-research
cancel-in-progress: false
jobs:
verify:
runs-on: [self-hosted, linux, flashdata-research]
timeout-minutes: 5
steps:
- name: Verify the installed profile without a paid query
shell: bash
env:
FLASHDATA_BIN: ${{ vars.FLASHDATA_BIN }}
FLASHDATA_STATE_DIR: ${{ vars.FLASHDATA_STATE_DIR }}
FLASHDATA_PROFILE: ${{ vars.FLASHDATA_PROFILE }}
FLASHDATA_API_KEY: ""
run: |
set -euo pipefail
: "${FLASHDATA_BIN:?Set the absolute CLI path}"
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
: "${FLASHDATA_PROFILE:?Set the installed profile name}"
test -d "$FLASHDATA_STATE_DIR"
"$FLASHDATA_BIN" auth status --profile "$FLASHDATA_PROFILE" \
--state-dir "$FLASHDATA_STATE_DIR" --json --non-interactive |
jq -e '.ok and .data.accessVerified
and (.data.identity.identity.recurringAllowed == true)
and (.data.identity.permittedSources | index("google_search") != null)'アクセスチェックを実行
リポジトリのデフォルトブランチでワークフローを保存した後、アクション → FlashData アクセスチェック → ワークフローを実行します。 true と成功したチェックを期待します。 アクセスや権限を欠くと、検索を提出せずにジョブが失敗します。
ジョブ間で実行状態を保持する
オリジナルジャーナルを使わずに、エピヘムアルランナーがスタート。 有料再発工事の耐久性のあるアプリケーションの状態または持続的なランナーを使用してください。 以前のジョブの投稿を識別できないキーのみを再インストールします。 ステートディレクトリとタスクの出力をプライベートに保ちます。CIアーティファクトとしてアップロードしないでください。
デプロイされたアクセスを回転または変更する
パユースディスパッチ。 タスクフォルダでは、同じアカウントと必要なソースの置換キーで FLASHDATA_KEY_FILE を指し、以下のコマンドを実行します。 アクセスチェックとdeployment-check.shを繰り返し、cached: trueを期待します。 確認後、古いキーを再実行し、プロファイルと状態ディレクトリを保持します。
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Point to the mounted replacement key for the same account}"
run_flashdata auth login --replace --api-key-stdin --non-interactive \
< "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactiveアクセスを完全に停止する
スケジューラを悪用し、コンソールのキーまたはエージェントの接続を再開し、フリーアクセスチェックを繰り返します。 失敗しなければなりません。 ローカルログアウトだけでサーバーのクレデンシャルを復活させません。既にエクスポートされたファイルはディスクに残ります。
展開チェックが失敗する
| シンプトム | フィックス |
|---|---|
| コマンドが見つからなかった / 間違った CLI バージョン | runtime.sh の -v フラッシュデータと FLASHDATA_BIN のコマンドをチェックします。 Docker では、画像の --version チェックを再構築して実行します。 |
| マウントを欠くか、または許可が拒否される | サービスUID/GID.が所有するDockerホスト上の状態とタスクフォルダを作成します パスを安定した状態に保ちます。 |
| replacement_requires_flag | プロファイルには、別の保存キーがあります。 既存のアクセスを最初に確認します。 意図した置換の回転手順を使用してください。 |
| 保存されたアクセスを復号化できません | 同じクレデンシャルストアの環境で、それを規定するユーザとして実行します。 暗号化されたラップトッププロファイルをコピーする代わりに、新しい宛先へのプロビジョニングアクセス。 |
| コストチェックはfalseを返します | balance.json と preflight.json を調べます。 提出する前に、利用可能な価格、ソースの許可、十分な残高が必要です。 |
| run_account_mismatch | 選択したアカウントとAPIの由来を確認してください。 元のアクセスを復元します。バイパスの回復への実行の名前を変更しないでください。 |
| run_id_input_conflict | request.jsonの試みから元の要求を元通りに復元します。 新しく実行された ID は、意図した新しい有料タスクだけに使用します。 |
| CI はキューされたまま | ランナーがオンラインであることを確認し、ランオンのラベルがすべてあります。 このワークフローでは、持続的なセルフホストLinuxランナーが必要です。 |