CDN: Adds support for serving assets over a CDN #30691

torkelo · 2021-01-27T21:44:46Z

Adds option to load js & css from cdn path. Tested by starting a local nginx with a custom hostname and copying everything under public to it.

This does not currently impact loading plugins, they are still loaded from instance.

It does impact the content_security_policy, if enabled it needs to be modified allow the cdn. Not sure how exactly.

TODO

How to make it apply to all images

ryantxu · 2021-01-28T04:57:51Z

public/app/index.ts

@@ -1,4 +1,6 @@
-import app from './app';
+declare let __webpack_public_path__: string;
+__webpack_public_path__ = window.public_cdn_path;


is this used?

Yes this is the key part of telling webpack where to load files

Without this all the dynamic webpack chunks are loaded from localhost

hugohaggmark

I think the code looks ok, but I'm not very familiar with all the details.

marefr

Awesome 👍

Other things to consider referencing CDN might be email templates for example.

Another thing to take into consideration would be to not having to update the CDN path config each time you upgrade Grafana - I guess this partly will be solved by the build hashes, but thinking about 10 Grafana releases would currently require 10x all the files with hashes in the same CDN folder, unless CDN path config is not changed on upgrade. Maybe would make sense to always enforce/include version number/commit in the CDN path?

torkelo · 2021-01-28T09:03:26Z

pkg/setting/setting.go

@@ -1297,6 +1298,7 @@ func readServerSettings(iniFile *ini.File, cfg *Cfg) error {
 		return err
 	}

+	cfg.CDNPath = valueAsString(server, "cdn_path", "")


@marefr think here we should probably add Grafana version string to the path (so v7.4.0-beta1) for example. (or in index.go) so that on the cdn each published release is under different paths , the config path you set in the ini file is just the root cdn path

using a hash would work with master builds and pre-releases as well. That would be nice.

So maybe both version and hash then? Or only using hash for pre-releases and version for stable ones, not sure how hard that would be.

The asset files are already hashed, this should just add version folder. Master builds already build a number of some sort I think

True, makes sense

torkelo · 2021-01-29T10:09:44Z

@bergquist @marefr added edition & and BuildVersion to the url as well so paths becomes

https://cdn.grafana.com/oss/v7.5.0-11124pre
https://cdn.grafana.com/enterprise/v7.5.0-11124pre

if the cdn_path is set to https://cdn.grafana.com depending on what verison & edition grafana is

torkelo · 2021-01-29T10:23:02Z

Added one final thing, also segrate master builds into a separate path for easier clean-up. So it will be

/oss
  /v7.4.0-beta1
  /v7.4.0
  /master
     /v7.5.0-121pre
/enterprise
 ....

marefr

Awesome. This is great 👍 Spotted some minor problems, see comments. .ini files and documentation needs update as well

pkg/setting/setting.go

pkg/setting/setting_test.go

…dded docs

torkelo · 2021-01-29T11:55:19Z

@marefr pushed changes, added error handling in the read config stage (of the url parsing), changed the property name from cdn_path to cd_url as it's a url not just path. Added docs

achatterjee-grafana

Added some copy-edit suggestions for the doc content.

public/views/index-template.html

docs/sources/administration/configuration.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

achatterjee-grafana

Added the suggestion to fix a typo that got missed earlier.

achatterjee-grafana · 2021-01-29T16:16:57Z

docs/sources/administration/configuration.md

+
+Specify a full HTTP URL address to the root of your Grafana CDN assets. Grafana will add edition and version paths.
+
+For example, given a cdn url like `https://cdn.myserver.com` grafana will try to load a javascript file from


Suggested change

For example, given a cdn url like `https://cdn.myserver.com` grafana will try to load a javascript file from

For example, given a CDN URL like `https://cdn.myserver.com` grafana will try to load a javascript file from

marefr

LGTM

* CDN: Initial poc support for serving assets over a CDN * Minor fix * added build path and test * fix lint error * Added edition to cdn path * Move master builds to a separate path * Added error handling for the url parsing, changed setting name, and added docs * Updated sample.ini * Some property renames * updated * Minor update to html * index template improvements * Update docs/sources/administration/configuration.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/administration/configuration.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Added ContentDeliveryPrefix to Licence service * updated docs * Updated test mock Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> (cherry picked from commit c04bc80)

* CDN: Initial poc support for serving assets over a CDN * Minor fix * added build path and test * fix lint error * Added edition to cdn path * Move master builds to a separate path * Added error handling for the url parsing, changed setting name, and added docs * Updated sample.ini * Some property renames * updated * Minor update to html * index template improvements * Update docs/sources/administration/configuration.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/administration/configuration.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Added ContentDeliveryPrefix to Licence service * updated docs * Updated test mock Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> (cherry picked from commit c04bc80) Co-authored-by: Torkel Ödegaard <torkel@grafana.org>

CDN: Initial poc support for serving assets over a CDN

