docs: rework README + add initial docs for nomad/k8s #1884
Conversation
|
fixes #1570 |
|
/cc @dgonyeo / @yifan-gu for help on the rktnetes stuff /cc @joshix - this is the first of a series of iterative attempts to restructure/clean up documentation to try make the project more accessible. Mostly pinging you as a heads up as I don't want to turn this PR into a giant rabbit hole - but would love your help/guidance on the next iterations. I'd also like to start exploring something similar for other projects like etcd. |
|
|
||
| rkt's native image format is ACI, defined in the [App Container spec](app-container.md). | ||
| To build ACIs, a simple way to get started is by using [`acbuild`](https://github.com/appc/acbuild). | ||
| Another good resource is the [appc build repository](https://github.com/appc/build-repository) which has resources for building ACIs from a number of popular projects and languages. |
There was a problem hiding this comment.
Want to use this opportunity to kill the build-repository?
I don't think there's anything in there worth salvaging, but if people want to still have an example on how to build a container using the host's apt-get I can add it into acbuild's examples.
There was a problem hiding this comment.
please, do it
On Fri, Dec 18, 2015 at 7:50 PM, Derek Gonyeo notifications@github.com
wrote:
In Documentation/basics.md
#1884 (comment):+
+git clone https://github.com/coreos/rkt +cd rkt +vagrant up +vagrant ssh +
+
+Keep in mind while running through the examples that right nowrktneeds to be run as root for most operations.
+
+## rkt basics
+
+### Building App Container Images (ACIs)
+
+rkt's native image format is ACI, defined in the App Container spec.
+To build ACIs, a simple way to get started is by usingacbuild.
+Another good resource is the appc build repository which has resources for building ACIs from a number of popular projects and languages.Want to use this opportunity to kill the build-repository?
I don't think there's anything in there worth salvaging, but if people
want to still have an example on how to build a container using the host's
apt-get I can add it into acbuild's examples.—
Reply to this email directly or view it on GitHub
https://github.com/coreos/rkt/pull/1884/files#r48055688.
|
|
||
| The container runtime is configured at the kubelet level. | ||
|
|
||
| ** TODO: add example here... ** |
There was a problem hiding this comment.
Kubelet (the agent that runs on each machine to manage containers) provides several flags to use rkt as the container runtime. Including:
--container-runtime=rktchooses rkt as the runtime.--rkt-pathsets the rkt binary path.--rkt-stage1-imagesets the stage1 image path.
The getting started with rkt guide in Kubernetes provides more detailed information about how to launch a kubernetes cluster with rkt, how to debug it, and more.
(edited to fix link to rkt getting started guide -joshix)
|
@joshix any "hells noes" here, or happy for this to land and we can roll forward? |
jonboulle
changed the title
jonboulle
force-pushed
the
master
branch
2 times, most recently
from
85c2478
to
1a1c704
Compare
This breaks apart much of the README into a new "basics" document. The goal is to make the README a little more approachable and do better at highlighting the different options for people to reach out. Also adds initial documents describing integration with Nomad and Kubernetes and links to them appropriately.
|
LGTM &c. from slack convo, @jonboulle. This is a good direction for the docs to travel. I can see maybe splitting building ACIs out from the "trying rkt" doc entirely in a later changeset. |
docs: rework README + add initial docs for nomad/k8s
This breaks apart much of the README into a new "basics" document. The
goal is to make the README a little more approachable and do better at
highlighting the different options for people to reach out.
Also adds initial documents describing integration with Nomand and
Kubernetes and links to them appropriately.