Update docs and bump to version 1.0.0 (#12)

Author: as51340

Makefile

@@ -3,7 +3,7 @@
 # To re-generate a bundle for another specific version without changing the standard setup, you can:
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
-VERSION ?= 0.0.4
+VERSION ?= 1.0.0
 
 # CHANNELS define the bundle channels used in the bundle.
 # Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")

README.md

@@ -25,97 +25,3 @@ Check our [Documentation](/docs) to start using our Kubernetes operator.
 ## License
 
 Please check the [LICENSE](LICENSE) file
-
-
-# new stuff from go
-
-# kubernetes-operator
-// TODO(user): Add simple overview of use/purpose
-
-## Description
-// TODO(user): An in-depth paragraph about your project and overview of use
-
-## Getting Started
-
-### Prerequisites
-- go version v1.20.0+
-- docker version 17.03+.
-- kubectl version v1.11.3+.
-- Access to a Kubernetes v1.11.3+ cluster.
-
-### To Deploy on the cluster
-**Build and push your image to the location specified by `IMG`:**
-
-```sh
-make docker-build docker-push IMG=<some-registry>/kubernetes-operator:tag
-```
-
-**NOTE:** This image ought to be published in the personal registry you specified.
-And it is required to have access to pull the image from the working environment.
-Make sure you have the proper permission to the registry if the above commands don’t work.
-
-**Install the CRDs into the cluster:**
-
-```sh
-make install
-```
-
-**Deploy the Manager to the cluster with the image specified by `IMG`:**
-
-```sh
-make deploy IMG=<some-registry>/kubernetes-operator:tag
-```
-
-> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
-privileges or be logged in as admin.
-
-**Create instances of your solution**
-You can apply the samples (examples) from the config/sample:
-
-```sh
-kubectl apply -k config/samples/
-```
-
->**NOTE**: Ensure that the samples has default values to test it out.
-
-### To Uninstall
-**Delete the instances (CRs) from the cluster:**
-
-```sh
-kubectl delete -k config/samples/
-```
-
-**Delete the APIs(CRDs) from the cluster:**
-
-```sh
-make uninstall
-```
-
-**UnDeploy the controller from the cluster:**
-
-```sh
-make undeploy
-```
-
-## Contributing
-// TODO(user): Add detailed information on how you would like others to contribute to this project
-
-**NOTE:** Run `make help` for more information on all potential `make` targets
-
-More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
-
-## License
-
-Copyright 2024 Memgraph Ltd.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

api/v1/memgraphha_types.go

@@ -128,5 +128,8 @@ type MemgraphHAList struct {
 }
 
 func init() {
+	// A Scheme is an abstraction used to register the API objects
+	// as Group-Version-Kinds, convert between API Objects of various
+	// versions and serialize/deserialize API Objects
 	SchemeBuilder.Register(&MemgraphHA{}, &MemgraphHAList{})
 }

config/manager/kustomization.yaml

@@ -6,7 +6,7 @@ kind: Kustomization
 images:
 - name: controller
   newName: memgraph/kubernetes-operator
-  newTag: 0.0.4
+  newTag: 1.0.0
 - name: memgraph-kubernetes-operator
   newName: memgraph/kubernetes-operator
-  newTag: 0.0.4
+  newTag: 1.0.0

config/manager/manager.yaml

@@ -25,7 +25,7 @@ spec:
         runAsNonRoot: true
       containers:
       - args:
-        image: memgraph/kubernetes-operator:0.0.4
+        image: memgraph/kubernetes-operator:1.0.0
         name: manager
         securityContext:
           readOnlyRootFilesystem: true