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

doc: improve the Kubernetes extension docs slightly #6689

Merged
merged 1 commit into from
Jan 21, 2020
Merged

doc: improve the Kubernetes extension docs slightly #6689

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/src/main/asciidoc/kubernetes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,21 +142,21 @@ By default the Kubernetes resources do not contain readiness and liveness probes
The values of the generated probes will be determined by the configured health properties: `quarkus.smallrye-health.root-path`, `quarkus.smallrye-health.liveness-path` and `quarkus.smallrye-health.readiness-path`.
More information about the health extension can be found in the relevant link:microprofile-health[guide].

=== Using the kubernetes client
=== Using the Kubernetes client

Applications, that are deployed to kubernetes and need to access the API server, will usually make use of the `kubernetes-client` exetension:
Applications that are deployed to Kubernetes and need to access the API server, will usually make use of the `kubernetes-client` extension:

[source,xml]
----
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-kubernetes</artifactId>
<artifactId>quarkus-kubernetes-client</artifactId>
</dependency>
----

To access the API server from within a kubernetes cluster, some RBAC related resources are required (e.g. a ServiceAccount, a RoleBinding etc).
So, when the `kubernetes-client` extension is present, those resources are going to be automatically created, so that application will be greanted the `view` role.
If more roles, are required they will have to be added manually.
To access the API server from within a Kubernetes cluster, some RBAC related resources are required (e.g. a ServiceAccount, a RoleBinding etc.).
So, when the `kubernetes-client` extension is present, the `kubernetes` extension is going to create those resources automatically, so that application will be granted the `view` role.
If more roles are required, they will have to be added manually.

== Tuning the generated resources using application.properties

Expand Down