-
Notifications
You must be signed in to change notification settings - Fork 606
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.
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
fix(docs): update installation steps for windows and linux #2112
base: main
Are you sure you want to change the base?
Conversation
|
@@ -134,16 +134,20 @@ In addition to containerd, the following components should be installed: | |||
|
|||
These dependencies are included in `nerdctl-full-<VERSION>-<OS>-<ARCH>.tar.gz`, but not included in `nerdctl-<VERSION>-<OS>-<ARCH>.tar.gz`. | |||
|
|||
### Brew |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why remove?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just renamed to Linux
the other items are based on the OS types instead, i.e. Windows, FreeBSD, MacOS.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks like we lost the On Linux systems you can install nerdctl via [brew](https://brew.sh):
below?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jsturtevant -- I've replaced that with the standard installation process on Linux. I don't see a reason to install brew
first so that you can install nerdctl
when most likely they have already installed containerd
, etc. using the standard process of getting the binaries from Github with curl
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should keep brew install instructions and we can add the additional manual process. Then the user can choose what is best for them.
@AkihiroSuda -- thanks for the review, going to make the changes.
What is the best way of setting up the CNI plugin for windows? I was trying to adapt this bash script here (which I think should be done in PowerShell instead, working on that) - https://gist.github.com/profnandaa/e9ab7bd7e069ce2728840b041ce4c300 |
b504324
to
408e67e
Compare
@profnandaa don't worry about that warning message, even if you didn't explicitly ask for network settings for your container, it's due to the fact that This special treatment of the default network is the result of #1538, after which
That's perfect since it's basically the "reference configuration" which is used in both the containerd CI, as well as being basically 1:1 lifted to be used in the nerdctl CI too. Although there's basically no reason to worry about that warning message, and I wouldn't necessarily bother mentioning it in the docs, but you could dodge it by opening the network config file shown in
{
...
// NOTE: this ID field is all you'll really need, and you can invent your own ID if needed.
"nerdctlID": "d919a100ce6b45524d415d52d088d5817587c6dd8c3691b03b8063c44d043523",
"nerdctlLabels": {
"nerdctl/default-network": "true"
},
...
} |
This PR updates the installation instructions for Windows and Linux.
We didn't have Windows installation steps and the Linux one was using
brew
(needs another extra installation);sort of an anti-pattern from how we install the rest of the ecosystem tools like
containerd
, etc.