Add instructions to build containerd-shim and gcs binaries#1034
Merged
dcantah merged 1 commit intomicrosoft:masterfrom Jun 1, 2021
Merged
Add instructions to build containerd-shim and gcs binaries#1034dcantah merged 1 commit intomicrosoft:masterfrom
dcantah merged 1 commit intomicrosoft:masterfrom
Conversation
anmaxvl
approved these changes
May 20, 2021
README.md
Outdated
| [](https://github.com/microsoft/hcsshim/actions?query=branch%3Amaster) | ||
|
|
||
| This package contains the Golang interface for using the Windows [Host Compute Service](https://techcommunity.microsoft.com/t5/containers/introducing-the-host-compute-service-hcs/ba-p/382332) (HCS) to launch and manage [Windows Containers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/about/). It also contains other helpers and functions for managing Windows Containers such as the Golang interface for the Host Network Service (HNS). | ||
| This package contains the Golang interface for using the Windows [Host Compute Service](https://techcommunity.microsoft.com/t5/containers/introducing-the-host-compute-service-hcs/ba-p/382332) (HCS) to launch and manage [Windows Containers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/about/). It also contains other helpers and functions for managing Windows Containers such as the Golang interface for the Host Network Service (HNS), as well as code for the guest agent used to support running Linux Hyper-V containers. |
There was a problem hiding this comment.
maybe add that the guest agent is called GCS or OpenGCS or something?
Contributor
Author
There was a problem hiding this comment.
I thought we were trying to move away from the OpenGCS moniker, but I could add "commonly referred to as the GCS or Guest Compute Service in our codebase".
Contributor
Author
There was a problem hiding this comment.
Does that sound good?
jsturtevant
reviewed
May 28, 2021
| ### Containerd Shim | ||
| The containerd shim is very simple to build. | ||
| ```powershell | ||
| C:\> go build .\cmd\containerd-shim-runhcs-v1 |
Contributor
There was a problem hiding this comment.
Maybe make note of where this lives along side containerd and how this is configured for use?
internal/guest/README.md
Outdated
| @@ -0,0 +1,4 @@ | |||
| # Background | |||
| The packages in this directory comprise most of the code used to build the guest side agent for Linux Hyper-V containers on Windows (LCOW). The two binaries of importance that are built from this code are the [main guest agent](../../cmd/gcs/main.go) that facilitates communication between the host and guest and a [generic tools binary](../../cmd/gcstools/main.go) for additional functionality for device scenarios. The guest agent is designed to run inside a custom Linux OS for supporting Linux container payloads. | |||
There was a problem hiding this comment.
I think we should put the last sentence first and possibly as its own paragraph to highlight what the purpose of this is immediately.
Touch up the README a bit to add instructions on how to build some of the important binaries. Add a small README to the ./internal/guest directory. Remove the stray ./opengcs/README.md that was leftover from the merge. Signed-off-by: Daniel Canter <dcanter@microsoft.com>
anmaxvl
pushed a commit
to anmaxvl/hcsshim
that referenced
this pull request
Aug 19, 2021
princepereira
pushed a commit
to princepereira/hcsshim
that referenced
this pull request
Aug 29, 2024
Add instructions to build containerd-shim and gcs binaries
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Touch up the README a bit to add instructions on how to build some of the
important binaries.
Add a small README to the ./internal/guest directory.
Remove the stray ./opengcs/README.md that was leftover from the merge.
Signed-off-by: Daniel Canter dcanter@microsoft.com