Skip to content
This repository was archived by the owner on Apr 10, 2024. It is now read-only.

Commit a574ebc

Browse files
committed
docs: readme corrections
1 parent 5ae69a1 commit a574ebc

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class JUnitExtensionTest {
5252
}
5353
```
5454

55-
### API
55+
### Public API
5656

5757
The underlying API can be used directly.
5858
See [KubeApiServer](https://github.com/java-operator-sdk/jenvtest/blob/main/core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServer.java#L47-L47)
@@ -98,7 +98,7 @@ An additional benefits os running K8S API Server this way, is that it makes easy
9898
and/or
9999
[Dynamic Admission Controllers](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/)
100100

101-
In general using additional standard frameworks to implement webhookhooks is adviced,
101+
In general, it is a best practice to use additional standard frameworks to implement Kubernetes webhooks,
102102
like [kubernetes-webooks-framework](https://github.com/java-operator-sdk/kubernetes-webooks-framework)
103103
with Quarkus or Spring. However, we demonstrate how it works
104104
in [this test](https://github.com/java-operator-sdk/jenvtest/blob/main/samples/src/test/java/io/javaoperatorsdk/jenvtest/KubernetesMutationHookHandlingTest.java#L53-L53)
@@ -112,9 +112,10 @@ All the certificates for the Kube API Server and for the client is generated. Th
112112

113113
#### Downloading binaries
114114

115-
Binaries are downloaded automatically under ~/.jenvtest/k8s/[target-platform-and-version].
115+
Binaries are downloaded automatically under ~/.jenvtest/k8s/[target-platform-and-version] if no binary found locally.
116+
If there are multiple binaries found, the latest if selected (unless a target version is not specified).
116117

117118
Also [`setup-envtest`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/tools/setup-envtest#section-readme) can be used
118119
to download binaries manually. By executing `setup-envtest use --bin-dir ~/.jenvtest` will download the latest required
119-
binaries to the default directory.
120+
binaries to the default directory. This is useful if always running the tests in offline mode.
120121

0 commit comments

Comments
 (0)