Skip to content

Commit d118a76

Browse files
authored
Update README.md to clarify prerequisites (#32)
* Update README.md to clarify prerequisites * newsfile * suggestions * Moved private registry auth section
1 parent 06896ff commit d118a76

File tree

2 files changed

+38
-6
lines changed

2 files changed

+38
-6
lines changed

README.md

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,21 @@ Pre-built binaries are available from the [releases page](https://github.com/Arm
2424

2525
### Prerequsites
2626

27-
- `kubectl` - `kubearchinspect` must be executed on a client with `kubectl` installed and configured to connect
28-
to the target Kubernetes cluster. If multiple clusters are configured, it will query the cluster in the current
29-
default context.
30-
- `docker` client - The Docker credential store is used to authenticate to private registries, use [`docker login`](https://docs.docker.com/reference/cli/docker/login/) to add credentials.
27+
This tool includes built-in kubectl and container registry support using the [containers/image](https://github.com/containers/image) library.
28+
You do not need the kubectl, docker, podman, or skopeo CLI tools installed — only their configuration files.
29+
30+
#### Kubernetes Configuration
31+
32+
**Kubeconfig** (`~/.kube/config` or set via the `--kube-config-path` flag)
33+
Required to connect to the target Kubernetes cluster.
34+
35+
Example: For AWS EKS clusters, configure access with:
36+
37+
```shell
38+
aws eks update-kubeconfig --region <region> --name <cluster_name>
39+
```
40+
41+
If multiple clusters are configured in the `kubeconfig`, the tool will use the default context unless specified using `--kube-context` flag.
3142

3243
### Usage
3344

@@ -107,8 +118,28 @@ If there is an error whilst checking an image, the tool will display the 🚫 sy
107118

108119
## Private Registry Authentication
109120

110-
If `kubearchinspect` discovers an image from a registry that requires authentication, it uses the `docker` credential
111-
store located at `~/.docker/config.json` to obtain the required credentials.
121+
**Registry credentials** (`~/.docker/config.json` or `$XDG_RUNTIME_DIR/containers/auth.json`)
122+
Required only for accessing **private container registries**.
123+
124+
> Many organisations and teams use private registries to store their container images for security, compliance, or version control.
125+
> These images are not publicly accessible and require authentication.
126+
127+
The tool relies on `containers/image`, which uses the same credential configuration as:
128+
129+
- [`docker login`](https://docs.docker.com/reference/cli/docker/login/)
130+
- [`podman login`](https://docs.podman.io/en/latest/markdown/podman-login.1.html)
131+
- [`skopeo login`](https://man.archlinux.org/man/extra/skopeo/skopeo-login.1.en)
132+
- [`buildah login`](https://manpages.ubuntu.com/manpages/jammy/man1/buildah-login.1.html)
133+
134+
Any of these commands will populate or update the config file, which includes the necessary authentication tokens or credential store references.
135+
136+
> Tip: You can use any of the above tools to authenticate. For example:
137+
138+
```shell
139+
podman login <registry>
140+
```
141+
142+
Credential helpers defined in the config file (such as `credHelpers` or `credsStore`) are also supported.
112143

113144
## Releases
114145

changes/32.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update README.md to clarify prerequisites regarding the kube config and container registry authentication

0 commit comments

Comments
 (0)