Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Azure/azure-functions-core-tools
Command line tools for Azure Functions
https://github.com/Azure/azure-functions-core-tools
azure-functions
Last synced: about 2 months ago
JSON representation
Command line tools for Azure Functions
- Host: GitHub
- URL: https://github.com/Azure/azure-functions-core-tools
- Owner: Azure
- License: mit
- Created: 2017-01-04T07:09:00.000Z (over 7 years ago)
- Default Branch: v4.x
- Last Pushed: 2024-07-31T20:49:44.000Z (about 2 months ago)
- Last Synced: 2024-08-01T02:59:32.119Z (about 2 months ago)
- Topics: azure-functions
- Language: C#
- Homepage:
- Size: 3.82 MB
- Stars: 1,286
- Watchers: 99
- Forks: 425
- Open Issues: 660
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-starred-test - Azure/azure-functions-core-tools - Command line tools for Azure Functions (C# #)
- awesome-dotnet - azure-functions-core-tools - Command line tools to provide a local development experience for creating, developing, testing, running, and debugging Azure Functions. (Libraries, Frameworks and Tools / Tools)
README
|Branch|Status|
|---|---|
|v4.x|[](https://azfunc.visualstudio.com/Azure%20Functions/_build/latest?definitionId=11&branchName=v4.x)|
|v3.x|[](https://azfunc.visualstudio.com/Azure%20Functions/_build/latest?definitionId=11&branchName=v3.x)|
|dev|[](https://azfunc.visualstudio.com/Azure%20Functions/_build/latest?definitionId=11&branchName=dev)
|v1.x|[](https://azfunc.visualstudio.com/Azure%20Functions/_build/latest?definitionId=11&branchName=v1.x)|
# Azure Functions Core Tools
The Azure Functions Core Tools provide a local development experience for creating, developing, testing, running, and debugging Azure Functions.
## Versions
**v1** (v1.x branch): Requires .NET 4.7.1 Windows Only
**v2** (dev branch): Self-contained cross-platform package
**v3**: (v3.x branch): Self-contained cross-platform package
**v4**: (v4.x branch): Self-contained cross-platform package **(recommended)**
## Installing
### Windows
#### To download and install with MSI:
##### v4
- [Windows 64-bit](https://go.microsoft.com/fwlink/?linkid=2174087) (VS Code debugging requires 64-bit)
- [Windows 32-bit](https://go.microsoft.com/fwlink/?linkid=2174159)
##### v3
- [Windows 64-bit](https://go.microsoft.com/fwlink/?linkid=2135274) (VS Code debugging requires 64-bit)
- [Windows 32-bit](https://go.microsoft.com/fwlink/?linkid=2135275)
#### To install with npm:
##### v4
```bash
npm i -g azure-functions-core-tools@4 --unsafe-perm true
```
##### v3
```bash
npm i -g azure-functions-core-tools@3 --unsafe-perm true
```
##### v2
```bash
npm i -g azure-functions-core-tools@2 --unsafe-perm true
```
#### To install with chocolatey:
##### v4
```bash
choco install azure-functions-core-tools
```
##### v3
```bash
choco install azure-functions-core-tools-3
```
*Notice: To debug functions under vscode, the 64-bit version is required*
```bash
choco install azure-functions-core-tools-3 --params "'/x64'"
```
##### v2
```bash
choco install azure-functions-core-tools-2
```
#### To install with winget:
##### v4
```bash
winget install Microsoft.Azure.FunctionsCoreTools
```
##### v3
```bash
winget install Microsoft.Azure.FunctionsCoreTools -v 3.0.3904
```
### Mac
#### Homebrew:
##### v4
```bash
brew tap azure/functions
brew install azure-functions-core-tools@4
```
##### v3
```bash
brew tap azure/functions
brew install azure-functions-core-tools@3
```
##### v2
```bash
brew tap azure/functions
brew install azure-functions-core-tools@2
```
Homebrew allows side by side installation of v2 and v3, you can switch between the versions using
```bash
brew link --overwrite azure-functions-core-tools@3
```
### Linux
#### 1. Set up package feed
##### Ubuntu 22.04
```bash
wget -q https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
```
##### Ubuntu 20.04
```bash
wget -q https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
```
##### Ubuntu 19.04
```bash
wget -q https://packages.microsoft.com/config/ubuntu/19.04/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
```
##### Ubuntu 18.10
```bash
wget -q https://packages.microsoft.com/config/ubuntu/18.10/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
```
##### Ubuntu 18.04
```bash
wget -q https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
```
##### Ubuntu 16.04 / Linux Mint 18
```bash
wget -q https://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
```
##### Debian 12
```bash
export DEBIAN_VERSION=12
apt-get update && apt-get install gpg wget -y
wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor | tee /usr/share/keyrings/microsoft-prod.gpg
wget -q https://packages.microsoft.com/config/debian/$DEBIAN_VERSION/prod.list
mv prod.list /etc/apt/sources.list.d/microsoft-prod.list
chown root:root /usr/share/keyrings/microsoft-prod.gpg
chown root:root /etc/apt/sources.list.d/microsoft-prod.list
apt-get update && apt-get install azure-functions-core-tools-4 -y
apt-get update && apt-get install libicu-dev -y
```
#### 2. Install
##### v4
```bash
sudo apt-get update
sudo apt-get install azure-functions-core-tools-4
```
##### v3
```bash
sudo apt-get update
sudo apt-get install azure-functions-core-tools-3
```
##### v2
```bash
sudo apt-get update
sudo apt-get install azure-functions-core-tools-2
```
#### Other Linux Distributions
1. Download latest release
Download the latest release for your platform from [here](https://github.com/Azure/azure-functions-core-tools/releases).
2. Unzip release zip
Using your preferred tool, unzip the downloaded release. To unzip into an `azure-functions-cli` directory using the `unzip` tool, run this command from the directory containing the downloaded release zip:
```bash
unzip -d azure-functions-cli Azure.Functions.Cli.linux-x64.*.zip
```
3. Make the `func` command executable
Zip files do not maintain the executable bit on binaries. So, you'll need to make the `func` binary, as well as `gozip` (used by func during packaging) executables. Assuming you used the instructions above to unzip:
```bash
cd azure-functions-cli
chmod +x func
chmod +x gozip
./func
```
4. Optionally add `func` to your `$PATH`
To execute the `func` command without specifying the full path to the binary, add its directory to your `$PATH` environment variable. Assuming you're still following along from above:
```bash
export PATH=`pwd`:$PATH
func
```
[Code and test Azure Functions locally](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local)
**NOTE**: npm can be used on all platforms. On unix platforms, you may need to specify `--unsafe-perm` if you are running npm with sudo. That's due to npm behavior of post install script.
## Getting Started on Kubernetes
Using the Core Tools, you can easily configure a Kubernetes cluster and run Azure Functions on it.
### Prerequisites
* [Docker](https://docs.docker.com/install/)
* [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
### Installing Kubernetes scalers
This deploys [KEDA](https://github.com/kedacore/keda) to your cluster which allows you to deploy your functions in a scale-to-zero by default for non-http scenarios only.
```bash
func kubernetes install --namespace {namespace}
```
**KEDA:** Handles monitoring polling event sources currently QueueTrigger and ServiceBusTrigger.
### Deploy to Kubernetes
**First make sure you have Dockerfile for your project.** You can generate one using
```bash
func init --docker # or --docker-only (for existing projects)
```
Then to deploy to kubernetes
```bash
func kubernetes deploy \
--name myfunction \
--namespace functions-ns \
--registry
```
This will build the current `Dockerfile` and push the image to the registry specified, then deploys a `Secret`, `Deployment`, and `ScaledObject`. If your functions have httpTrigger, you'll get an additional `Deployment` and `Service`.
### Deploy using a private registry
```bash
func kubernetes deploy --name myfunction --registry --pull-secret
```
### Deploy a function to Knative
#### Prerequisites
* [Knative](https://github.com/knative/docs/tree/master/docs/install)
Deploying Azure Functions to knative is supported with the ```--platform knative``` flag.
The Core Tools CLI identifies non HTTP trigger functions and annotates the knative manifest with the the ```minScale``` annotation to opt out of scale-to-zero.
```bash
func deploy --platform knative --name myfunction --registry
```
### Deploying a function to AKS using ACR
Using the configuration options an Azure Function app can also be deployed to a [AKS](https://azure.microsoft.com/en-us/services/kubernetes-service/) (Azure Kubernetes Service) Kubernetes cluster and use [ACR](https://azure.microsoft.com/en-us/services/container-registry/) as the registry server. Do all of the following *before* you run the deployment command.
#### Create a AKS cluster
You can create an AKS cluster using the [Azure Portal](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal) or using [Azure CLI](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough).
Once your AKS cluster is created make sure that you can access it using kubectl. To make kubectl run in the context of your cluster, configure a connection using the command below.
```azurecli
az aks get-credentials \
--name FunctionsCluster \
--resource-group
```
To verify the connection to your cluster run the following command
```bash
> kubectl get nodes
NAME STATUS ROLES AGE VERSION
aks-agentpool-20257154-0 Ready agent 1d v1.11.5
aks-agentpool-20257154-1 Ready agent 1d v1.11.5
aks-agentpool-20257154-2 Ready agent 1d v1.11.5
```
#### Create a ACR Registry
An ACR instance can be created using the Azure Portal or the [Azure CLI](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-get-started-azure-cli#create-a-container-registry)
#### Login to the ACR Registry
Before pushing and pulling container images, you must log in to the ACR instance.
```azurecli
az acr login --name
```
#### Give the AKS cluster access to the ACR Registry
The AKS cluster needs access to the ACR Registry to pull the container. Azure creates a service principal to support cluster operability with other Azure resources. This can be used for authentication with an ACR registry. See here for how to grant the right access here: [Authenticate with Azure Container Registry from Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-auth-aks)
#### Run the deployment
The deployment will build the docker container and upload the container image to your referenced ACR instance (Note: Specify the ACR Login Server in the --registry parameter this is usually of the form .azurecr.io) and then your AKS cluster will use that as a source to obtain the container and deploy it.
```bash
func kubernetes deploy --name myfunction --registry
```
If the deployment is successful, you should see this:
Function deployed successfully!
Function IP: 40.121.21.192
#### Verifying your deployment
You can verify your deployment by using the Kubernetes web dashboard. To start the Kubernetes dashboard, use the [az aks browse](https://docs.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-browse) command.
```azurecli
az aks browse --resource-group myResourceGroup --name myAKSCluster
```
In the Kubernetes dashboard look for the namespace "azure-functions" and make sure that a pod has been deployed sucessfully with your container.
### Deploying Azure Functions with Virtual-Kubelet
Azure Functions running on Kubernetes can take advantage of true serverless containers model by getting deployed to different providers of [Virtual Kubelet](https://github.com/virtual-kubelet/virtual-kubelet), such as Azure Container Instances.
Functions deployed to Kubernetes already contain all the tolerations needed to be schedulable to Virtual Kubelet nodes.
All you need to do is to set up VKubelet on your Kubernetes cluster:
* [Install VKubelet with ACI](https://github.com/virtual-kubelet/azure-aci)
* [Install VKubelet with ACI on AKS](https://docs.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-connector)
*Important note:*
Virtual Kubelet does not currently allow for Kubernetes Services to route external traffic to pods.
This means that HTTP triggered functions will not receive traffic running on a VKubelet provider (including ACI).
A good usage scenario for using functions with VKubelet would be with event triggered / time triggered functions that do not rely on external HTTP traffic.
## Known Issues:
`func extensions` command require the `dotnet` cli to be installed and on your path. This requirement is tracked [here](https://github.com/Azure/azure-functions-core-tools/issues/367). You can install .NET Core for your platform from https://www.microsoft.com/net/download/
## Default Directories
* `CurrentDirectory`: is the default directory the functions runtime looks for functions in.
* `%TMP%\LogFiles\Application\Functions`: is the default directory for logs. It mirrors the logs directory on Azure as well.
## Telemetry
The Azure Functions Core tools collect usage data in order to help us improve your experience.
The data is anonymous and doesn't include any user specific or personal information. The data is collected by Microsoft.
You can opt-out of telemetry by setting the `FUNCTIONS_CORE_TOOLS_TELEMETRY_OPTOUT` environment variable to '1' or 'true' using your favorite shell.
[Microsoft privacy statement](https://privacy.microsoft.com/en-US/privacystatement)
## License
This project is under the benevolent umbrella of the [.NET Foundation](http://www.dotnetfoundation.org/) and is licensed under [the MIT License](LICENSE)
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Contact Us
For questions on Azure Functions or the tools, you can ask questions here:
- [Azure Functions Q&A Forum](https://docs.microsoft.com/en-us/answers/topics/azure-functions.html)
- [Azure-Functions tag on StackOverflow](http://stackoverflow.com/questions/tagged/azure-functions)
File bugs at [Azure Functions Core Tools repo on GitHub](https://github.com/Azure/azure-functions-core-tools/issues).