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.

Sign up for GitHub

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

Future / proposed spec changes #56

Merged
merged 13 commits into from
Nov 2, 2022
Merged

Future / proposed spec changes #56

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a95e3f5
Add parallel execution
Oct 21, 2022
f23343c
Add feature env var
Oct 21, 2022
f94f7d1
Remove proposal word
Oct 24, 2022
331f98b
Removal
Oct 24, 2022
d27f115
Add info on object format
Oct 24, 2022
919a1dd
Add id proposal
Oct 24, 2022
02a93ef
Merge branch 'gh-pages' into bamurtaugh/other-spec
bamurtaugh Oct 24, 2022
6bbc3ed
Update _implementors/features.md
bamurtaugh Oct 25, 2022
1027b2b
Make sub-heading
Oct 25, 2022
8bf4c9d
Add to variable table
Oct 25, 2022
5e9f690
Merge branch 'gh-pages' into bamurtaugh/other-spec
bamurtaugh Oct 25, 2022
40608a0
Feedback
Oct 26, 2022
5f88eb5
Update features.md
bamurtaugh Oct 28, 2022
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
10 changes: 10 additions & 0 deletions _implementors/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,16 @@ The options property contains a map of option IDs and their related configuratio
| `optionId.description` | string | Description for the option. |
{: .table .table-bordered .table-responsive}

### <a href="#user-env-var" name="user-env-var" class="anchor"> User environment variables </a>

Feature scripts run as the `root` user and sometimes need to know which user account the dev container will be used with.

`_REMOTE_USER` and `_CONTAINER_USER` environment variables are passsed to the Features scripts with `_CONTAINER_USER` being the container's user and `_REMOTE_USER` being the configured `remoteUser`. If no `remoteUser` is configured, `_REMOTE_USER` is set to the same value as `_CONTAINER_USER`.

Additionally, the home folders of the two users are passed to the Feature scripts as `_REMOTE_USER_HOME` and `_CONTAINER_USER_HOME` environment variables.

The container user can be set with `containerUser` in the devcontainer.json and image metadata, `user` in the docker-compose.yml, `USER` in the Dockerfile, and can be passed down from the base image.

## <a href="#devcontainer-json-properties" name="devcontainer-json-properties" class="anchor"> devcontainer.json properties </a>

Features are referenced in a user's [`devcontainer.json`](../json_reference) under the top level `features` object.
Expand Down
21 changes: 21 additions & 0 deletions _implementors/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,27 @@ To resume the environment from a stopped state:

Like during the create process, remote [environment variables](#environment-variables) and [user](#users) configuration should be applied to all created processes in the container (inclusive of `userEnvProbe`).

## <a href="#parallel-exec" name="parallel-exec" class="anchor"> Parallel lifecycle script execution (proposal) </a>

Dev containers support a single command for each of its lifecycle scripts. While serial execution of multiple commands can be achieved with `;`, `&&`, etc., parallel execution deserves first-class support.

All lifecycle scripts have been extended to support `object` types. The key of the `object` will be a unique name for the command and the value will be the `string` or `array` command. Each command must exit successfully for the stage to be considered successful.

Each entry in the `object` will be run in parallel during that lifecycle step.

### Example

```json
{
"postCreateCommand": {
"server": "npm start",
"db": ["mysql", "-u", "root", "-p", "my database"]
}
}
```

You may review this proposal directly in [the spec](https://github.com/devcontainers/spec/blob/main/proposals/parallel-lifecycle-script-execution.md).

# <a href="#definitions" name="definitions" class="anchor"> Definitions </a>
#### <a href="#project-workspace-folder" name="project-workspace-folder" class="anchor"> Project Workspace Folder </a>

Expand Down