doc: revamp kata containers getting started guide#12144
Merged
Conversation
20 tasks
|
|
||
| helm install cilium |CHART_RELEASE| \\ | ||
| --namespace kube-system \\ | ||
| --set global.containerRuntime.integration=containerd |
Contributor
There was a problem hiding this comment.
I am not sure if global.containerRuntime.integration is really needed. I used Cilium with containerd and containerd+kata without setting the parameter, and didn't see any issues.
Member
Author
There was a problem hiding this comment.
I am not sure either but it was part of the documentation and the distinction for CRI-O and containerd was clearly emphasized.
Contributor
There was a problem hiding this comment.
Ah, so actually crio is the only special value. In practice, I believe containerd basically doesn't have special needs.
$ git grep .Values.global.containerRuntime.integration install/kubernetes
install/kubernetes/cilium/charts/agent/templates/daemonset.yaml:{{- if not (eq .Values.global.containerRuntime.integration "crio") }}
install/kubernetes/cilium/charts/agent/templates/daemonset.yaml:{{- if not (eq .Values.global.containerRuntime.integration "crio") }}
install/kubernetes/cilium/charts/agent/templates/daemonset.yaml:{{- if not (eq .Values.global.containerRuntime.integration "crio") }}
$
Contributor
|
Thanks @rolinh, I think this is a very nice a concise guide now, I added a few comments/suggestions... let me know how else I can help! |
This commit updates the getting started guide for kata containers in the following ways: - Remove all custom instructions that were likely copied over from external sources, namely the official Kata Containers, CRI-O and containerd guides. These turned out to be outdated for the most part. Instead, this guide now points the reader to the official guides from the Kata Containers documentation to setup Kata Containers and a Kubernetes cluster. - By removing custom instructions and linking to the official Kata Containers documentation, this guide is now also more generic in that it should work for any platform that supports the Kata Containers runtime instead of being specific to Google Compute Engine (GCE). - This guide now being generic, rename it, including the file name, to just kata instead of kata-gce. - Include `k8s-install-download-release.rst` instead of duplicating the instructions. - Add a note that this guide has only been validated using instructions for GCE. Signed-off-by: Robin Hahling <robin.hahling@gw-computing.net>
9b767cb to
70f2eae
Compare
Member
Author
|
Thanks for your feedback @errordeveloper, I included your suggested changes. I'm not sure about removing |
errordeveloper
approved these changes
Jun 18, 2020
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
6 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.
This commit updates the getting started guide for kata containers in the
following ways:
external sources, namely the official Kata Containers, CRI-O and
containerd guides. These turned out to be outdated for the most part.
Instead, this guide now points the reader to the official guides from
the Kata Containers documentation to setup Kata Containers and a
Kubernetes cluster.
Containers documentation, this guide is now also more generic in that
it should work for any platform that supports the Kata Containers
runtime instead of being specific to Google Compute Engine (GCE).
just kata instead of kata-gce.
k8s-install-download-release.rstinstead of duplicating theinstructions.
for GCE.