A Spin Azure Kubernetes Service plugin with cloud provider support. This will make getting Spin applications onto AKS extremely easy and will support everything 99% of applications need. Applications can be triggered by either HTTP(s) or pub-sub (through Redis). Backend databases will be supported by either Azure Cosmos or Azure Redis. Secrets are supported through Azure KeyVault. Because applications are limited* by the Spin ecosystem and powered by the cross-platform nature of Web Assembly this tool can realistically be a straightforward user experience.
*limited isn't the right word for this. The fact that the Spin ecosystem scopes down the things a user can do and forces them through the Spin way makes it truly possible to make a "managed" experience versus just containers are extremely hard to simplify due to the infinite number options (language, build tools, platform tooling like databases, are all solved by boxing to Spin ecosystem).
We use the azidentity DefaultAzureCredential to authenticate to the Azure SDKs. This will leave users with different options for configuration that match other Azure tooling. Some of the options users will ahve include az login (az cli) and env variables.
Stores a "state" in $(DATA_DIR)/spin/plugins/aks/state. This follows the Spin model described here.
State that's stored includes the following
- Subscription, resource group, cluster name of most recently selected cluster
- Subscription, resource group, cluster name of most recently selected container registry
- Registry, image name, tag of most recently deployed image per application
- Last used spin aks config path
State will primarily be used to autofill prompts as intelligently as possible. This will allow most users to simply press "enter" through the prompts but also allows more advanced cases to customize usage.
A config file is where this plugin will read values from.
This file by default will be called aks-spin.toml but can be another toml file that's referenced by the global -c of --config flag. This allows for users to have different "environments".
Users will be prompted for various Azure resources when using the cli. The CLI will provide an additional option for creating resources as well.
For example, if a user is asked for an AKS cluster we give them the option to select one but also give them the option to create a new default one.
Any user input should be possible through a CLI flag so that this can be completely consumed by CI/CD.
This plugin will be compatible with all spin versions 1.x.x
Walks users through creating a new spin aks config.
Asks for
- config filename + location (will be autofilled as the default of
./spin-aks.tomlso most users just have to press enter) - cluster name (subscription, rg, name)
- acr name (subscription, rg, name)
- spin.toml file location (tries to detect automatically)
Functions like spin build but also ensures that current Spin application will work for AKS (not all Spin versions are compatible, Spin version should be 1.x.x). Builds the .wasm files needed for the docker image.
Creates the dockerfile. See the other scaffold command below for more information. Dockerfile is by default output to ./Dockerfile (with root being where the command is run).
Flags
--dockerfile-destchanges the destination of the Dockerfile. Filename can be included here but defaults to Dockerfile.--overrideoverrides existing files without prompts. By default the cli prompts.-yaccepts all defaults meaning the cli won't prompt.-cor--configspecifies the aks spin toml file location. Defaults to ./aks-spin.toml.--cosmosindicates that user wants to use cosmos. Can also specify this in the aks spin config.
Ensure that the redis address is a secret. See more under scaffold command for more info.
If cosmos is needed user selects a cosmos instance (or is prompted to make one). https://developer.fermyon.com/spin/dynamic-configuration#key-value-store-runtime-configuration runtime configuration will be created for the user. A secret variable will be added to the spin.toml indicating the cosmos key. TODO: we need to verify that spin variables can be injected into this from the environment. If they can't we should add this to upstream.
User selects they are pushing to acr or another registry.
Builds and pushes docker container to registry.
Stores the image tag in the aks spin toml config.
Creates manifests. Should give option of Helm, Kustomize, Kube. Helm output to ./charts/, Kustomize output to ./base and ./overlays, and normal K8s files to ./manifests/.
Flags
--k8s-destchanges the destination of Kustomize, Kube, or Helm files.-t or --typechooses the type of k8s files. Options are Helm, Kustomize, and Kube.--overrideoverrides existing files without prompts. By default the cli prompts.-yaccepts all defaults meaning the cli won't prompt.-cor--configspecifies the aks spin toml file location. Defaults to ./aks-spin.toml.
If there's already helm files or kustomize files we merge our additions with the existing files.
If we have already created these files, the cli handles updating them to the "latest versions".
Included in the manifests is a KWASM deployment along with deployments + services for the spin application.
Checks the spin.toml variables https://developer.fermyon.com/spin/manifest-reference#the-variables-table. If it's a secret, the user is prompted to select a keyvault secret for this (or is given the option to create a kv secret). Secrets will use the aks kv csi driver to load secrets into the spin application pod. These need to be mounted by the pod according to the csi driver spec (even though we are only using them as env variables in the pod). This will be represented in generated manifests. Secret locations will be stored in the spin aks toml config.
If a spin variable isn't a secret it's configured directly through plaintext env variables on the deployment.
If the trigger is redis, ensure the address is a spin variable secret. If it's not we should prompt user and update to one. When we update to one, make the default their current value. https://developer.fermyon.com/spin/redis-trigger#specifying-an-application-as-redis. We ask the user for the select an Azure Cache for Redis instance and ensure all channels are properly set up on that redis instance. We set the address secret to the redis instance and create a kv secret for it (following the normal secret workflow).
The Dockerfile and k8s file locations are stored in the aks spin toml.
If variable isn't a secret updates the plaintext env variable representing the secret in the k8s files.
Updates a variable in the keyvault if the variable is a secret. TODO: need to figure out the secret autorotation strategy in a future iteration.
Applies manifests to the k8s cluster. Also ensures cluster has permission to access acr, if not it prompts to attach.
If secrets are used by the application then we prompt them to install the keyvault csi driver addon. Also prompt to attach the keyvault to the cluster addon identity so we can pull the secrets.
Doesn't support private clusters for now. We can in the future pretty easily thanks to az aks command invoke.
https://helm.sh/docs/topics/advanced/#go-sdk
https://pkg.go.dev/sigs.k8s.io/kustomize/api/krusty#Kustomizer
Goes through all steps to ensure your application is running. This is one command for all the things mentioned above.
All steps are idempotent and these commands can be used to update what's running in the cluster to a new application version.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.