Skip to content

Commit 2e963ae

Browse files
committed
adapt readme
1 parent 97aa166 commit 2e963ae

File tree

1 file changed

+14
-47
lines changed

1 file changed

+14
-47
lines changed

README.md

Lines changed: 14 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ SPDX-FileCopyrightText: Copyright 2024 SAP SE or an SAP affiliate company and co
33
44
SPDX-License-Identifier: Apache-2.0
55
-->
6-
# kvm-node-agent
6+
# kvm-node-agent [![REUSE status](https://api.reuse.software/badge/github.com/cobaltcore-dev/kvm-node-agent)](https://api.reuse.software/info/github.com/cobaltcore-dev/kvm-node-agent) [![Checks](https://github.com/cobaltcore-dev/kvm-node-agent/actions/workflows/checks.yaml/badge.svg)](https://github.com/cobaltcore-dev/kvm-node-agent/actions/workflows/checks.yaml)
77

88
KVM Node agent for controlling Hypervisor objects via Kubernetes API.
99

@@ -19,64 +19,31 @@ The KVM node agent is a kubernetes operator that runs on every KVM node provides
1919
- kubectl version v1.11.3+.
2020
- Access to a Kubernetes v1.11.3+ cluster.
2121

22-
### To Deploy on the cluster
23-
**Build and push your image to the location specified by `IMG`:**
22+
### Building
2423

25-
```sh
26-
make docker-build docker-push IMG=<some-registry>/kvm-node-agent:tag
27-
```
28-
29-
**NOTE:** This image ought to be published in the personal registry you specified.
30-
And it is required to have access to pull the image from the working environment.
31-
Make sure you have the proper permission to the registry if the above commands don’t work.
32-
33-
#### Installation via *kustomize*
24+
To build the KVM node agent binary, run:
3425

35-
**Install the CRDs into the cluster:**
36-
37-
```sh
38-
make install
26+
```bash
27+
make build-all
3928
```
4029

41-
**Deploy the Manager to the cluster with the image specified by `IMG`:**
42-
43-
```sh
44-
make deploy IMG=<some-registry>/kvm-node-agent:tag
45-
```
46-
47-
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
48-
privileges or be logged in as admin.
49-
50-
#### Installation via *Helm*
30+
The compiled binary will be available at `build/manager`.
5131

52-
Install CRDs and Controller
32+
To install the binary to your system:
5333

54-
```sh
55-
helm upgrade --install kvm-node-agent charts/kvm-node-agent
34+
```bash
35+
make install
5636
```
5737

58-
### To Uninstall
59-
60-
61-
#### via *kustomize*
62-
63-
**Delete the APIs(CRDs) from the cluster:**
38+
### Installing CRDs
6439

65-
```sh
66-
make uninstall
67-
```
68-
69-
**UnDeploy the controller from the cluster:**
40+
To install the Custom Resource Definitions (CRDs) into your Kubernetes cluster:
7041

71-
```sh
72-
make undeploy
42+
```bash
43+
make install-crds
7344
```
7445

75-
#### via *Helm*
76-
77-
```sh
78-
helm delete kvm-node-agent
79-
```
46+
This command generates the necessary CRD manifests and applies them to the cluster specified in your `~/.kube/config`. The CRDs define the `Hypervisor` and `Migration` custom resources that the KVM node agent uses to manage KVM instances.
8047

8148
## Support, Feedback, Contributing
8249

0 commit comments

Comments
 (0)