Upload release notes JSON (relnotes.k8s.io) to a Google Cloud Bucket

[saschagrunert]

What would you like to be added:

We currently vendor the JSON based release notes for relnotes.k8s.io into the repository:
https://github.com/kubernetes-sigs/release-notes/tree/master/src/assets

We could put these assets on a Google Cloud Storage Bucket to give the Release Notes Team a faster way to update the data as well as avoid having the need for an additional PR on update.

Why is this needed:

It's not necessarily needed, but would improve the workflow around the notes and reduce the complexity.

/cc @cartyc @JamesLaverack @justaugustus

[justaugustus]

/assign
/priority important-soon

I need to noodle on this a little, since it will involve granting more people access to GCP...

[cartyc]

@justaugustus Is this something that could be delegated to a service account or would that too broad and not be granular enough?

[JamesLaverack]

This affects the implementation of krel release-notes (see https://github.com/kubernetes/release/blob/master/cmd/krel/cmd/release_notes.go).

@puerco and I were thinking about the implementation, and we realised that in the existing flow we run release-notes, then run a JS based prettier for the JSON, then PR into k-sigs/release-notes. (See the role handbook for more details). We have to run the prettier (there's a build check on k-sigs/release-notes to make sure you have) and so we'd need to invoke NPM from krel to do this currently. So uploading to a bucket would probably make this easier. (We can still pretty-print the JSON, but we can do that in Go instead of invoking the NPM one).

[saschagrunert]

This affects the implementation of krel release-notes (see https://github.com/kubernetes/release/blob/master/cmd/krel/cmd/release_notes.go).

@puerco and I were thinking about the implementation, and we realised that in the existing flow we run release-notes, then run a JS based prettier for the JSON, then PR into k-sigs/release-notes. (See the role handbook for more details). We have to run the prettier (there's a build check on k-sigs/release-notes to make sure you have) and so we'd need to invoke NPM from krel to do this currently. So uploading to a bucket would probably make this easier. (We can still pretty-print the JSON, but we can do that in Go instead of invoking the NPM one).

Sounds good to me! Sure the prettier-invocation would go away if the website fetches the sources from a remote location. 👍

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[saschagrunert]

/remove-lifecycle stale

[saschagrunert]

I think the main issue is here which bucket we choose and how we would handle granting permissions to the bucket. At least the whole SIG Release Notes subteam and Release Engineering would have a need to access the bucket…

[saschagrunert]

/assign @cartyc

We will start working on this soon :)

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[saschagrunert]

/remove-lifecycle stale

[saschagrunert]

Hey @cartyc, do you have any update on this one?

[cartyc]

Sorry @saschagrunert I didn't get the notification for some reason. My initial test worked great I'm just stuck right now on getting my head wrapped around on typescript async. I have it so the call gets made but the difficulty I bumped into is exporting that var from assets.ts .

export const data = async () => {
  const assets = await  gapi.load('client', start);
}

There might be a better approach and my newness to typescript is showing :)

[saschagrunert]

Working on the index file support now in #1812

[saschagrunert]

My target is to finish the process implementation within the next days that we can start consuming the new artifacts with v1.20.0, v1.19.5, v1.18.13 and v1.17.15.

[cartyc]

Hey @saschagrunert I opened a WIP PR kubernetes-sigs/release-notes#215

[saschagrunert]

Hey @saschagrunert I opened a WIP PR kubernetes-sigs/release-notes#215

Thank you! 🙏 I'll give it a first quick review.

[saschagrunert]

Updating the website to consume the artifacts seems to be the final step before closing this.

[justaugustus]

/unassign
/assign @saschagrunert
FYI @wilsonehusin

[ashnehete]

It looks like the implementation on the website side as stalled due to some errors. After debugging @cartyc's PR (kubernetes-sigs/release-notes#215) it seems we could take a different approach and directly fetch release-notes-index.json using a public URL i.e. https://gcsweb.k8s.io/gcs/kubernetes-release/release/release-notes-index.json

The only blocker here seems that the above URL doesn't support CORS which is required to make AJAX calls from relnotes.k8s.io.

/assign @ashnehete

[xmudrii]

This is blocked by kubernetes/k8s.io#1810 (comment) until we don't move to the community GCP project.

[xmudrii]

/lifecycle frozen

[ashnehete]

I just realised that cdn.dl.k8s.io is enabled for CORS which means we can fetch release assets using this URL. Moreover, using the dl.k8s.io domain seems to be where the community is moving as a whole too.

I'm currently working on a PR for this in the release notes repo.

/lifecycle active

[ashnehete]

Now that the PR is merged and site is actively fetching notes from the remote, do we need to amend the release-notes team docs to stop them from creating a PR for each new release? Any code changes needed in the krel utility?

[saschagrunert]

Now that the PR is merged and site is actively fetching notes from the remote, do we need to amend the release-notes team docs to stop them from creating a PR for each new release? Any code changes needed in the krel utility?

Hm I don't think so, the release notes should be now populated automatically. 🤔