azure-functions-core-tools - npm Package Compare versions

Comparing version 3.0.2630 to 3.0.2750

npm-shrinkwrap.json

 {
     "name": "azure-functions-core-tools",
-    "version": "3.0.2630",
+    "version": "3.0.2750",
     "lockfileVersion": 1,
@@ -5,0 +5,0 @@ "requires": true,

package.json

 {
     "name": "azure-functions-core-tools",
-    "version": "3.0.2630",
+    "version": "3.0.2750",
     "description": "Azure Functions Core Tools",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -19,3 +19,3 @@ ![Azure Functions Logo](https://raw.githubusercontent.com/Azure/azure-functions-cli/master/src/Azure.Functions.Cli/npm/assets/azure-functions-logo-color-raster.png)
 
-**v3**: Self-contained cross-platform package
+**v3**: (v3.x branch): Self-contained cross-platform package **(recommended)**
 
@@ -26,18 +26,36 @@ ## Installing
 
-To install runtime with npm:
+#### To download and install with MSI:
 
-**v2**
+##### 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:
+
+##### 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
 ```
 
-**v3**
+#### To install with chocolatey:
+
+##### v3
 ```bash
-npm i -g azure-functions-core-tools@3 --unsafe-perm true
+choco install azure-functions-core-tools-3
 ```
 
-To install with chocolatey:
+*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
+choco install azure-functions-core-tools-2
 ```
@@ -47,17 +65,17 @@
 
-**Homebrew**:
+#### Homebrew:
 
-**v2**
+##### v3
 ```bash
 brew tap azure/functions
-brew install azure-functions-core-tools@2
+brew install azure-functions-core-tools@3
 ```
 
-**v3**
+##### v2
 ```bash
 brew tap azure/functions
-brew install azure-functions-core-tools@3
+brew install azure-functions-core-tools@2
 ```
 
-Homebrew allow side by side installation of v2 and v3, you can switch between the versions using
+Homebrew allows side by side installation of v2 and v3, you can switch between the versions using
 ```bash
@@ -70,6 +88,10 @@ brew link --overwrite azure-functions-core-tools@3
 
-#### Ubuntu
+#### 1. Set up package feed
 
-1. Set up package feed
+##### 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
+```
 
@@ -104,8 +126,11 @@ ##### Ubuntu 19.04
 
-##### Debian 9
+##### Debian 9 / 10
 
 ```bash
+# set to 9 or 10
+DEBIAN_VERSION=10
+
 wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.asc.gpg
 sudo mv microsoft.asc.gpg /etc/apt/trusted.gpg.d/
-wget -q https://packages.microsoft.com/config/debian/9/prod.list
+wget -q https://packages.microsoft.com/config/debian/$DEBIAN_VERSION/prod.list
 sudo mv prod.list /etc/apt/sources.list.d/microsoft-prod.list
@@ -116,9 +141,16 @@ sudo chown root:root /etc/apt/trusted.gpg.d/microsoft.asc.gpg
 
-2. Install
+#### 2. Install
 
+##### v3
 ```bash
 sudo apt-get update
-sudo apt-get install azure-functions-core-tools
+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
@@ -128,30 +160,31 @@
 
-Download the latest release for your platform from [here](https://github.com/Azure/azure-functions-core-tools/releases).
+    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:
+    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
-```
+    ```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 executable. Assuming you used the instructions above to unzip:
+    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
-./func
-```
+    ```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:
+    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
-```
+    ```bash
+    export PATH=`pwd`:$PATH
+    func
+    ```
 
@@ -176,3 +209,3 @@ [Code and test Azure Functions locally](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local)
 
-This deploys [KEDA](https://github.com/kedacore/keda) and [Osiris](https://github.com/deislabs/osiris) to your cluster which allows you to deploy your functions in a scale-to-zero by default.
+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.
 
@@ -184,7 +217,6 @@ ```bash
 **KEDA:** Handles monitoring polling event sources currently QueueTrigger and ServiceBusTrigger.
-**Osiris:**: Handles Http traffic monitoring and on demand scale your deployment to and from 0
 
 ### Deploy to Kubernetes
 
-**First make sure you have Dockerfile for your project.** You can generate one using 
+**First make sure you have Dockerfile for your project.** You can generate one using
 ```bash
@@ -215,3 +247,3 @@ func init --docker # or --docker-only (for existing projects)
 
-* [Knative](https://github.com/knative/docs/tree/master/install/)
+* [Knative](https://github.com/knative/docs/tree/master/docs/install)
 
@@ -251,3 +283,3 @@ Deploying Azure Functions to knative is supported with the ```--platform knative``` flag.
 #### Login to the ACR Registry
-Before pushing and pulling container images, you must log in to the ACR instance. 
+Before pushing and pulling container images, you must log in to the ACR instance.
 
@@ -259,5 +291,5 @@ ```azurecli
 #### 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)  
+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 
+#### 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 <container_registry_name>.azurecr.io) and then your AKS cluster will use that as a source to obtain the container and deploy it.
@@ -274,3 +306,3 @@
 
-#### Verifying your deployment 
+#### 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.
@@ -277,0 +309,0 @@

No alert changes

Improved metrics

Total package byte prevSize

44493

increased by1.96%

Number of lines in readme file

351

increased by10.03%

No dependency changes