PowerShell / PowerShell/PowerShell-Docker
Add `entrypoint` routing, which supports routing string-based commands to different executables, with special logic for `pwsh`
@TravisEz13 is already working on this.
Since Mar 27, 2020.
- Dominant language
- Dockerfile
- Stars
- 449
- Forks
- 158
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 1
Description
Goal
Add entrypoint routing, which supports routing string-based commands to different executables, with special logic for pwsh. In order to:
- Provide actionable error messages. Users should know that the entrypoint syntax they used failed in PowerShell, in Bash (or other shell), or in the script itself.
- Support on Linux and Windows (a number of these appear like general concerns, not Linux-specific).
- This avoids needing to
- use the
--entrypointsyntax to specify an executable, and - split the
entrypoint(an argument to docker run) from its arguments (arguments to the container; they show up last).
- use the
Background
The best practice in docker is for an image to run the product in contains.
https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#entrypoint
Currently our images only run PowerShell when no command is specified. This is specified in the CMD entry in the Dockerfile.
Unfortunately, making the change causes a breaking change to the image in what is hopefully a corner case.
Customer requests for this are in #274 and #394
Proof of concept is here: https://github.com/PowerShell/PowerShell-Docker/pull/399
Other Language images
- Work similar to the proposal
- php
- node
- Like our current image
- perl (perldebug)
- python
- Dumps you in bash
- golang
Proposal
- Add a shell script that will detect if you are running pwsh (or similar), if so, send it to bash, otherwise run
pwsh -nologo -l -c "$@" - set that script as the
ENTRYPOINT - Set
CMDto[ "pwsh" ]
- Maintain the most features
- Achieves the goals of the best practices
New Scenario
Note the lack of pwsh -c.
docker run --rm mcr.microsoft.com/powershell:7.1.0-preview.1-ubuntu-18.04 '$psversiontable.PSVersion.ToString()'
Will continue to work
docker run --rm mcr.microsoft.com/powershell:7.1.0-preview.1-ubuntu-18.04 pwsh -c '$psversiontable.PSVersion.ToString()'
Breaking change
Scenario - Running PowerShell using container
Working command with current images
docker run --rm mcr.microsoft.com/powershell:7.1.0-preview.1-ubuntu-18.04 /opt/microsoft/powershell/7-preview/pwsh -c '$psversiontable.PSVersion.ToString()'
Scenario - Expected result (with current image)
7.1.0-preview.1
Actual result (with private build with change)
ParserError:
Line |
1 | 7.1.0-preview.1
| ~~~~~~~~
| Unexpected token '-preview' in expression or statement.
Workaround
Use --% to prevent the new PowerShell entrypoint from parsing the command.
docker run --rm mcr.microsoft.com/powershell:7.1.0-preview.1-ubuntu-18.04 /opt/microsoft/powershell/7-preview/pwsh --% -c '$psversiontable.PSVersion.ToString()'
Entry point script - Ubuntu
#!/bin/sh
set -e
# first arg is `pwsh` or similar
if ! { [ $1 = 'pwsh' ] || [ $1 = 'pwsh-preview' ]; }; then
set -- pwsh -nologo -l -c "$@"
fi
exec "$@"
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.