Commit graph

37 commits

Author SHA1 Message Date
Roberto Jiménez Sánchez
afb7384f51
Docs: Document the folderless Git Sync target (#125810)
* Docs: Document the folderless Git Sync target

Adds a "Sync targets" section to the Git Sync key concepts page
describing the `folder` and `folderless` targets, and updates the
code-based setup page to document `target: folderless` alongside
`target: folder`.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* Docs: Add folder vs folderless examples to Git Sync key concepts

Focus the Sync targets section on the folder and folderless modes and
add worked examples showing how the same repository files map to the
Dashboards view under each target.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* Docs: Refine folderless sync target examples in key concepts

Describe the folder and folderless sync modes conceptually instead of by
the spec.sync.target field (the field stays documented in the setup
page), show unprovisioned content alongside synced resources in the
examples, and add a multiple-folderless example.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* Update docs/sources/as-code/observability-as-code/git-sync/key-concepts.md

Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>

* Update docs/sources/as-code/observability-as-code/git-sync/key-concepts.md

Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>

* Docs: Move sync target when-to-use guidance to top of section

Address review feedback: surface when to use folder vs folderless sync
up front, before the worked examples, since that's what readers want
to know first. Remove the now-redundant trailing paragraph.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
2026-06-09 16:53:38 +02:00
Anna Urbiztondo
7e36b78522
Docs: Git Sync - dashboard updates (#125944) 2026-06-08 12:02:24 +02:00
Anna Urbiztondo
9bf645d320
Docs: Git Sync - Resource limits (#125536)
Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>
2026-06-08 11:52:18 +02:00
Anna Urbiztondo
91c8e4a594
Clarification (#125432) 2026-05-26 12:50:42 +02:00
Anna Urbiztondo
40c02eb106
Docs: Git Sync link fix (#124782)
* Link fix

* Prettier

* Fix
2026-05-13 12:28:35 +02:00
Anna Urbiztondo
dc94b04fb6
Docs: Git Sync - Minor edit (#124773)
Minor edit
2026-05-13 11:49:33 +02:00
Roberto Jiménez Sánchez
bd71d665de
Provisioning: add public_root_url instance setting for external URLs (#123613)
* Provisioning: add public_app_url instance setting for external URLs

Introduces the [provisioning] public_app_url setting to expose a
publicly-reachable URL for instances whose [server] root_url points at an
internal/cluster host. Both webhook callbacks registered with the Git
provider and screenshot images embedded in PR comments fall back through
this setting when set, so a single instance-level knob fixes both the
unreachable-webhook and broken-PR-image-render cases without overloading
the per-repository spec.webhook.baseUrl contract.

Resolution chains:
- Webhook URL: spec.webhook.baseUrl -> public_app_url -> AppURL
- Screenshot URL: public_app_url -> AppURL

Screenshots intentionally do not consult spec.webhook.baseUrl — per-repo
webhook overrides remain a webhook-only concern, keeping the two
contracts independent at the consumer layer.

Alternative to #123004.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Provisioning: rename public_app_url to public_root_url

The setting shadows [server] root_url as a fallback, so naming it
public_root_url makes the relationship obvious — operators searching
docs for "root_url" will land on the correct setting.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Provisioning: keep clickable links on AppURL even when public_root_url is set

The previous revision flipped the entire urlProvider closure to public_root_url,
which also moved the GrafanaURL and PreviewURL clickable links in PR comments
onto the public URL. That's wrong for the common reviewer scenario: clicks
travel from a human's browser on the corp network, and the public URL is often
firewalled to the Git provider's CIDRs only — internal reviewers would 403 on
their own preview links.

Split into two closures: internalURLProvider (returns AppURL, fed to the
evaluator's urlProvider for clickable links) and publicURLProvider (returns
public_root_url || AppURL, fed to the webhook builder and as screenshotBaseURL
for image embeds). Webhooks and screenshots stay public-reachable; clickable
links stay corp-network-friendly.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Provisioning: fall back to public_root_url for operator webhook registration

The operator runs as a separate process and previously needed
[operator] provisioning_server_public_url to be set explicitly to register
webhooks. With public_root_url now defined at the instance level, fall back
to it when the operator-specific knob is unset, so a single config drives
both the in-process and operator deployments.

If neither is set, behavior is unchanged (no webhook registered).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Provisioning: scope public_root_url to on-prem only

The operator deployment path runs in a different topology and is not the
target audience for the on-prem dual-network use case that motivates
public_root_url. Reverting the operator-side wiring so the setting stays
purely an on-prem concern; can revisit if/when operator deployments grow
the same need.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Provisioning: trim operator jobs.go to minimal NewEvaluator signature change

Operator path doesn't consume public_root_url; only the new screenshotBaseURL
argument is wired (passing AppURL, unused at runtime due to NoOp renderer).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Provisioning: replace evaluator's split URL args with URLProvider struct

NewEvaluator previously took urlProvider and screenshotBaseURL as separate
arguments, which forced the operator path to invent a screenshotBaseURL
value (cfg.AppURL) it didn't actually need. Wrap both into a URLProvider
struct with Internal and Public fields — each caller fills in what it knows:

- In-process Grafana: Internal=AppURL, Public=public_root_url||AppURL.
- Operator (NoOp renderer, no public/internal split): Internal=Public=
  the existing per-tenant urlProvider from controllerCfg.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-06 12:55:59 +02:00
Roberto Jiménez Sánchez
edfb4653c4
Docs: Git Sync - Note PAT must belong to a repo admin for webhooks (#123790)
GitHub only grants the Webhooks: Read and write fine-grained permission
to users with the Admin role on the repository. Without admin, the token
can't manage the webhooks Git Sync uses for instantaneous updates and PR
previews. Add a note in the GitHub Personal Access Token setup section.
2026-04-29 11:02:28 +02:00
Anna Urbiztondo
580249f531
Docs: GS - Nested folders (#123733)
* Nested folders

* Prettier

* Update docs/sources/as-code/observability-as-code/git-sync/usage-limits.md

Co-authored-by: Rafael Bortolon Paulovic <rafael.paulovic@grafana.com>

---------

Co-authored-by: Rafael Bortolon Paulovic <rafael.paulovic@grafana.com>
2026-04-28 18:30:31 +02:00
Anna Urbiztondo
c2f0b68547
Docs: Updates to Git Sync limits (#123460)
* GS limits

* Fix

* More details
2026-04-24 12:09:30 +02:00
Anna Urbiztondo
d425466acd
Docs: Git Sync permissions (#123011)
Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>
2026-04-23 12:52:18 +02:00
Anna Urbiztondo
0fee8e8039
Docs: Git Sync - Note on Azure DevOps (#123193)
Note on Azure
2026-04-22 10:43:27 +02:00
Anna Urbiztondo
63558ba0ad
gcx sweep (#122652)
Co-authored-by: Andres Martinez Gotor <andres.martinez@grafana.com>
2026-04-20 15:47:06 +00:00
Anna Urbiztondo
0ddacc7e57
Docs: Note for Pure Git (#122901) 2026-04-17 12:34:08 +02:00
Irene Rodríguez
e8e6672ce7
Docs: fix broken link to GitHub App link in documentation (#122784) 2026-04-16 09:01:17 +00:00
Irene Rodríguez
67635ecfaf
Docs: Clarify Git Sync capabilities and export options (#122781) 2026-04-16 10:43:59 +02:00
Irene Rodríguez
915a82a543
Update broken link in Git Sync deployment scenarios (#122778) 2026-04-16 10:43:36 +02:00
Anna Urbiztondo
5b02600d29
Docs: Git Sync - Folder permissions + G13 (#120006)
* Structure

* More details

* How to modify, Prettier

* Explanation

* More

* Fix

* Style

* Update docs/sources/as-code/observability-as-code/git-sync/git-sync-setup/set-up-before.md

Co-authored-by: Daniele Stefano Ferru <daniele.ferru@grafana.com>

* Prettier

* Edits after trying out

* Prettier

* Fix

* Removed note for GA

* Update docs/sources/as-code/observability-as-code/git-sync/usage-limits.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/git-sync-setup/set-up-before.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/use-git-sync.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/git-sync-setup/set-up-code.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/git-sync-setup/set-up-extend.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/git-sync-setup/set-up-terraform.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/export-resources.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/key-concepts.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Update docs/sources/as-code/observability-as-code/git-sync/provisioned-dashboards.md

Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>

* Note updates

* Feedback

* More feedback

* Details

* Clarification

---------

Co-authored-by: Daniele Stefano Ferru <daniele.ferru@grafana.com>
Co-authored-by: Fabrizia Rossano <117294258+frossano-grafana@users.noreply.github.com>
2026-04-14 10:10:09 +02:00
Anna Urbiztondo
dd72c4ba79
Docs: GS - Updating limits (#122207) 2026-04-09 11:22:22 +02:00
Stephanie Hingtgen
a1446f6064
Docs: Update to reference v1 folders and dashboards (#121505) 2026-03-31 08:50:47 +03:00
Anna Urbiztondo
cf58f3345c
Docs: Git Sync - allow IPs (#121328)
IPs
2026-03-27 16:23:10 +01:00
Roberto Jiménez Sánchez
5b8689f2d3
Docs: Remove manual provisioning feature toggle instructions (#121206)
* Docs: Remove manual provisioning feature toggle instructions

The provisioning feature toggle is now enabled by default in v13,
so users no longer need to manually set it in their configuration.
Update Git Sync setup, file provisioning, and usage limits docs
to reflect this.

Made-with: Cursor

* Docs: Note provisioning toggle is enabled by default in Cloud too

Made-with: Cursor

* Docs: Apply review suggestion for wording clarity

Co-authored-by: urbiz-grafana
Made-with: Cursor
2026-03-26 15:38:50 +01:00
Anna Urbiztondo
f6f158370d
Docs: GS Terraform (#120563)
* Structure

* Content

* Edit

* Feedback
2026-03-24 09:13:53 +01:00
Anna Urbiztondo
50f07096f1
Docs: Add GL service account token details (#120488)
serv acc token
2026-03-17 11:23:22 +01:00
Roberto Jiménez Sánchez
45167d9d9a
Docs: clarify Pure Git protocol support and GitHub Enterprise Server status (#120270)
Docs: clarify Pure Git protocol support and GitHub Enterprise status

Update the Git Sync usage limits documentation to specify that Pure Git
only supports Smart HTTP protocol v2 (not v1/v0 or SSH), and add a note
under the enhanced integrations section that GitHub Enterprise Server is
currently only available via Pure Git with a dedicated integration
planned for upcoming releases.

Made-with: Cursor
2026-03-13 12:15:14 +01:00
Anna Urbiztondo
40690d1cbe
Docs: Git Sync - Save from UI. (#119732)
* Saveas

* Typos

* Wording

* Update docs/sources/as-code/observability-as-code/git-sync/export-resources.md

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>

* Edits

* Further details

* More clarifications

* CLI links

* Prettier

---------

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>
2026-03-09 16:24:36 +01:00
Anna Urbiztondo
0b92a19f7a
Docs: Git Sync - config providers for OSS and Enterprise (#119712)
* Adding providers for OSS and Enterprise

* Updates

* Prettier

* Note style edit
2026-03-06 13:07:02 +00:00
Roberto Jiménez Sánchez
b5f55eebeb
Docs: Add Administration permission requirement for GitHub Git Sync (#119513)
* Docs: Add Administration permission requirement for GitHub Git Sync

When using the write workflow with GitHub repositories, Git Sync
validates that branch protection rules don't block direct pushes.
This validation requires the Administration read permission.

Without this permission, users receive a 403 Forbidden error when
testing repository configuration. Git Sync now handles this gracefully
by skipping the branch protection check when admin permissions are
unavailable.

Updated documentation:
- Added Administration read-only permission to GitHub App setup
- Added Administration read-only permission to PAT setup
- Added explanatory note about why it's needed

This permission is optional - if not provided, branch protection
validation is skipped and users will discover any issues when they
actually push to the repository.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* Update Administration permission description to be more general

Instead of specifically mentioning 'write workflow', explain that:
- It enables validation of branch protection rules when users can push directly
- It may be used in the future for other repository settings checks
- This makes the permission requirement more future-proof

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-03-04 16:32:36 +00:00
Anna Urbiztondo
aca7fb1019
Docs: Git Sync support and roadmap (#119309)
Support
2026-03-02 15:44:15 +01:00
Anna Urbiztondo
37f8c16625
Docs: GS - Fixing anchor (#119053)
Fixing anchor
2026-02-26 08:02:20 +01:00
Anna Urbiztondo
892134bcf0
Docs: GS - New Git providers (#118354)
* New PR

* asCode for providers

* Typo

* Bitbucket

* Minor edit typos

* Prettier

* Update docs/sources/as-code/observability-as-code/git-sync/git-sync-setup/set-up-code.md

Co-authored-by: Daniele Stefano Ferru <daniele.ferru@grafana.com>

* Feedback, Bitbucket token

* Prettier

---------

Co-authored-by: Daniele Stefano Ferru <daniele.ferru@grafana.com>
2026-02-23 12:42:16 +01:00
Anna Urbiztondo
6ac56aea94
Docs: Git Sync - AsCode for GitHub App (#118266)
* AsCode for App

* Title

* Prettier

* Title2

* Update docs/sources/as-code/observability-as-code/git-sync/git-sync-setup/set-up-code.md

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>

* Edits

---------

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>
2026-02-18 10:58:42 +01:00
Irene Rodríguez
2086237dc3
Fix broken link in known limitations for Git Sync (#118204) 2026-02-16 14:38:57 +00:00
Irene Rodríguez
38de450d95
Update broken link for Git Sync setup requirements (#117747) 2026-02-10 10:47:09 +00:00
Irene Rodríguez
ba659aa67d
Update Git Sync setup link to point to the correct documentation URL (#117695) 2026-02-09 16:43:58 +01:00
Anna Urbiztondo
0bc621677c
Docs: Review GS set-up (#116615)
* WIP

* Edits

* WIP

* Edits

* Tweaks

* Edits

* WIP

* Key concepts

* Edits

* Edits

* More edits

* WIP

* More edits

* GitHub App

* Fixes

* Create App

* Fixes?

* Fix?

* Fix?

* Fix

* Prettier

* More P

* known issues

* Edits

* Fixes

* Limits

* Fixes

* Edits

* Corrections

* Limits

* Note

* Edits

* GHApp updates

* Fixing installId stuff

* New try

* Concepts, states

* Edits to Manage dashboard

* Edits to Manage

* Tweaks

* Prettier

* Prep note

* Note

* Prettier

* Feedback - Roberto

* Fixes

* Fix

* Title

* Limits renaming, rollout

* Menu fix

* Update docs/sources/as-code/observability-as-code/git-sync/usage-limits.md

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>

* Update docs/sources/as-code/observability-as-code/git-sync/usage-limits.md

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>

* Feedback

* Minor edits

* More details

* Edits

---------

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com>
2026-02-05 15:09:29 +01:00
Anna Urbiztondo
db036030d3
Docs: Git Sync revamp (#116477)
* Draft

* File prov tweaks

* Edits to GS

* On-prem minor edits

* Weights

* Trying aliases

* Test?

* Fix?

* Another alias test

* More aliases

* Scenarios aliases

* Fix

* Rest of scenarios

* Scenario index

* Trying

* Fix?

* Fix?

* Prettier

* More Prettier
2026-01-21 14:47:13 +01:00