f2dae1c

torkelo requested a review from a team as a code owner January 27, 2021 21:44

torkelo requested review from a team, papagian, jessabe, hugohaggmark and peterholmberg and removed request for a team January 27, 2021 21:44

torkelo changed the title ~~CDN: Initial poc support for serving assets over a CDN~~ CDN: Adds support for serving assets over a CDN Jan 27, 2021

ryantxu reviewed Jan 28, 2021

View reviewed changes

Minor fix

b6aee20

hugohaggmark approved these changes Jan 28, 2021

View reviewed changes

torkelo added this to In Review in Frontend Platform Backlog via automation Jan 28, 2021

torkelo added this to the 7.5.0 milestone Jan 28, 2021

marefr approved these changes Jan 28, 2021

View reviewed changes

torkelo commented Jan 28, 2021

View reviewed changes

torkelo added 3 commits January 28, 2021 20:51

added build path and test

53087e6

fix lint error

257ddbb

Added edition to cdn path

5a8e6d8

Move master builds to a separate path

b05e57f

marefr requested changes Jan 29, 2021

View reviewed changes

pkg/setting/setting.go Outdated Show resolved Hide resolved

pkg/setting/setting_test.go Show resolved Hide resolved

Added error handling for the url parsing, changed setting name, and a…

174dd67

…dded docs

torkelo requested a review from a team as a code owner January 29, 2021 11:51

torkelo requested review from oddlittlebird, achatterjee-grafana and osg-grafana and removed request for a team January 29, 2021 11:51

torkelo added 4 commits January 29, 2021 12:55

Updated sample.ini

28c8d25

Some property renames

49599ee

updated

3190b33

Minor update to html

3b84e72

achatterjee-grafana reviewed Jan 29, 2021

View reviewed changes

public/views/index-template.html Show resolved Hide resolved

public/views/index-template.html Outdated Show resolved Hide resolved

docs/sources/administration/configuration.md Outdated Show resolved Hide resolved

docs/sources/administration/configuration.md Outdated Show resolved Hide resolved

torkelo and others added 3 commits January 29, 2021 16:25

index template improvements

34474dd

Update docs/sources/administration/configuration.md

7237aff

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

Update docs/sources/administration/configuration.md

bd49ae9

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

achatterjee-grafana approved these changes Jan 29, 2021

View reviewed changes

marefr approved these changes Jan 29, 2021

View reviewed changes

torkelo added 3 commits January 31, 2021 08:38

Added ContentDeliveryPrefix to Licence service

35f35d1

updated docs

7444a11

Updated test mock

d07e2e1

torkelo merged commit c04bc80 into master Feb 1, 2021

Frontend Platform Backlog automation moved this from In Review to Done Feb 1, 2021

torkelo deleted the cdn-support branch February 1, 2021 09:13

torkelo modified the milestones: 7.5.0, 7.4.0-stable Feb 1, 2021

torkelo added the old backport v7.4.x Mark PR for automatic backport to v7.4.x label Feb 1, 2021

grafanabot mentioned this pull request Feb 1, 2021

[v7.4.x] CDN: Adds support for serving assets over a CDN #30776

Merged

torkelo added the add to changelog label Feb 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CDN: Adds support for serving assets over a CDN #30691

CDN: Adds support for serving assets over a CDN #30691

torkelo commented Jan 27, 2021 •

edited

ryantxu Jan 28, 2021

torkelo Jan 28, 2021

torkelo Jan 28, 2021

hugohaggmark left a comment

marefr left a comment

torkelo Jan 28, 2021

bergquist Jan 28, 2021

marefr Jan 28, 2021

torkelo Jan 28, 2021 •

edited

marefr Jan 28, 2021

torkelo commented Jan 29, 2021

torkelo commented Jan 29, 2021

marefr left a comment

torkelo commented Jan 29, 2021

achatterjee-grafana left a comment

achatterjee-grafana left a comment

achatterjee-grafana Jan 29, 2021

marefr left a comment


		Specify a full HTTP URL address to the root of your Grafana CDN assets. Grafana will add edition and version paths.

		For example, given a cdn url like `https://cdn.myserver.com` grafana will try to load a javascript file from

CDN: Adds support for serving assets over a CDN #30691

CDN: Adds support for serving assets over a CDN #30691

Conversation

torkelo commented Jan 27, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hugohaggmark left a comment

Choose a reason for hiding this comment

marefr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

torkelo Jan 28, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

torkelo commented Jan 29, 2021

torkelo commented Jan 29, 2021

marefr left a comment

Choose a reason for hiding this comment

torkelo commented Jan 29, 2021

achatterjee-grafana left a comment

Choose a reason for hiding this comment

achatterjee-grafana left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marefr left a comment

Choose a reason for hiding this comment

torkelo commented Jan 27, 2021 •

edited

torkelo Jan 28, 2021 •

edited