Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change wordings on CNI,CSI and CRI related pages to really mean k0s s… #3598

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Change wordings on CNI,CSI and CRI related pages to really mean k0s s… #3598

merged 1 commit into from
Nov 1, 2023

Conversation

jnummelin
Copy link
Member

@jnummelin jnummelin commented Oct 18, 2023 •
edited
Loading

…upports ANY standard providers for these

The current wording might make some users think k0s supports and works with only with the things we bundle in when actually k0s works with any standard Kubernetes component.

Description

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@jnummelin jnummelin requested a review from a team as a code owner October 18, 2023 12:59
@jnummelin jnummelin added the backport/release-1.28 PR that needs to be backported/cherrypicked to release-1.28 branch label Oct 18, 2023
twz123
twz123 previously approved these changes Oct 18, 2023
View reviewed changes
Copy link
Member

@twz123 twz123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(A personal note on formatting: Hard wrapping text in Markdown files allows for more accurate review comments, as you don't have to comment on two or three sentences at once. (And I think it's generally nicer to look at.))

docs/networking.md Outdated Show resolved Hide resolved
docs/networking.md Outdated Show resolved Hide resolved
docs/cloud-providers.md Outdated Show resolved Hide resolved
docs/cloud-providers.md Outdated

Use the built-in [manifest deployer](manifests.md) built into k0s to deploy your cloud provider as a k0s-managed stack. Next, just drop all required manifests into the `/var/lib/k0s/manifests/aws/` directory, and k0s will handle the deployment.
You can use any means to deploy your cloud controller inito the cluster. Most providers support [Helm charts](helm-charts.md) to deploy them.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can use any means to deploy your cloud controller inito the cluster. Most providers support [Helm charts](helm-charts.md) to deploy them.
You can use any means to deploy your cloud controller into the cluster. Most providers support [Helm charts](helm-charts.md) to deploy them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be awesome if we could add links to the two or three most important cloud provider helm charts.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inito typo is still there.

docs/cloud-providers.md Outdated
@@ -1,10 +1,8 @@
# Cloud providers

k0s builds Kubernetes components in *providerless* mode, meaning that cloud providers are not built into k0s-managed Kubernetes components. As such, you must externally configure the cloud providers to enable their support in your k0s cluster (for more information on running Kubernetes with cloud providers, refer to the [Kubernetes documentation](https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/).
k0s supports all Kubernetes cloud providers that implement the [CCM specification](https://kubernetes.io/docs/concepts/architecture/cloud-controller/). In the case of k0s, all cloud controllers must be installed as cluster add-ons as k0s builds Kubernetes components in *providerless* mode.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I struggle a bit with the term "CCM specification". The link to the Kubernetes docs is not really pointing to a specification, is it?

Also about "... that implement the CCM specification": Are there any Kubernetes cloud providers out there that don't implement the "specification"? Isn't that the deciding factor for being a Kubernetes cloud provider in the first place?

Kubernetes calls those components cloud controllers. Maybe we should do the same? What about sth. like this:

K0s supports all [Kubernetes cloud controllers]. However, those must be installed as separate cluster add-ons since k0s builds Kubernetes components in *providerless* mode.

[Kubernetes cloud controllers]: https://kubernetes.io/docs/concepts/architecture/cloud-controller/

docs/networking.md Outdated Show resolved Hide resolved
docs/runtime.md Outdated Show resolved Hide resolved
docs/user-management.md Outdated Show resolved Hide resolved
docs/user-management.md Outdated Show resolved Hide resolved
docs/networking.md Show resolved Hide resolved
@twz123 twz123 added the documentation Improvements or additions to documentation label Oct 18, 2023
@jnummelin jnummelin force-pushed the docs/cni-etc-support branch 2 times, most recently from 1778f31 to bd25c0b Compare October 27, 2023 13:49
@jnummelin
Copy link
Member Author

@twz123 fixed all the things, PTAL again

twz123
twz123 previously approved these changes Oct 30, 2023
View reviewed changes
Copy link
Member

@twz123 twz123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's still one small typo left.

docs/cloud-providers.md Outdated

Use the built-in [manifest deployer](manifests.md) built into k0s to deploy your cloud provider as a k0s-managed stack. Next, just drop all required manifests into the `/var/lib/k0s/manifests/aws/` directory, and k0s will handle the deployment.
You can use any means to deploy your cloud controller inito the cluster. Most providers support [Helm charts](helm-charts.md) to deploy them.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inito typo is still there.

docs/user-management.md
k0s comes with some helper commands to create kubeconfig with client certificates for users. There are few caveats that one needs to take into consideration when using client certificates:

* Client certificates have long expiration time, they're valid for one year
* Client certificates cannot be revoked (general Kubernetes challenge)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL:

@jnummelin
Change wordings on CNI,CSI and CRI related pages to really mean k0s s…
44555ce 
…upports ANY standard providers for these

The current working might make some users think k0s supports and works with only with the things we bundle in when actually k0s works with any standard Kubernetes component.

Signed-off-by: Jussi Nummelin <jnummelin@mirantis.com>
@jnummelin jnummelin force-pushed the docs/cni-etc-support branch from bd25c0b to 44555ce Compare October 31, 2023 12:03
@jnummelin jnummelin merged commit e52b6d8 into k0sproject:main Nov 1, 2023
5 checks passed
@jnummelin jnummelin deleted the docs/cni-etc-support branch November 1, 2023 10:49
@k0s-bot
Copy link

k0s-bot commented Nov 1, 2023

Successfully created backport PR for release-1.28:

@k0s-bot k0s-bot mentioned this pull request Nov 1, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@twz123 twz123 twz123 approved these changes

@ncopa ncopa Awaiting requested review from ncopa ncopa is a code owner automatically assigned from k0sproject/k0s-maintainers

@juanluisvaladas juanluisvaladas Awaiting requested review from juanluisvaladas juanluisvaladas is a code owner automatically assigned from k0sproject/k0s-maintainers

Assignees
No one assigned
Labels
backport/release-1.28 PR that needs to be backported/cherrypicked to release-1.28 branch documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jnummelin @k0s-bot @twz123