@@ -46,7 +46,8 @@ make undeploy
46
46
```
47
47
48
48
## Contributing
49
- // TODO(user): Add detailed information on how you would like others to contribute to this project
49
+
50
+ Refer to [ CONTRIBUTING.md] ( ./CONTRIBUTING.md ) for more information.
50
51
51
52
### How it works
52
53
This project aims to follow the Kubernetes [ Operator pattern] ( https://kubernetes.io/docs/concepts/extend-kubernetes/operator/ )
@@ -55,19 +56,13 @@ It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controlle
55
56
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
56
57
57
58
### Test It Out
58
- 1 . Install the CRDs into the cluster:
59
-
60
- ``` sh
61
- make install
62
- ```
63
-
64
- 2 . Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
65
59
60
+ Install the CRDs and the operator-controller into a new [ KIND cluster] ( https://kind.sigs.k8s.io/ ) :
66
61
``` sh
67
62
make run
68
63
```
69
-
70
- ** NOTE: ** You can also run this in one step by running: ` make install run `
64
+ This will build a local container image of the operator-controller, create a new KIND cluster and then deploy onto that cluster.
65
+ This will also deploy the catalogd, rukpak and cert-manager dependencies.
71
66
72
67
### Modifying the API definitions
73
68
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
@@ -76,13 +71,13 @@ If you are editing the API definitions, generate the manifests such as CRs or CR
76
71
make manifests
77
72
```
78
73
79
- ** NOTE:** Run ` make -- help ` for more information on all potential ` make ` targets
74
+ ** NOTE:** Run ` make help ` for more information on all potential ` make ` targets
80
75
81
76
More information can be found via the [ Kubebuilder Documentation] ( https://book.kubebuilder.io/introduction.html )
82
77
83
78
## License
84
79
85
- Copyright 2022.
80
+ Copyright 2022-2023 .
86
81
87
82
Licensed under the Apache License, Version 2.0 (the "License");
88
83
you may not use this file except in compliance with the License.
0 commit comments