Обзор документации
Руководства
Запустите задачи CLI вашего приложения или агента на Linux или Docker, а затем проверьте доступ и получите повторное использование после перезагрузки.
На этой странице
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, чтобы найти его абсолютный путь, а затем установите FLASHDATA_BIN на этот путь в runtime.sh. Установите имя профиля и постоянный путь состояния здесь, а затем сохраните файл.
# 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 скачайте прикрепленный 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 |
| Ввод, поступления и результаты | Папка задач; установлена как /work в Docker. |
3. Проверить запрос и стоимость
Сохраните request.json рядом с runtime.sh. Следующая проверка проверяет повторяющийся доступ и запрос, считывает текущие цены и сравнивает их с имеющимся балансом. Он не осуществляет поиск и не резервирует кредиты. Продолжайте только тогда, когда фильтр печатает 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, первое исполнение отправляет один платный поиск; второе запускает новый процесс и считывает сохраненный результат. Если этот 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"Дважды проверяйте сохраненный чек
Запустите эту папку задач хоста как тот же пользователь службы. Оба процесса загружают 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.shПроверьте вторую квитанцию
Для нового запуска, ожидайте 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 во вторую успешную папку, напечатанную выше, например, экспортируйте 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 Actions
Используйте надежный, постоянный бегун Linux с Bash, jq и профилем CLI, уже установленным под пользователем бегуна OS. Сохраните этот рабочий процесс в хранилище вашего приложения. Он проверяет хост CLI без выполнения платной задачи.
- Назначьте ярлык поиска флешданных этому бегуну.
- Установите переменные репозитория 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)'Проверить доступ
После сохранения рабочего процесса в отделении репозитория по умолчанию откройте Actions → 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 | Проверьте команду -v flashdata и FLASHDATA_BIN в runtime.sh. Для Docker перестраивайте и запускайте проверку изображения --version. |
| Пропавшая гора или отказано в разрешении | Создание папок состояния и задач на хосте Docker, принадлежащем сервису UID/GID. Держите их пути стабильными. |
| replacement_requires_flag | Профиль имеет другой сохраненный ключ. Сначала проверьте существующий доступ; используйте процедуру ротации для предполагаемой замены. |
| Невозможно расшифровать сохраненный доступ | Работайте как пользователь, который предоставил его, в той же среде хранилища учетных данных. Предоставление доступа к новому пункту назначения вместо копирования зашифрованного профиля ноутбука. |
| Проверка стоимости false | Проверить balance.json и preflight.json. Требуйте доступную цену, разрешение источника и достаточный баланс перед отправкой. |
| run_account_mismatch | Проверьте выбранный аккаунт и происхождение API. Восстановите исходный доступ; не переименовывайте пробег в обход восстановления. |
| run_id_input_conflict | Восстановите первоначальный запрос от request.json. Используйте новый запуск ID только для предполагаемой новой платной задачи. |
| CI остается в очереди | Убедитесь, что бегун находится в сети и имеет все ярлыки. Этот рабочий процесс требует постоянного самостоятельного бегуна Linux. |