Skip to content

Commit

Permalink
docs: Remove unnecessary version numbers (#625)
Browse files Browse the repository at this point in the history
  • Loading branch information
wetted authored Aug 4, 2023
1 parent f2583ed commit d03abdc
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 12 deletions.
8 changes: 4 additions & 4 deletions src/main/docs/guide/kubernetes-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The complete list of available beans is declared in the link:{sourcedir}/kuberne

First you need add a dependency on the `micronaut-kubernetes-client` module:

dependency:io.micronaut.kubernetes:micronaut-kubernetes-client:{version}[]
dependency:io.micronaut.kubernetes:micronaut-kubernetes-client[]

Then you can simply use Micronaut injection to get configured apis object from package `io.kubernetes.client.openapi.apis` :

Expand Down Expand Up @@ -60,7 +60,7 @@ In addition to the official Kubernetes Java SDK `Async` clients, this module pro

For RxJava 2 add the following dependency:

dependency:io.micronaut.kubernetes:micronaut-kubernetes-client-rxjava2:{version}[]
dependency:io.micronaut.kubernetes:micronaut-kubernetes-client-rxjava2[]

The module contains all official Kubernetes API beans in format `<ApiClassName>RxClient`,
for example the `CoreV1Api` class is injected as `CoreV1ApiRxClient`.
Expand Down Expand Up @@ -92,7 +92,7 @@ public class MyService {

For RxJava 3 add the following dependency:

dependency:io.micronaut.kubernetes:micronaut-kubernetes-client-rxjava3:{version}[]
dependency:io.micronaut.kubernetes:micronaut-kubernetes-client-rxjava3[]

The module contains all official Kubernetes API beans in format `<ApiClassName>RxClient`,
for example the `CoreV1Api` class is injected as `CoreV1ApiRxClient`.
Expand Down Expand Up @@ -124,7 +124,7 @@ public class MyService {

For Reactor add the following dependency:

dependency:io.micronaut.kubernetes:micronaut-kubernetes-client-reactor:{version}[]
dependency:io.micronaut.kubernetes:micronaut-kubernetes-client-reactor[]

The module contains all official Kubernetes API beans in format `<ApiClassName>ReactiveClient`,
for example the `CoreV1Api` class is injected as `CoreV1ApiReactiveClient`.
Expand Down
2 changes: 1 addition & 1 deletion src/main/docs/guide/kubernetes-informer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The `micronaut-kubernetes-informer` module integrates the https://javadoc.io/doc

First you need add a dependency on the `micronaut-kubernetes-informer` module:

dependency:io.micronaut.kubernetes:micronaut-kubernetes-informer:{version}[]
dependency:io.micronaut.kubernetes:micronaut-kubernetes-informer[]

Then create a bean that implements https://javadoc.io/doc/io.kubernetes/client-java/latest/io/kubernetes/client/informer/ResourceEventHandler.html[ResourceEventHandler] with the Kubernetes resource type of your choice and add the ann:kubernetes.client.informer.Informer[] annotation trough which you provide the configuration for the https://javadoc.io/doc/io.kubernetes/client-java/latest/io/kubernetes/client/informer/SharedIndexInformer.html[SharedIndexInformer].

Expand Down
4 changes: 2 additions & 2 deletions src/main/docs/guide/kubernetes-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The `micronaut-kubernetes-operator` module integrates the official Kubernetes Ja

First you need add a dependency on the `micronaut-kubernetes-operator` module:

dependency:io.micronaut.kubernetes:micronaut-kubernetes-operator:{version}[]
dependency:io.micronaut.kubernetes:micronaut-kubernetes-operator[]

Then create a bean that implements api:kubernetes.client.operator.ResourceReconciler[] with the Kubernetes resource type of your choice. Then add the ann:kubernetes.client.operator.Operator[] annotation trough the which you provide the configuration for the controllers that will be created by Micronaut for your reconciler.

Expand Down Expand Up @@ -130,4 +130,4 @@ Example below illustrates the configuration of the filters:
snippet::io.micronaut.kubernetes.client.operator.ConfigMapResourceReconcilerWithFilters[tags="reconciler", project="kubernetes-operator", source="test"]
<1> Configuration of `onAddFilter`.
<2> Configuration of `onUpdateFilter`.
<3> Configuration of `onAddFilter`.
<3> Configuration of `onAddFilter`.
8 changes: 3 additions & 5 deletions src/main/docs/guide/service-discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ The Service Discovery module allows Micronaut HTTP clients to discover Kubernete

To get started, you need to declare the following dependency:

dependency:io.micronaut.kubernetes:micronaut-kubernetes-discovery-client:{version}[]
dependency:io.micronaut.kubernetes:micronaut-kubernetes-discovery-client[]

By default in any client you can use as Service ID the Kubernetes `Endpoints` name generated by a Kubernetes `Service` for the configured namespace.

Expand Down Expand Up @@ -177,12 +177,10 @@ Both discovery modes support watching for changes of their respective resources.

Micronaut authenticates to the Kubernetes API using the token mounted at `/var/run/secrets/kubernetes.io/serviceaccount/token`.
Note that by default, the service account used may only have permissions over the `kube-system` namespace. The service discovery
functionality requires some additiona read permissions. Refer to the
https://kubernetes.io/docs/reference/access-authn-authz/rbac/[Kubernetes documentation] for more information
functionality requires some additiona read permissions. Refer to the https://kubernetes.io/docs/reference/access-authn-authz/rbac/[Kubernetes documentation] for more information
about Role-based access control (RBAC).

One of the options is to create the following `Role` and `RoleBinding` (make sure to apply them to the service account used,
if not `default`):
One of the options is to create the following `Role` and `RoleBinding` (make sure to apply them to the service account used, if not `default`):

[source,yaml]
.`auth.yml`
Expand Down

0 comments on commit d03abdc

Please sign in to comment.