GitHub - linkerd/website: Source code for the linkerd.io website (original) (raw)

Source code for the linkerd.io website.

View the linkerd.io READMEto learn about general development instructions.

run.linkerd.io

Install scripts for linkerd as well as demo applications such asemojivoto.

versioncheck.linkerd.io

Location for existing installations to check and see if they're up to date or not.

To build and serve against the latest Linkerd2 release:

make serve-versioncheck.linkerd.io

api.linkerd.io

API docs for linkerd1.

Note: this does not deploy by default as part of make publish. It needs to be released separately.

See slate documentation ./build will grab whatever's on main from slate-linkerd and add it to the public dir.

Creating a new release

1. Run ./release-next-version <release-tag> <new version> inhttps://github.com/BuoyantIO/slate-linkerd/blob/master/BUOYANT-README.md
2. Then check locally
   make serve-api.linkerd.io
3. Finally push to production
   make deploy-api.linkerd.io
   • NB: If you're running macOS 10.14+ with ruby installed by XCode, you may have to set the SDKROOTin order to install json 1.8.3 which is a middleman dependency.

Publishing

1. Make sure your gcloud tooling is up to date:
   gcloud components update
   gcloud auth login
2. Do a dry run and make sure everything works:
   make publish DRY_RUN=true
3. Update the website:

Notes

• This does not update api.linkerd.io, see the section for that specifically to update it.
• There is no caching in front of run.linkerd.io and versioncheck.linkerd.io. You should see updates there immediately.
• There is caching for non-html pages in front of linkerd.io. If you're updating a non-html page for linkerd.io, it might be worth flushing the cache (cloudflare) and waiting awhile.

If you have to create a new bucket

You probably won't have to do this, but if you do, don't forget to do this stuff too to set up the bucket for public serving:

gsutil defacl ch -u AllUsers:R gs://bucketname gsutil web set -m index.html -e 404.html gs://bucketname

Verifying cache updates

Turn off all caching on all files:

gsutil -m setmeta -r -h "Cache-Control: no-cache, no-store, must-revalidate" gs://linkerd.io/

Turn caching back on:

gsutil -m setmeta -r -h "Cache-Control:" gs://linkerd.io/

Enable access logs (should only need to be run once)

gsutil logging set on -b gs://linkerd2-access-logs -o AccessLog gs://linkerd.io

Get access logs

note: this will download ALL logs. probably not what you want.

gsutil -m rsync gs://linkerd2-access-logs logs/

Set CORS policy (should only need to be run once)

gsutil cors set versioncheck.linkerd.io.cors.json gs://versioncheck.linkerd.io