Azure / Azure/azure-functions-host

Add troubleshooting documentation for "Permission denied" errors

Open
#11,528 0 comments 0 reactions 0 assignees View on GitHub
supportability
Dominant language
C#
Stars
2k
Forks
482
Avg merge
2d 12h
Merged PRs (30d)
38

Description

If you deploy to Linux w/o read permissions to certain platform files like host.json/function.json, you can get an error like this:

`Access to path '/home/site/wwwroot/host.json' is deined. Permission denied.`

Most of our tooling should prevent this, but it is still possible to manually zip files with incorrect permissions.

We need to:
1. Add a note to our troubleshooting docs explaining what this error can mean and which files need to have read or execute permissions.
2. Add a DiagnosticEvent when we detect a permission error on any of the well-known files that we need to read (host.json, function.json). It may be tough to catch every situation, but getting a few in here on the well-known files would help customers self-mitigate.

Contributor guide

Open the contributing guide

Research direction

Locate the troubleshooting documentation and the permission checks for the well-known files host.json and function.json. First review how permission errors are detected and how DiagnosticEvent is emitted; done means the docs explain required read or execute permissions and relevant permission failures produce a DiagnosticEvent.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, linux
Domain
backend, documentation, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.