Documentation/trying-out-rkt: Update for clarity and style #2825
Conversation
|
|
||
| ## Using rkt on Linux | ||
|
|
||
| rkt consists of a single CLI tool and can run on different platforms. The primary target platform currently is amd64 Linux. A modern kernel is required but there should be no other system dependencies. | ||
| rkt consists of a single command line program compiled for Linux on the amd64 architecture. A modern Linux kernel is required, but there are no other system prerequisites. |
There was a problem hiding this comment.
I think this is going in the exact opposite direction of #2808 (comment) Or is that on purpose and I'm lacking some further context here?
There was a problem hiding this comment.
It is on purpose -- We do not at this release (1.9) or time deliver any arch but amd64.
When #2758 merges and there is support, that's when I think this doc gets an update. Until then it just tells the unalloyed fact, because we're specifically documenting the binary rkt here, not instructing on how you might compile for archs that will later be supported.
Consider what we might say instead: "rkt is compiled as an amd64 binary, but could be compiled on other architectures"? -- which ones, how, and does the result work?
Which brings me to my question about this, that maybe changes my opinion on how we write this sentence: What does debian's rkt 1.5 package actually do on a 64 bit ppc? Does it work?
|
@philips @jonboulle I had a quick chat with @joshix and the new wording should clarify the split between writing arch-agnostic code and distributing pre-compiled binaries. If it sounds ok for you, we can just squash this here. |
|
@squeed Review on this would be appreciated since you're new to this |
| To download the rkt binary, simply grab the latest release directly from GitHub: | ||
| ### Running the latest rkt binary | ||
|
|
||
| To start running the latest version of rkt on amd64, grab the release directly from the rkt GitHub project: | ||
|
|
||
| ``` | ||
| wget https://github.com/coreos/rkt/releases/download/v1.8.0/rkt-v1.8.0.tar.gz |
There was a problem hiding this comment.
And now we're at v1.9.1 :-)
There was a problem hiding this comment.
possible bug from the scripts/bump-version.sh script
|
I gave this a quick review, as I'm currently in the process of bringing myself on-board. Ultimately, it probably would have been more helpful if there was a stronger step-by-step feel with better indication as to what is "deeper". However, I'm not sure it's that important or worth additional time. |
|
(rebased) |
|
|
||
| ## Using rkt on Linux | ||
|
|
||
| rkt consists of a single CLI tool and can run on different platforms. The primary target platform currently is amd64 Linux. A modern kernel is required but there should be no other system dependencies. | ||
| rkt is written in Go and can be compiled for several CPU architectures. The rkt project distributes binaries for amd64. These rkt binaries will run on any modern Linux amd64 kernel. |
There was a problem hiding this comment.
#2758 (arm64 support) is merged, so it needs an update.
There was a problem hiding this comment.
Not until we sort out if/how we pre-compile and distribute arm64 binaries.
There was a problem hiding this comment.
Ah true. I was too hasty.
|
@joshix can you please squash them into a single commit? LGTM otherwise. |
Addressing rkt#2808 (diff) Update to clarify the 3 use cases (actually 4, since we describe Vagrant on linux as well). Update for styleguide stuff - ref links, sentence case, fmt. Update etcd ACI version and hashes to v2.3.7.
|
@lucab squished |
Addressing #2808 (diff)
Update to clarify the 3 use cases (actually 4, since we describe Vagrant
on linux as well).
Update for styleguide stuff - ref links, sentence case, fmt.
Update etcd ACI version and hashes to v2.3.7.