Skip to content
This repository has been archived by the owner on Nov 30, 2023. It is now read-only.

Commit

Permalink
READMEs for all container definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel committed Apr 4, 2019
1 parent 6781b8c commit 4562f81
Show file tree
Hide file tree
Showing 33 changed files with 787 additions and 24 deletions.
30 changes: 30 additions & 0 deletions containers/azure-cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Azure CLI

## Summary

*A basic dev container definitions that demonstrates installation and use of the Azure CLI in a container.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | Any |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder and use the content in `test-project` to try things out.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
28 changes: 28 additions & 0 deletions containers/azure-functions-node-8/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Azure Functions w/Node.js v8

## Summary

*A basic dev container definition for building Node.js based Azure Functions in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | Azure Functions, Node.js, JavaScript |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
28 changes: 28 additions & 0 deletions containers/azure-hdinsight-python-3/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Azure HDInsight w/Python 3

## Summary

*A basic dev container definition for using Azure HDInsight in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | Azure HDInsight, Python |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
28 changes: 28 additions & 0 deletions containers/azure-machine-learning-python-3/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Azure Machine Learning w/Python 3

## Summary

*A basic dev container definition for using Azure Machine Learning in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | Azure Machine Learning, Python |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
28 changes: 28 additions & 0 deletions containers/azure-terraform/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Azure Terraform

## Summary

*A basic dev container that demonstrates the installation and use of Terraform in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | Terraform |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
30 changes: 30 additions & 0 deletions containers/cpp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# C++

## Summary

*A basic dev container definition for building C++ apps in container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | C++ |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
31 changes: 30 additions & 1 deletion containers/dart-web/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,30 @@
# Dart Dev Container
# Dart - Web

## Summary

*A basic dev container definition for developing web applications using Dart in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | Dart |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
14 changes: 13 additions & 1 deletion containers/docker-existing-docker-compose/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Existing Docker Compose
# Existing Docker Compose (Extend)

## Summary

Expand All @@ -12,6 +12,18 @@

> **Note:** There is also a single [Dockerfile](../docker-existing-dockerfile) variation of this same definition.
## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with an existing project that contains a `docker-compose.yml` file:

1. Copy the `.devcontainer` folder into your project root.
2. Modify the `.devcontainer/dev-container.yml` and `devcontainer.json` files as needed (see comments)
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

## License

Copyright (c) Microsoft Corporation. All rights reserved.
Expand Down
10 changes: 10 additions & 0 deletions containers/docker-existing-dockerfile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@
| *Languages, platforms* | Any |

> **Note:** There is also a [Docker Compose](../docker-existing-docker-compose) variation of this same definition.
>
## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project that contains a `Dockerfile`:

1. Copy the `.devcontainer` folder into your project root.
2. Modify the `.devcontainer/devcontainer.json` as needed (see comments)
3. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

## License

Expand Down
9 changes: 8 additions & 1 deletion containers/docker-in-docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@ Dev containers can be useful for all types of applications including those that

## Usage

No additional setup steps are required, but note that the included `dev-container.dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example:
To use the definition with an existing project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

No additional setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example:

```Dockerfile
FROM node:8
Expand Down
11 changes: 10 additions & 1 deletion containers/docker-in-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,16 @@ Dev containers can be useful for all types of applications including those that

## Usage

No additional setup steps are required, but note that the included `dev-container.dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example:
First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with an existing project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

No additional setup steps are required, but note that the included `.devcontainer/Dockerfile` can be altered to work with other Debian/Ubuntu-based container images such as `node` or `python`. First, update the `FROM` statement to reference the new base image. For example:

```Dockerfile
FROM node:8
Expand Down
30 changes: 30 additions & 0 deletions containers/dotnetcore-2.2-fsharp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# F#

## Summary

*A basic dev container definition for using F# in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | F# |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
30 changes: 30 additions & 0 deletions containers/dotnetcore-2.2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .NET Core v2.2

## Summary

*A basic dev container definition for developing .NET Core applications in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | .NET Core |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
30 changes: 30 additions & 0 deletions containers/go/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Go

## Summary

*A basic dev container definition for developing Go applications in a container. Includes everything you need to get up and running.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Definition type* | Dockerfile |
| *Languages, platforms* | Go |

## Usage

First, install the **[Visual Studio Code Remote Development](https://aka.ms/vscode-remote/download/extension)** extension pack if you have not already.

To use the definition with your own project:

1. Copy the `.devcontainer` folder into your project root.
2. Reopen the folder in the container (e.g. using the **Remote-Container: Reopen Folder in Container** command in VS Code) to use it unmodified.

If you prefer, you can look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.

If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](../../LICENSE).
Loading

0 comments on commit 4562f81

Please sign in to comment.