Add microk8s to foundational.md #10543
Merged
Conversation
This file contains 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
Adding microk8s as credible and stable alternative to get started with Kubernetes on a local machine. This is especially attractive for those not wanting to incur the overhead of running a VM for a local cluster.
kubernetes-docs-i18n-bot
added
the
language/en
k8s-ci-robot
added
cncf-cla: yes
|
/assign @MistyHacks |
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit 7baa641 https://deploy-preview-10543--kubernetes-io-master-staging.netlify.com |
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit 8090481 https://deploy-preview-10543--kubernetes-io-master-staging.netlify.com |
mdlinville
reviewed
Oct 8, 2018
| @@ -53,6 +53,25 @@ Minikube can be installed locally, and runs a simple, single-node Kubernetes clu | |||
|
|
|||
| You can get basic information about your cluster with the commands `kubectl cluster-info` and `kubectl get nodes`. However, to get a good idea of what's really going on, you need to deploy an application to your cluster. This is covered in the next section. | |||
|
|
|||
| #### microk8s | |||
|
|
|||
| On Linux, *microk8s* might be a good alternative for a local install of upstream Kubernetes. Microk8s keeps up with the current Kubernetes, and auto-updates to the latest point release for your convenience. Microk8s does not require you to install a hypervisor or launch a virtual machine, and installs within ~30 seconds. | |||
There was a problem hiding this comment.
In what cases might it be a good alternative? Also what's the meaning of "upstream Kubernetes" since these are in fact the upstream Kubernetes docs?
"Auto-updates" -> "automatically updates"
"With microk8s, you don't need to install a local..."
Can you wrap your lines at 80 chars? It makes future maintenance easier. I realize the rest of the file doesn't adhere to this now.
|
|
||
| * {{< link text="Install microk8s" url="https://microk8s.io/" >}}. | ||
|
|
||
| Once you have installed microk8s, using the prefix "microk8s." you can tab-complete a variety of commands, including accessing the included registry, container runtime and more (for example, `microk8s.kubectl`). Using the prefix ensures clean separation of the local environment vs other Kubernetes API endpoints. |
There was a problem hiding this comment.
This could use some rewriting. Suggest something like "After you install microk8s, you can use its tab-completion functionality. All microk8s commands start with microk8s.. Type microk8s. (with the period) and then use the tab key to see a list of available commands."
|
|
||
| Once you have installed microk8s, using the prefix "microk8s." you can tab-complete a variety of commands, including accessing the included registry, container runtime and more (for example, `microk8s.kubectl`). Using the prefix ensures clean separation of the local environment vs other Kubernetes API endpoints. | ||
|
|
||
| It also includes commands to `microk8s.enable` |
There was a problem hiding this comment.
Suggest "...to enable Kubernetes subsystems. For example:"
Thank you for your suggestions! LMK if this works now?
|
@MistyHacks - thanks. I've implemented your comments. LMK if this works? |
mdlinville
reviewed
Oct 9, 2018
| @@ -53,6 +53,33 @@ Minikube can be installed locally, and runs a simple, single-node Kubernetes clu | |||
|
|
|||
| You can get basic information about your cluster with the commands `kubectl cluster-info` and `kubectl get nodes`. However, to get a good idea of what's really going on, you need to deploy an application to your cluster. This is covered in the next section. | |||
|
|
|||
| #### microk8s | |||
|
|
|||
| On Linux, *microk8s* might be a good alternative to Minikube for a | |||
There was a problem hiding this comment.
I still don't know how to evaluate whether it "might" be a good use case for me or not. Can you give some criteria for deciding?
There was a problem hiding this comment.
I intended to elaborate on that statement a little further in the same paragraph. For example, microk8s is a great alternative to Minikube if you do not want the overhead of running a VM. Does that make sense?
mdlinville
reviewed
Oct 9, 2018
| On Linux, *microk8s* might be a good alternative to Minikube for a | ||
| local install of Kubernetes. Microk8s keeps up with the current | ||
| Kubernetes, and automatically updates to the latest point release for | ||
| your convenience. With microk8s you don't to install a hypervisor or |
There was a problem hiding this comment.
good catch! Will correct.
mdlinville
reviewed
Oct 9, 2018
| #### microk8s | ||
|
|
||
| On Linux, *microk8s* might be a good alternative to Minikube for a | ||
| local install of Kubernetes. Microk8s keeps up with the current |
There was a problem hiding this comment.
This is tricky but it seems from your heading that "microk8s" shouldn't be capitalized. Can you rewrite so it's not the first word of any sentence, to avoid this awkward situation?
mdlinville
reviewed
Oct 9, 2018
| local install of Kubernetes. Microk8s keeps up with the current | ||
| Kubernetes, and automatically updates to the latest point release for | ||
| your convenience. With microk8s you don't to install a hypervisor or | ||
| launch a virtual machine, and installation completes within ~30 |
There was a problem hiding this comment.
Maybe "around 30 seconds" or "less than a minute" instead of "~30 seconds"
mdlinville
reviewed
Oct 9, 2018
| `microk8s.` (with the period) and then use the tab key to see a list | ||
| of available commands. | ||
|
|
||
| It also includes commands to enable Kubernetes subsystems. For example: |
There was a problem hiding this comment.
Maybe "You can also use microk8s commands to enable...", sorry I know you already made one modification here.
And included a bullet list of features of microk8s
|
I added a small copyedit to make the list items more active (start with a verb). /lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mistyhacks The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
pushed a commit
that referenced
this pull request
Oct 12, 2018
* Update localization guidelines for language labels Continuing work Continuing work Continuing work More work in progress Add local OWNERS folders Add an OWNERS file to Chinese Remove shortcode for repos Add Japanese Alphabetize languages, change weights accordingly More updates Add Korean in Korean Add English to languageName Feedback from gochist Move Chinese content from cn/ to zh/ Move OWNERS from cn/ to zh/ Resolve merge conflicts by updating from master Add files back in to prep for resolution After rebase on upstream/master, remove files Review and update localization guidelines Feedback from gochist, tnir, cstoku Add a trailing newline to content/ja/OWNERS Add a trailing newline to content/zh/OWNERS Drop requirement for GH repo project Clarify language about forks/branches Edits and typos Remove a shortcode specific to a multi-repo language setup Update aliases and owners Add explicit OWNERS for content/en Migrate content from Chinese repo, update regex in config.toml Remove untranslated strings Add trailing newline to content/en/OWNERS Add trailing newlines to OWNERS files add Jaguar project description (#10433) * add Jaguar project description [Jaguar](https://gitlab.com/sdnlab/jaguar) is an open source solution for Kubernetes's network based on OpenDaylight. Jaguar provides overlay network using vxlan and Jaguar CNIPlugin provides one IP address per pod. * Minor newline tweak blog post for azure vmss (#10538) Add microk8s to pick-right-solution.md (#10542) * Add microk8s to pick-right-solution.md Microk8s is a single-command installation of upstream Kubernetes on any Linux and should be included in the list of local-machine solutions. * capitalized Istio Add microk8s to foundational.md (#10543) * Add microk8s to foundational.md Adding microk8s as credible and stable alternative to get started with Kubernetes on a local machine. This is especially attractive for those not wanting to incur the overhead of running a VM for a local cluster. * Update foundational.md Thank you for your suggestions! LMK if this works now? * Rewrote first paragraph And included a bullet list of features of microk8s * Copyedit fix typo (#10545) Fix the kubectl subcommands links. (#10550) Signed-off-by: William Zhang <warmchang@outlook.com> Fix command issue (#10515) Signed-off-by: mooncake <xcoder@tenxcloud.com> remove imported community files per issue 10184 (#10501) networking.md: Markdown fix (#10498) Fix front matter, federation command-line tools (#10500) Clean up glossary entry (#10399) update slack link (#10536) typo in StatefulSet docs (#10558) fix discription about horizontal pod autoscale (#10557) Remove redundant symbols (#10556) Fix issue #10520 (#10554) Signed-off-by: William Zhang <warmchang@outlook.com> Update api-concepts.md (#10534) Revert "Fix command issue (#10515)" This reverts commit c02a7fb. Update memory-constraint-namespace.md (#10530) update memory request to 100MiB corresponding the yaml content Blog: Introducing Volume Snapshot Alpha for Kubernetes (#10562) * blog post for azure vmss * snapshot blog post Resolve merge conflicts in OWNERS* Minor typo fix (#10567) Not sure what's supposed to be here, proposing removing it. * Feedback from gochist Tweaks to feedback * Feedback from ClaudiaJKang
markthink
pushed a commit
to markthink/website
that referenced
this pull request
Oct 9, 2019
* Update localization guidelines for language labels Continuing work Continuing work Continuing work More work in progress Add local OWNERS folders Add an OWNERS file to Chinese Remove shortcode for repos Add Japanese Alphabetize languages, change weights accordingly More updates Add Korean in Korean Add English to languageName Feedback from gochist Move Chinese content from cn/ to zh/ Move OWNERS from cn/ to zh/ Resolve merge conflicts by updating from master Add files back in to prep for resolution After rebase on upstream/master, remove files Review and update localization guidelines Feedback from gochist, tnir, cstoku Add a trailing newline to content/ja/OWNERS Add a trailing newline to content/zh/OWNERS Drop requirement for GH repo project Clarify language about forks/branches Edits and typos Remove a shortcode specific to a multi-repo language setup Update aliases and owners Add explicit OWNERS for content/en Migrate content from Chinese repo, update regex in config.toml Remove untranslated strings Add trailing newline to content/en/OWNERS Add trailing newlines to OWNERS files add Jaguar project description (kubernetes#10433) * add Jaguar project description [Jaguar](https://gitlab.com/sdnlab/jaguar) is an open source solution for Kubernetes's network based on OpenDaylight. Jaguar provides overlay network using vxlan and Jaguar CNIPlugin provides one IP address per pod. * Minor newline tweak blog post for azure vmss (kubernetes#10538) Add microk8s to pick-right-solution.md (kubernetes#10542) * Add microk8s to pick-right-solution.md Microk8s is a single-command installation of upstream Kubernetes on any Linux and should be included in the list of local-machine solutions. * capitalized Istio Add microk8s to foundational.md (kubernetes#10543) * Add microk8s to foundational.md Adding microk8s as credible and stable alternative to get started with Kubernetes on a local machine. This is especially attractive for those not wanting to incur the overhead of running a VM for a local cluster. * Update foundational.md Thank you for your suggestions! LMK if this works now? * Rewrote first paragraph And included a bullet list of features of microk8s * Copyedit fix typo (kubernetes#10545) Fix the kubectl subcommands links. (kubernetes#10550) Signed-off-by: William Zhang <warmchang@outlook.com> Fix command issue (kubernetes#10515) Signed-off-by: mooncake <xcoder@tenxcloud.com> remove imported community files per issue 10184 (kubernetes#10501) networking.md: Markdown fix (kubernetes#10498) Fix front matter, federation command-line tools (kubernetes#10500) Clean up glossary entry (kubernetes#10399) update slack link (kubernetes#10536) typo in StatefulSet docs (kubernetes#10558) fix discription about horizontal pod autoscale (kubernetes#10557) Remove redundant symbols (kubernetes#10556) Fix issue kubernetes#10520 (kubernetes#10554) Signed-off-by: William Zhang <warmchang@outlook.com> Update api-concepts.md (kubernetes#10534) Revert "Fix command issue (kubernetes#10515)" This reverts commit c02a7fb. Update memory-constraint-namespace.md (kubernetes#10530) update memory request to 100MiB corresponding the yaml content Blog: Introducing Volume Snapshot Alpha for Kubernetes (kubernetes#10562) * blog post for azure vmss * snapshot blog post Resolve merge conflicts in OWNERS* Minor typo fix (kubernetes#10567) Not sure what's supposed to be here, proposing removing it. * Feedback from gochist Tweaks to feedback * Feedback from ClaudiaJKang
markthink
pushed a commit
to markthink/website
that referenced
this pull request
Oct 9, 2019
* Update localization guidelines for language labels Continuing work Continuing work Continuing work More work in progress Add local OWNERS folders Add an OWNERS file to Chinese Remove shortcode for repos Add Japanese Alphabetize languages, change weights accordingly More updates Add Korean in Korean Add English to languageName Feedback from gochist Move Chinese content from cn/ to zh/ Move OWNERS from cn/ to zh/ Resolve merge conflicts by updating from master Add files back in to prep for resolution After rebase on upstream/master, remove files Review and update localization guidelines Feedback from gochist, tnir, cstoku Add a trailing newline to content/ja/OWNERS Add a trailing newline to content/zh/OWNERS Drop requirement for GH repo project Clarify language about forks/branches Edits and typos Remove a shortcode specific to a multi-repo language setup Update aliases and owners Add explicit OWNERS for content/en Migrate content from Chinese repo, update regex in config.toml Remove untranslated strings Add trailing newline to content/en/OWNERS Add trailing newlines to OWNERS files add Jaguar project description (kubernetes#10433) * add Jaguar project description [Jaguar](https://gitlab.com/sdnlab/jaguar) is an open source solution for Kubernetes's network based on OpenDaylight. Jaguar provides overlay network using vxlan and Jaguar CNIPlugin provides one IP address per pod. * Minor newline tweak blog post for azure vmss (kubernetes#10538) Add microk8s to pick-right-solution.md (kubernetes#10542) * Add microk8s to pick-right-solution.md Microk8s is a single-command installation of upstream Kubernetes on any Linux and should be included in the list of local-machine solutions. * capitalized Istio Add microk8s to foundational.md (kubernetes#10543) * Add microk8s to foundational.md Adding microk8s as credible and stable alternative to get started with Kubernetes on a local machine. This is especially attractive for those not wanting to incur the overhead of running a VM for a local cluster. * Update foundational.md Thank you for your suggestions! LMK if this works now? * Rewrote first paragraph And included a bullet list of features of microk8s * Copyedit fix typo (kubernetes#10545) Fix the kubectl subcommands links. (kubernetes#10550) Signed-off-by: William Zhang <warmchang@outlook.com> Fix command issue (kubernetes#10515) Signed-off-by: mooncake <xcoder@tenxcloud.com> remove imported community files per issue 10184 (kubernetes#10501) networking.md: Markdown fix (kubernetes#10498) Fix front matter, federation command-line tools (kubernetes#10500) Clean up glossary entry (kubernetes#10399) update slack link (kubernetes#10536) typo in StatefulSet docs (kubernetes#10558) fix discription about horizontal pod autoscale (kubernetes#10557) Remove redundant symbols (kubernetes#10556) Fix issue kubernetes#10520 (kubernetes#10554) Signed-off-by: William Zhang <warmchang@outlook.com> Update api-concepts.md (kubernetes#10534) Revert "Fix command issue (kubernetes#10515)" This reverts commit c02a7fb. Update memory-constraint-namespace.md (kubernetes#10530) update memory request to 100MiB corresponding the yaml content Blog: Introducing Volume Snapshot Alpha for Kubernetes (kubernetes#10562) * blog post for azure vmss * snapshot blog post Resolve merge conflicts in OWNERS* Minor typo fix (kubernetes#10567) Not sure what's supposed to be here, proposing removing it. * Feedback from gochist Tweaks to feedback * Feedback from ClaudiaJKang
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adding microk8s as credible and stable alternative to get started with Kubernetes on a local machine. This is especially attractive for those not wanting to incur the overhead of running a VM for a local cluster.