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.

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

docs: Add information about authentication #34

Merged
merged 1 commit into from
Oct 17, 2023

Conversation

akrejcir
Copy link
Collaborator

What this PR does / why we need it:
Added a short explanation of Kubernetes authentication method to API doc.

None

@kubevirt-bot kubevirt-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Oct 16, 2023
@akrejcir
Copy link
Collaborator Author

/cc @0xFelix @ksimon1

docs/api.md Outdated Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
Copy link

@jcanocan jcanocan left a comment

Choose a reason for hiding this comment

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

Good job! Just a small suggestion. Feel free to ignore it.

docs/api.md Outdated
Comment on lines 35 to 36
Kubernetes supports two main ways of authenticating, token and TLS client certificates, and other ways can be added
using an authenticating proxy. More information can be found in the [documentation](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#authentication-strategies).

Choose a reason for hiding this comment

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

Suggested change
Kubernetes supports two main ways of authenticating, token and TLS client certificates, and other ways can be added
using an authenticating proxy. More information can be found in the [documentation](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#authentication-strategies).
Kubernetes supports two main ways of authenticating, token and TLS client certificates. Nevertheless, other ways can be added
using an authenticating proxy. More information can be found in the [documentation](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#authentication-strategies).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That doesn't sound right to me. Nevertheless has a different meaning.

Choose a reason for hiding this comment

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

humm maybe Moreover?

Copy link
Member

Choose a reason for hiding this comment

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

I agree, separating this into two sentences makes it easier to understand.

Copy link
Collaborator Author

@akrejcir akrejcir Oct 17, 2023

Choose a reason for hiding this comment

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

Done

Copy link
Member

@0xFelix 0xFelix left a comment

Choose a reason for hiding this comment

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

/approve

docs/api.md Outdated
Comment on lines 35 to 36
Kubernetes supports two main ways of authenticating, token and TLS client certificates, and other ways can be added
using an authenticating proxy. More information can be found in the [documentation](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#authentication-strategies).
Copy link
Member

Choose a reason for hiding this comment

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

I agree, separating this into two sentences makes it easier to understand.

@kubevirt-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 0xFelix

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubevirt-bot kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 17, 2023
Signed-off-by: Andrej Krejcir <akrejcir@redhat.com>
@jcanocan
Copy link

Good job! 😊
/lgtm

@kubevirt-bot kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Oct 17, 2023
@kubevirt-bot kubevirt-bot merged commit 06b9fd3 into kubevirt:main Oct 17, 2023
3 checks passed
@akrejcir akrejcir deleted the doc-authentication branch October 17, 2023 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants