Add docker config to dev guide #893
Conversation
|
Hi @klynnrif, @grahamwhaley - could you take a look? |
|
kubernetes qa-passed 👍 |
| binary: | ||
|
|
||
| ```bash | ||
| $ sudo sed 's!cc-runtime=/usr/bin/cc-runtime!cc-runtime=/usr/local/bin/cc-runtime!g' /etc/systemd/system/docker.service.d/clear-containers.conf |
There was a problem hiding this comment.
Do you need a -i on this sed to do an in-place edit?
There was a problem hiding this comment.
Good catch - fixed.
| @@ -1,5 +1,12 @@ | |||
| # Developers Clear Containers 3.0 Install | |||
|
|
|||
| * [Initial setup](#initial-setup) | |||
There was a problem hiding this comment.
Out of interest - did you generate this by hand, or use a tool? If a tool, might be an idea to note the tool in the commit so others can follow suit later (n.b. I hand-added a toc entry earlier this week, and now realise maybe I should have seeked a tool)
There was a problem hiding this comment.
I actually used a hacky script that requires manual post-processing to work with both github (and pandoc for local testing) but I believe @sameo found a website that does it when you feed it an .md file. Wouldn't it be awesome if github supported auto-generating a TOC, like you get for free with rST ;(
There was a problem hiding this comment.
it would be nice if github handled it automatically (they do have their own md flavour - so should be able to add it ...) but, there are some tools around:
https://github.com/ekalinin/github-markdown-toc
https://github.com/jonschlinkert/markdown-toc
We could test and pick one for sure :-)
There was a problem hiding this comment.
yep - we should prolly discuss this for kata too at some point...
| @@ -78,6 +78,9 @@ See [the upgrading document](upgrading.md) for further details. | |||
| $ sudo make install | |||
| ``` | |||
|
|
|||
| Note: the install step above will overwrite any proxy binary installed from | |||
There was a problem hiding this comment.
Side note - so we overwrite the shim and proxy, but not the runtime - and I think that is because the runtime build system has a notion of 'dev build' vs 'package build', but the others do not. OK, that's good to document, and it seems a bit late and un-necessary to fix that right now - but, in the future let's see if we can remember to probably have dev and package builds for all the components :-)
There was a problem hiding this comment.
Yes, that's it exactly. And yes, let's all try to remember to make this a hard requirement for kata! ;)
jodh-intel
force-pushed
the
add-docker-config-to-dev-guide
branch
from
4101e8b
to
c370d23
Compare
|
kubernetes qa-passed 👍 |
| The installation guide instructions will install all packaged | ||
| components, plus docker, the hypervisor and the Clear Containers image | ||
| and kernel. | ||
| The installation guide instructions will install all required Clear Containers |
There was a problem hiding this comment.
Suggest using a series comma here (I believe I saw this in the style guide but correct me if I'm wrong) - I'm not certain whether "Clear Containers image" and "kernel" should be paired together or separately. I'm assuming together for this re-write: The installation guide instructions will install all required Clear Containers components, plus Docker*, the hypervisor, and the Clear Containers image and kernel.
| * [gcc](https://gcc.gnu.org/) and associated C language build tooling | ||
| such as `make`, `autoconf` and `libtool` which are required | ||
| to build `cc-shim` | ||
| (such as `make`, `autoconf` and `libtool`) are required |
There was a problem hiding this comment.
(e.g. make, autoconf, and libtool) are required
| $ make | ||
| $ sudo make install | ||
| ``` | ||
| Note: the install step above will overwrite any proxy binary installed from |
There was a problem hiding this comment.
Note: the previous install step will...
|
|
||
| 4. Agent | ||
| Note: the install step above will overwrite any shim binary installed from |
There was a problem hiding this comment.
Note: the previous install step will...
|
|
||
| ```bash | ||
| $ cd $GOPATH/src/github.com/clearcontainers/osbuilder | ||
| The install step above will create `/usr/local/bin/cc-runtime`. This |
There was a problem hiding this comment.
The previous install step will create...
| For more details on the runtime's build system, run: | ||
| The agent is installed inside the root filesystem image | ||
| used by the hypervisor, hence to test a new agent version it is | ||
| necessary to create a custom rootfs image. The example below |
| The latest kernel for Clear Linux can be found on | ||
| [the releases page](https://github.com/clearcontainers/linux/releases). | ||
| The Clear Linux kernel can be used to rebuild and modify a custom VM | ||
| container kernel as needed. The example below demonstrates how to do this |
Added references to instal guides for CentOS, SLES, and Clear Linux. Also changed wording slightly given that some install guides (CentOS and SLES) install some components from source. Signed-off-by: James O. D. Hunt <[email protected]>
Added missing periods and brackets for build requirements to make build requirements section clearer. Signed-off-by: James O. D. Hunt <[email protected]>
`GOPATH` is a variable so needs to be rendered in a fixed-width font in the dev guide. Signed-off-by: James O. D. Hunt <[email protected]>
Added notes to the proxy and shim sections in the dev guide explaining that the `make install` will overwrite the package-installed binaries. Signed-off-by: James O. D. Hunt <[email protected]>
Move the note about the runtime build system back to the runtime section in the dev guide. Signed-off-by: James O. D. Hunt <[email protected]>
Added details on how to reconfigure Docker to use a development version of the runtime in the dev guide. Fixes clearcontainers#892. Signed-off-by: James O. D. Hunt <[email protected]>
Added a link to the packaging repository in the dev guide as it could be a useful resource. Signed-off-by: James O. D. Hunt <[email protected]>
Add a table of contents to the development guide. Signed-off-by: James O. D. Hunt <[email protected]>
Created new sections for each component and added them to the table of contents. Signed-off-by: James O. D. Hunt <[email protected]>
Removed superfluous trailing blank line in dev guide. Signed-off-by: James O. D. Hunt <[email protected]>
Apply some non-PR-related review feedback. Signed-off-by: James O. D. Hunt <[email protected]>
jodh-intel
force-pushed
the
add-docker-config-to-dev-guide
branch
from
c370d23
to
dbd4f6a
Compare
|
Hi @klynnrif - branch updated (note that the last two comments are unrelated to the changes I made, but I've created a new commit specifically for them). |
|
Ignoring the F26 failure (clearcontainers/jenkins#32) as this is a doc-only PR. |
|
kubernetes qa-passed 👍 |
Added details on how to reconfigure docker to dev guide, along with a bunch of other minor improvements.