Skip to content

Starter kit demonstrating how to use the Fastly KV store from within a Rust-based Fastly compute project.

License

Notifications You must be signed in to change notification settings

fastly/compute-starter-kit-rust-kv-store

Repository files navigation

Compute Starter Kit Rust KV Store

Fastly KV Store is a globally consistent key-value storage accessible across the Fastly Network. This makes it possible for your Compute@Edge application to read and write from KV-stores. The application shows how to use Fastly KV Store within a Rust Compute@Edge application.

For more details about other starter kits for Compute@Edge, see the Fastly developer hub

Understanding the code

A single main function is defined which uses the #[fastly::main] macro, this is the function that recieves the incoming Request and returns a Result<Response>, which will be sent to the user-agent.

Deploying the project to Fastly

Note that Fastly Services have to have unique names within a Fastly Account.

To create and deploy to a new Fastly Service run the command and follow the instructions:

fastly compute publish

Creating and attaching the KV Store

This project makes use of a resource called a KV Store, and this starter kit takes care of a few prerequisites for you:

  • creating a KV Store
  • linking the KV store to your service upon deployment
  • creating a mock-up of a KV Store that your service may access when running locally via fastly compute serve

These tasks are handled using the [setup] and [local_server] sections of the fastly.toml file included with this starter kit.

In general, when using KV Stores, you'll need to take care of these things. The Fastly CLI and UI provide interfaces for these activities.

fastly kv-store create --name="my-store"

KV Stores are accessible by multiple Fastly services (this is part of the power of KV Stores!). You need to grant access to your KV Store to your service. To do this, you need to know your Service ID and your KV Store ID. To get the KV Store ID, use the kv-store subcommand.

fastly kv-store list

Then, link the KV Store to a new clone of your service, using the KV Store ID and Service ID, and activate the new version.

fastly resource-link create --resource-id=RESOURCE-ID --service-id=SERVICE-ID --version=latest --autoclone
fastly service-version activate --version=latest --service-id=SERVICE-ID

That is it, we now have a Fastly Service, a Fastly KV Store and have them linked together!

You can view real-time logs for the Fastly Service by running:

fastly log-tail

Adding entries to the KV Store

It is possible to add key-value pairs to an KV Store using the Fastly CLI like so:

fastly kv-store-entry create --store-id=$FASTLY_KV_STORE_ID --key-name=$KEY --value=$VALUE

For example, here is how you could add to the KV Store named my-store a key named readme whose value is the contents of README.md:

fastly kv-store-entry create --store-id="$(fastly kv-store list --json | jq -r '.Data[]|select(.Name=="my-store").ID')" --key-name="readme" --value="$(cat README.md)"

Security issues

Please see our SECURITY.md for guidance on reporting security-related issues.

About

Starter kit demonstrating how to use the Fastly KV store from within a Rust-based Fastly compute project.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Contributors 6

Languages