From 8c76679050eda2c7caff4f070561bf9101cd7adc Mon Sep 17 00:00:00 2001 From: Chuck Lantz Date: Wed, 11 Dec 2019 19:00:06 +0000 Subject: [PATCH] Updates for 1.41 --- .devcontainer/Dockerfile | 22 +++++++++++++++++----- .devcontainer/devcontainer.json | 26 +++++++++++++------------- README.md | 24 ++++++++++++++++++------ 3 files changed, 48 insertions(+), 24 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index e5beaa7..7a7804e 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -8,27 +8,39 @@ FROM python:3 # Avoid warnings by switching to noninteractive ENV DEBIAN_FRONTEND=noninteractive -# Or your actual UID, GID on Linux if not the default 1000 +# This Dockerfile adds a non-root user with sudo access. Use the "remoteUser" +# property in devcontainer.json to use it. On Linux, the container user's GID/UIDs +# will be updated to match your local UID/GID (when using the dockerFile property). +# See https://aka.ms/vscode-remote/containers/non-root-user for details. ARG USERNAME=vscode ARG USER_UID=1000 ARG USER_GID=$USER_UID +# Uncomment the following COPY line and the corresponding lines in the `RUN` command if you wish to +# include your requirements in the image itself. It is suggested that you only do this if your +# requirements rarely (if ever) change. +# COPY requirements.txt /tmp/pip-tmp/ + # Configure apt and install packages RUN apt-get update \ && apt-get -y install --no-install-recommends apt-utils dialog 2>&1 \ # # Verify git, process tools, lsb-release (common in install instructions for CLIs) installed - && apt-get -y install git procps lsb-release \ + && apt-get -y install git iproute2 procps lsb-release \ # # Install pylint && pip --disable-pip-version-check --no-cache-dir install pylint \ # + # Update Python environment based on requirements.txt + # && pip --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \ + # && rm -rf /tmp/pip-tmp \ + # # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user. && groupadd --gid $USER_GID $USERNAME \ && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \ - # [Optional] Add sudo support for non-root user + # [Optional] Add sudo support for the non-root user && apt-get install -y sudo \ - && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \ + && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\ && chmod 0440 /etc/sudoers.d/$USERNAME \ # # Clean up @@ -37,6 +49,6 @@ RUN apt-get update \ && rm -rf /var/lib/apt/lists/* # Switch back to dialog for any ad-hoc use of apt-get -ENV DEBIAN_FRONTEND= +ENV DEBIAN_FRONTEND=dialog diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 71da354..9ed987f 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,29 +1,29 @@ { - "name": "Python Sample", + "name": "Python 3", + "context": "..", "dockerFile": "Dockerfile", - // Use 'appPort' to create a container with published ports. If the port isn't working, be sure - // your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost. - // In this case, "--host 0.0.0.0 --port 9000" needs to be passed into Flask to make this happen. - "appPort": [9000], - - // Comment out the next line to run as root instead. Linux users, - // update Dockerfile with your user's UID/GID if not 1000. - "runArgs": ["-u", "vscode"], - // Use 'settings' to set *default* container specific settings.json values on container create. // You can edit these settings after create using File > Preferences > Settings > Remote. "settings": { "terminal.integrated.shell.linux": "/bin/bash", "python.pythonPath": "/usr/local/bin/python", + "python.linting.enabled": true, "python.linting.pylintEnabled": true, - "python.linting.pylintPath": "/usr/local/bin/pylint", - "python.linting.enabled": true + "python.linting.pylintPath": "/usr/local/bin/pylint" }, - // Specifies a command to run after the container is created + // Use 'appPort' to create a container with published ports. If the port isn't working, be sure + // your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost. + "appPort": [ 9000 ], + + // Install flask and any other dependencies "postCreateCommand": "sudo pip install -r requirements.txt", + // Comment out next line to run as root + "remoteUser": "vscode", + + // Add the IDs of extensions you want installed when the container is created in the array below. "extensions": [ "ms-python.python" ] diff --git a/README.md b/README.md index c6638aa..3350191 100644 --- a/README.md +++ b/README.md @@ -10,25 +10,34 @@ Follow these steps to open this sample in a container: 1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started). -2. **Linux users:** Update `USER_UID` and `USER_GID` in `.devcontainer/Dockerfile` with your user UID/GID if not 1000 to avoid creating files as root. +2. To use this repository, you can either open a locally cloned copy of the code: -3. If you're not yet in a development container: - - Clone this repository. + - Clone this repository to your local filesystem. - Press F1 and select the **Remote-Containers: Open Folder in Container...** command. - Select the cloned copy of this folder, wait for the container to start, and try things out! - + + Or open the repository in an isolated Docker volume: + + - Press F1 and select the **Remote-Containers: Try a Sample...** command. + - Choose the "Node" sample, wait for the container to start and try things out! + > **Note:** Under the hood, this will use **Remote-Containers: Open Repository in Container...** command to clone the source code in a Docker volume instead of the local filesystem. + ## Things to try Once you have this sample opened in a container, you'll be able to work with it like you would locally. -> **Note:** This container runs as a non-root user with sudo access by default. Comment out `"runArgs": ["-u", "vscode"]` in `.devcontainer/devcontainer.json` if you'd prefer to run as root. +> **Note:** This container runs as a non-root user with sudo access by default. Comment out `"remoteUser": "vscode"` in `.devcontainer/devcontainer.json` if you'd prefer to run as root. Some things to try: 1. **Edit:** - Open `app.py` - Try adding some code and check out the language features. -2. **Terminal:** Press ctrl+shift+\` and type `uname` and or other Linux commands from the terminal window. +2. **Terminal:** + - Press ctrl+shift+\` to open a terminal window. + - Type `flask run --host 0.0.0.0 --port 9000 --no-debugger --no-reload` to run the app. + > **Note:** It is important to add `--host 0.0.0.0` when using `appPort` in `devcontainer.json` since this uses Docker to "publish" the port rather than forwarding it. It therefore will not work if the application only listens to localhost. + - Open a local browser and go to `http://localhost:9000` to see the running app. 3. **Build, Run, and Debug:** - Open `app.py` - Add a breakpoint (e.g. on line 9). @@ -43,6 +52,9 @@ Some things to try: - Press F1 and run the **Remote-Containers: Forward Port from Container...** command. - Select port 5000. - Click "Open Browser" in the notification that appears to access the web app on this new port. +5. **Run from the command line** + - Press ctrl+shift+\` to open a terminal window + ### More samples