From d4a26ab6d50c90b83f78a9ea3ec2785678af78aa Mon Sep 17 00:00:00 2001 From: Andi Date: Wed, 14 Aug 2024 10:49:59 +0200 Subject: [PATCH] Update docs and bump to version 1.0.0 (#12) --- Makefile | 2 +- README.md | 94 ------------------------------- api/v1/memgraphha_types.go | 3 + config/manager/kustomization.yaml | 4 +- config/manager/manager.yaml | 2 +- helm-charts | 2 +- 6 files changed, 8 insertions(+), 99 deletions(-) diff --git a/Makefile b/Makefile index 47ee782..a4234e4 100644 --- a/Makefile +++ b/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") diff --git a/README.md b/README.md index 9f258ea..4e63d94 100644 --- a/README.md +++ b/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=/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=/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. diff --git a/api/v1/memgraphha_types.go b/api/v1/memgraphha_types.go index 07b276d..ade40e6 100644 --- a/api/v1/memgraphha_types.go +++ b/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{}) } diff --git a/config/manager/kustomization.yaml b/config/manager/kustomization.yaml index 17c72cf..c4879ff 100644 --- a/config/manager/kustomization.yaml +++ b/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 diff --git a/config/manager/manager.yaml b/config/manager/manager.yaml index 0c8b2d1..2455004 100644 --- a/config/manager/manager.yaml +++ b/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 diff --git a/helm-charts b/helm-charts index 3fecad8..a2f3d48 160000 --- a/helm-charts +++ b/helm-charts @@ -1 +1 @@ -Subproject commit 3fecad84b3c3fecd9c2ef19b942f4fc4065ce6f6 +Subproject commit a2f3d480cfa4efd3cd32935cd58391c914fb8296