G
YouTube TikTok Games
Skip to content

docs: add adr for the sched historical import script - #5205

Merged
joanagmaia merged 7 commits into
mainfrom
docs/issue-944-sched-import-adr
Nov 13, 2026
Merged

joanagmaia merged 7 commits into
mainfrom
docs/issue-944-sched-import-adr

Conversation

@joanagmaia

@joanagmaia joanagmaia commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds ADR-0037, the technical approach for importing past Sched events into CDP, for review by a teammate before any code is written. LF events leave Sched in 2027, so instead of an ongoing connector we import the history of LF's past Sched events (658 that LF staff administer, 2016–2026) once, with code that can be re-run later. The product spec is here.

Changes

  • docs/adr/0037-sched-historical-import-script.md (status: proposed):
    • A one-time, re-runnable crowd.dev script sends activities to the data sink the same way the Snowflake connectors do, so they follow the existing path to Tinybird and Snowflake.
    • A reviewed mapping file in the repo lists each event and its CDP project, with no secrets.
    • Each event's existing API key is collected once from its Sched Control Panel by a browser script and kept in one 1Password item, one concealed field per subdomain. Before a run, an operator pipes the item into a short-lived Kubernetes secret (no key on disk); the job mounts it and the secret is deleted after the run.
    • Source ids include the event and the channel is the subdomain, so re-runs update activities instead of duplicating them.
    • Rejected alternatives: loading into Snowflake first, running a v2 connector once, keys in Oracle Vault (new infrastructure for a one-time import), and a 1Password service account (needs an admin; switching later keeps the importer unchanged only with an init container that writes the same mounted file).
  • docs/adr/README.md: index row for ADR-0037.

Numbered 0037 because #5185 already uses 0036.

Organizations and the product sign-off (key type, activity types and scores, registration time, project per event) are still open with product; the ADR notes them and covers the technical approach only. On approval, the reviewer goes into Deciders and the status moves to accepted.

Type of change

  • Bug fix
  • New feature
  • Refactor / cleanup
  • Performance improvement
  • Chore / dependency update
  • Documentation

Related issue

Closes linuxfoundation/lfx-cdp-insights-ops#944

Refs linuxfoundation/lfx-cdp-insights-ops#944

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Copilot AI balanced review requested due to automatic review settings November 4, 2026 15:55
@cursor

cursor Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only; no runtime or infrastructure changes until implementation follows the ADR.

Overview
Adds proposed ADR-0037 and an index entry in docs/adr/README.md for importing LF’s historical Sched events (2016–2026) without building an ongoing Sched connector.

The ADR records the chosen approach: a one-time, re-runnable crowd.dev script that calls the Sched API per event and emits activities through DataSinkWorkerEmitter.createAndProcessActivityResult (same path as Snowflake connectors), with event→CDP project mappings in a reviewed repo file and per-event API keys in 1Password, loaded only for each run via a short-lived Kubernetes secret. It documents rejected options (Snowflake-first, one-shot v2 connector, Oracle Vault, 1Password service account) and operational risks (rate limits, auth quirks, idempotency, no raw backup after 2027).

Reviewed by Cursor Bugbot for commit 66dad56. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps

greptile-apps Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The documentation appears safe to merge as a proposed decision.

Summary

Adds proposed ADR-0037 for a one-time, re-runnable Sched historical import and adds it to the ADR index.

  • The ADR records a re-runnable plan for importing past Sched events.

Reviews (6) · Last reviewed commit: "docs: qualify the service account altern..." · Reviewed by Greptile

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

CDP’s first OCI Vault integration requires CloudOps/security validation of the unspecified workload-identity and access-policy design, secret provisioning, and credential deletion before the ADR can be accepted.

No open issues 🎉

What changed in this PR

Documents a proposed approach for importing LF’s historical Sched events into CDP before the move to Sessionize in 2027. This PR adds documentation only; implementation and product decisions remain pending.

Changes:

  • Proposes a one-time, re-runnable script using the existing data-sink ingestion pipeline.
  • Defines event-to-project mapping, per-event Oracle Vault secrets, and safeguards for repeat runs and API limits.
  • Records alternatives, operational risks, and open product questions.
File Description
docs/​adr/​README.md Adds the index entry for proposed ADR-0037.
docs/​adr/​0037-sched-historical-import-script.md Documents the historical import approach, alternatives, constraints, and unresolved decisions.

Review effort: Balanced

…import-adr

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>

# Conflicts:
#	docs/adr/README.md
Copilot AI balanced review requested due to automatic review settings November 4, 2026 16:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

CDP’s first OCI Vault integration requires human CDP/CloudOps validation of workload identity, access policies, and credential lifecycle before its architecture can be accepted.

No open issues 🎉

Review effort: Balanced

@joanagmaia
joanagmaia requested a review from mbani01 November 4, 2026 16:40
mbani01
mbani01 previously approved these changes Nov 11, 2026

@mbani01 mbani01 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - as discussed, we can skip the vault since this will be a one-time use and there's no need to store the keys

Copilot AI balanced review requested due to automatic review settings November 12, 2026 10:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Teammate validation is needed for the Sched API assumptions, username stability underlying deduplication, and initial OCI Vault/workload-identity setup, as this docs-only PR provides no implementation or POC to verify them.

No open issues 🎉

Review effort: Balanced

Refs linuxfoundation/lfx-cdp-insights-ops#944

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Copilot AI balanced review requested due to automatic review settings November 13, 2026 12:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

CDP/product and security review is needed to resolve credential permissions and replay identity rules and validate Sched-specific backfill assumptions not established by repository evidence.

No open issues 🎉

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 13, 2026 12:16
Refs linuxfoundation/lfx-cdp-insights-ops#944

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The ADR’s no-code-change claim needs qualification because a 1Password service-account token alone cannot supply the mounted key file without a wrapper/init container or importer changes.

1 open issue

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 13, 2026 12:19
Refs linuxfoundation/lfx-cdp-insights-ops#944

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

A CDP reviewer with Sched API/POC access needs to validate credential, rate-limit, and identifier-stability assumptions and resolve timestamp/project choices, since the linked requirements were inaccessible.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 13, 2026 12:22
@joanagmaia
joanagmaia merged commit cbdc71e into main Nov 13, 2026
15 checks passed
@joanagmaia
joanagmaia deleted the docs/issue-944-sched-import-adr branch November 13, 2026 12:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues remain for the proposed historical Sched import documentation.

No open issues 🎉

Review effort: Balanced

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants