@@ -16,108 +16,20 @@ The Memgraph Operator automates the deployment and lifecycle management of Memgr
1616## Getting Started
1717
1818### Prerequisites
19- - go version v1.24.0+
20- - docker version 17.03+.
21- - kubectl version v1.11.3+.
22- - Access to a Kubernetes v1.11.3+ cluster.
19+ - Kubernetes 1.26+
20+ - Helm 3.x
2321
24- ### To Deploy on the cluster
25- ** Build and push your image to the location specified by ` IMG ` :**
22+ ### Installation
2623
27- ``` sh
28- make docker-build docker-push IMG=< some-registry> /memgraph-operator:tag
29- ```
30-
31- ** NOTE:** This image ought to be published in the personal registry you specified.
32- And it is required to have access to pull the image from the working environment.
33- Make sure you have the proper permission to the registry if the above commands don’t work.
34-
35- ** Install the CRDs into the cluster:**
36-
37- ``` sh
38- make install
39- ```
40-
41- ** Deploy the Manager to the cluster with the image specified by ` IMG ` :**
42-
43- ``` sh
44- make deploy IMG=< some-registry> /memgraph-operator: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- ** Create instances of your solution**
51- You can apply the samples (examples) from the config/sample:
52-
53- ``` sh
54- kubectl apply -k config/samples/
55- ```
56-
57- > ** NOTE** : Ensure that the samples has default values to test it out.
58-
59- ### To Uninstall
60- ** Delete the instances (CRs) from the cluster:**
61-
62- ``` sh
63- kubectl delete -k config/samples/
64- ```
65-
66- ** Delete the APIs(CRDs) from the cluster:**
24+ See the [ Helm chart repository] ( https://github.com/base-14/memgraph-operator-helm ) for installation instructions and configuration options.
6725
68- ``` sh
69- make uninstall
70- ```
71-
72- ** UnDeploy the controller from the cluster:**
73-
74- ``` sh
75- make undeploy
76- ```
77-
78- ## Project Distribution
79-
80- Following the options to release and provide this solution to the users.
81-
82- ### By providing a bundle with all YAML files
83-
84- 1 . Build the installer for the image built and published in the registry:
85-
86- ``` sh
87- make build-installer IMG=< some-registry> /memgraph-operator:tag
88- ```
89-
90- ** NOTE:** The makefile target mentioned above generates an 'install.yaml'
91- file in the dist directory. This file contains all the resources built
92- with Kustomize, which are necessary to install this project without its
93- dependencies.
94-
95- 2 . Using the installer
96-
97- Users can just run 'kubectl apply -f <URL for YAML BUNDLE >' to install
98- the project, i.e.:
26+ ### Uninstallation
9927
10028``` sh
101- kubectl apply -f https://raw.githubusercontent.com/ < org > / memgraph-operator/ < tag or branch > /dist/install.yaml
29+ helm uninstall memgraph-operator -n memgraph-system
10230```
10331
104- ### By providing a Helm Chart
105-
106- 1 . Build the chart using the optional helm plugin
107-
108- ``` sh
109- kubebuilder edit --plugins=helm/v1-alpha
110- ```
111-
112- 2 . See that a chart was generated under 'dist/chart', and users
113- can obtain this solution from there.
114-
115- ** NOTE:** If you change the project, you need to update the Helm Chart
116- using the same command above to sync the latest changes. Furthermore,
117- if you create webhooks, you need to use the above command with
118- the '--force' flag and manually ensure that any custom configuration
119- previously added to 'dist/chart/values.yaml' or 'dist/chart/manager/manager.yaml'
120- is manually re-applied afterwards.
32+ Note: CRDs and cluster resources persist after uninstallation. Delete them manually if complete cleanup is needed.
12133
12234## Metrics
12335
0 commit comments