Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme with Host Release Information #666

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,36 @@ Build Status: [![Build Status](https://azure-functions.visualstudio.com/azure-fu

CoreTools Healthcheck: [![CoreTools healthcheck](https://azure-functions.visualstudio.com/azure-functions-docker/_apis/build/status/v3%20core-tools%20image%20health%20check?branchName=dev)](https://azure-functions.visualstudio.com/azure-functions-docker/_build/latest?definitionId=43&branchName=dev)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

# Host Release Information
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename the header to - Image update cadence


Azure-Functions-Docker/host Images :
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove?


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)).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is correct. All the officially supported languages - language workers as of now ship with Host

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


There are a variety of Host images that are released. All images contain everything necessary to run Azure-Functions-Host
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you mean base images?


-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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can generalize and mention something like - images that are optimized for running on AppService to enable Appservice features like ssh.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

be more explicit - Images with tags -appservice suffix are contain necessary configuration to support App Service Features


-slim images are built off of slim base images when possible



# Dockerfiles

Dockerfile artifacts are generated with each release version and uploaded alongside the release notes.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrase - Release artifacts here as an example


# Dockerhub

## V4 Images

See release artifacts for Dockerfiles - example : https://github.com/Azure/azure-functions-docker/releases/download/3.4.2/3.4.2-appservice.zip

#### Dotnet

`mcr.microsoft.com/azure-functions/dotnet`
Expand Down