Skip to content

Include CSR example#3315

Merged
catherineluse merged 2 commits into
masterfrom
cert-csr-controller-example
Aug 5, 2021
Merged

Include CSR example#3315
catherineluse merged 2 commits into
masterfrom
cert-csr-controller-example

Conversation

@ansilh
Copy link
Copy Markdown
Contributor

@ansilh ansilh commented May 31, 2021

@superseb
Copy link
Copy Markdown
Contributor

superseb commented Jun 1, 2021

These are two different things and should probably be on a different page, and if on the same page, it should be made more clear what Certificate Management means as this page describes how RKE handles it's certificates and that is unrelated to k8s certificate management.

@ansilh
Copy link
Copy Markdown
Contributor Author

ansilh commented Jun 1, 2021

Search engines will take the user to the certificate management doc page of RKE, and I thought it would be a good place to indicate it.
Can we add a sentence like the below to differentiate the cert management of both rke and k8s?

The Certificate Management mentioned in this example is unrelated to the certificate management of RKE.
Please refer to [Kubernetes documentation](https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/) for more details on certificate management by Kubernetes.

Or is there any other good place to add this info?

@superseb
Copy link
Copy Markdown
Contributor

superseb commented Jun 1, 2021

The user is unaware of what is what, currently it is specified as Optional settings but they are both very different settings. One is RKE's internal certificate management used for the k8s components, the other is a setting in k8s to manage certificates, which is just plain/vanilla Kubernetes as any other distro. We describe in our docs what RKE is capable of, not everything that k8s is capable of.

If there is confusion (which is logical if you end up on this page), just adding Optional settings with an example is not going to help the user. The RKE part needs to be clarified and the k8s part needs to be added in a way that its clear that it is a k8s thing and that you can enable it using the following setting.

@ansilh
Copy link
Copy Markdown
Contributor Author

ansilh commented Jun 1, 2021

So the conclusion would be;

  • RKE documentation has extra_args documented for enabling k8s specific features.
  • Kubernetes documentation has the details about the flag needed to use a specific feature.
    The user should be knowing both.

If that is the case, then we can close this PR.

@superseb
Copy link
Copy Markdown
Contributor

superseb commented Jun 3, 2021

If people are looking this up and end up on this page, we can add a notice to say this is not k8s certificate management and link to another page where we show how to configure it. At least they are pointed in the right direction that way.

@ansilh
Copy link
Copy Markdown
Contributor Author

ansilh commented Jun 10, 2021

Sure. A new page or an existing one?
( https://rancher.com/docs/rke/latest/en/example-yamls/ ? )

@superseb
Copy link
Copy Markdown
Contributor

Yep the full example is fine, we don't need a separate page as we have k8s docs + the example yaml which will include the example

ansilh added a commit that referenced this pull request Jul 27, 2021
Added "Enable TLS Certificates management"  to kube-controller
Part of #3315
@ansilh ansilh mentioned this pull request Jul 27, 2021
Added note for "TLS Certificates management in Kubernetes"
@ansilh
Copy link
Copy Markdown
Contributor Author

ansilh commented Jul 27, 2021

Updated the note and opened a PR #3412 to add the details in the example cluster.yaml

@catherineluse catherineluse merged commit 4c6827e into master Aug 5, 2021
@ansilh ansilh deleted the cert-csr-controller-example branch August 10, 2021 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve the Certificate Management docs

3 participants