Update Readme with Host Release Information #666
Conversation
Including information to contextualize the Dockerhub tables in the readme. Release info as well as links to docs and instructions on using the repo
CooperLink
requested review from
anirudhgarg,
vrdmr,
divyagandhisethi,
balag0,
pragnagopa and
ahmelsayed
as code owners
|
|
||
| Azure-Functions-Docker/host Images : | ||
|
|
||
| Azure-Functions-Docker releases Linux Container Images for Azure-Functions-Host. These images consist of the[ Azure-Functions-Host](https://github.com/Azure/azure-functions-host), [Extension Bundles](https://github.com/Azure/azure-functions-extension-bundles), and a language worker (ex. [Powershell-Worker](https://github.com/Azure/azure-functions-powershell-worker)). |
There was a problem hiding this comment.
I think functions host automatically brings in some other language workers as well
Ex: Azure/azure-functions-host@9cf4d03#diff-c0ba1fae310774f3dc1bf6b5919e9f9b9bafb76ec834ae9c3a372a196ce62a3f
(dont have the complete list)
There was a problem hiding this comment.
That is correct. All the officially supported languages - language workers as of now ship with Host
|
|
||
| There are a variety of Host images that are released. All images contain everything necessary to run Azure-Functions-Host | ||
|
|
||
| Images without a suffix are the basic image |
|
|
||
| Images without a suffix are the basic image | ||
|
|
||
| -appservice images enable SSH on the Functions-Host container as described for App-Services here : https://docs.microsoft.com/en-us/azure/app-service/configure-linux-open-ssh-session |
There was a problem hiding this comment.
I think we can generalize and mention something like - images that are optimized for running on AppService to enable Appservice features like ssh.
| @@ -2,12 +2,36 @@ Build Status: [](https://azure-functions.visualstudio.com/azure-functions-docker/_build/latest?definitionId=43&branchName=dev) | |||
|
|
|||
There was a problem hiding this comment.
Add introduction text here - This repo contains docker files that enable running Azure Function Apps in Docker Containers , add hyperlink to Azure Function Apps - pointing to https://azure.microsoft.com/en-us/services/functions/#overview
| @@ -2,12 +2,36 @@ Build Status: [](https://azure-functions.visualstudio.com/azure-functions-docker/_build/latest?definitionId=43&branchName=dev) | |||
|
|
|||
| # Host Release Information | |||
There was a problem hiding this comment.
rename the header to - Image update cadence
| @@ -2,12 +2,36 @@ Build Status: [](https://azure-functions.visualstudio.com/azure-functions-docker/_build/latest?definitionId=43&branchName=dev) | |||
|
|
|||
| # Host Release Information | |||
|
|
|||
| Azure-Functions-Docker/host Images : | |||
|
|
||
| Azure-Functions-Docker/host Images : | ||
|
|
||
| Azure-Functions-Docker releases Linux Container Images for Azure-Functions-Host. These images consist of the[ Azure-Functions-Host](https://github.com/Azure/azure-functions-host), [Extension Bundles](https://github.com/Azure/azure-functions-extension-bundles), and a language worker (ex. [Powershell-Worker](https://github.com/Azure/azure-functions-powershell-worker)). |
There was a problem hiding this comment.
Rephrase from
Azure-Functions-Docker releases Linux Container Images for Azure-Functions-Host. These images consist of the Azure-Functions-Host, Extension Bundles, and a language worker (ex. Powershell-Worker).
to
Docker files in this repo include
-
Language workers to execute functions in following supported languages
-
Runtime needed for the supported language
|
|
||
| Azure-Functions-Docker releases Linux Container Images for Azure-Functions-Host. These images consist of the[ Azure-Functions-Host](https://github.com/Azure/azure-functions-host), [Extension Bundles](https://github.com/Azure/azure-functions-extension-bundles), and a language worker (ex. [Powershell-Worker](https://github.com/Azure/azure-functions-powershell-worker)). | ||
|
|
||
| Host images have an expected release cadence of once a month. These images are available at the Microsoft Container Registry links visible below. Versions 3 and 4 are currently being updated in parallel. Major Version images, those beginning in :3.0 or :4, are the preferred images and will always host the latest released versions after thorough testing and verification. Customers that need a custom image should follow [this documentation for building a custom image](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-function-linux-custom-image). |
There was a problem hiding this comment.
Rephrase - Azure Functions Host is released on a monthly cadence to Azure. Please see release notes for each Functions Host release here: https://github.com/Azure/azure-functions-host/releases. Watch App Services Announcement Repo for latest updates on Azure Functions Host releases to Azure
|
|
||
| Host images have an expected release cadence of once a month. These images are available at the Microsoft Container Registry links visible below. Versions 3 and 4 are currently being updated in parallel. Major Version images, those beginning in :3.0 or :4, are the preferred images and will always host the latest released versions after thorough testing and verification. Customers that need a custom image should follow [this documentation for building a custom image](https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-function-linux-custom-image). | ||
|
|
||
| There are a variety of Host images that are released. All images contain everything necessary to run Azure-Functions-Host |
There was a problem hiding this comment.
Rephrase - This repo contains various flavors for dockerfiles .
Insert table here with columns Tag , Description -> add row for 3.0tags and another row for 4 tag
|
|
||
| Images without a suffix are the basic image | ||
|
|
||
| -appservice images enable SSH on the Functions-Host container as described for App-Services here : https://docs.microsoft.com/en-us/azure/app-service/configure-linux-open-ssh-session |
There was a problem hiding this comment.
be more explicit - Images with tags -appservice suffix are contain necessary configuration to support App Service Features
|
|
||
| Release notes for v4.3.0 release : https://github.com/Azure/azure-functions-docker/releases/tag/4.3.0 | ||
|
|
||
| Artifacts can be downloaded directly here : https://github.com/Azure/azure-functions-docker/releases/download/4.3.0/4.3.0-appservice.zip |
There was a problem hiding this comment.
Rephrase - Release artifacts here as an example
CooperLink
requested review from
TsuyoshiUshio,
VpOfEngineering,
amamounelsayed and
Tonewall
as code owners
Including information to contextualize the Dockerhub tables in the readme. Release info as well as links to docs and instructions on using the repo
Releasing new Host versions.
V3 Release
V2 Release
PR information