Skip to content

Commit d9582e1

Browse files
committed
Update README to document one-command installation
1 parent 8f716b9 commit d9582e1

File tree

1 file changed

+49
-5
lines changed

1 file changed

+49
-5
lines changed

README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,21 @@ The Weaviate Operator wraps the [weaviate-helm](https://github.com/weaviate/weav
3939

4040
There are multiple ways to run the operator:
4141

42-
1. Run the operator locally outside the cluster by executing the following command:
42+
1. The easiest way is to run the one-command Manifest:
43+
44+
```shell
45+
kubectl apply -f https://github.com/weaviate/weaviate-operator/releases/download/0.0.1/operator.yaml
46+
```
47+
48+
Other alternative ways to install it is:
49+
50+
1. Run the operator locally outside the cluster by executing the following command inside the `weaviate-operator` repository:
4351

4452
```shell
4553
make install run
4654
```
4755

48-
2. Run the operator as a Deployment inside the cluster by executing the following command:
56+
2. Run the operator as a Deployment inside the cluster by executing the following command inside the `weaviate-operator` repository:
4957

5058
```shell
5159
make deploy
@@ -75,13 +83,19 @@ To create the Weaviate CR, apply the modified `config/samples/apps_v1alpha1_weav
7583
kubectl apply -f config/samples/apps_v1alpha1_weaviatecluster.yaml -n weaviate
7684
```
7785

86+
make sure to create the namespace `weaviate` (or any other namespace in which you want you Weaviate nodes to run) in advance:
87+
88+
```shell
89+
kubectl create ns weaviate
90+
```
91+
7892
or simply create your own definition of the WeaviateCluster (based on the [weaviate-helm values.yaml](https://github.com/weaviate/weaviate-helm/blob/master/weaviate/values.yaml)):
7993

8094
```
8195
apiVersion: apps.weaviate.io/v1alpha1
8296
kind: WeaviateCluster
8397
metadata:
84-
name: weaviate_test_cluster
98+
name: weaviatecluster-sample
8599
namespace: weaviate
86100
spec:
87101
# Default values copied from <project_dir>/helm-charts/weaviate/values.yaml
@@ -101,9 +115,22 @@ apiVersion: apps.weaviate.io/v1alpha1
101115
storage:
102116
size: 32Gi
103117
```
118+
A new custom resource `weaviatecluster` will be now available:
119+
120+
```shell
121+
kubectl get weaviatecluster -n weaviate
122+
NAME AGE
123+
weaviatecluster-sample 13s
104124

125+
```
105126
The operator will create the statefulset for the CR based on the specified replica count and other configurations. Keep in mind that the resources will be created in the namespace you decide, in this example the `weaviate` namespace is used, but you can install it in any other namespace.
106127

128+
```shell
129+
kubectl get statefulset weaviate -n weaviate
130+
NAME READY AGE
131+
weaviate 3/3 65s
132+
```
133+
107134
## Troubleshooting
108135

109136
If you encounter any issues, you can check the operator logs using the following command:
@@ -120,11 +147,28 @@ kubectl describe weaviateclusters.apps.weaviate.io -n weaviate
120147

121148
## Cleanup
122149

123-
To clean up the resources, delete the custom resource using the following command:
150+
To clean up the `weaviatecluster` resources, delete the custom resource using the following command:
124151

125152
```shell
126153
kubectl delete -f config/samples/apps_v1alpha1_weaviatecluster.yaml -n weaviate
127154
```
155+
or deleting it directly:
156+
157+
```shell
158+
kubectl delete weaviatecluster weaviatecluster-sample -n weaviate
159+
```
160+
161+
Then, uninstall the operator either using the single-command manifest:
162+
163+
```shell
164+
kubectl delete -f https://github.com/weaviate/weaviate-operator/releases/download/0.0.1/operator.yaml
165+
```
166+
167+
or using the repo's Makefile, by running the following command inside the `weaviate-operator` repo:
168+
169+
```shell
170+
make undeploy
171+
```
128172

129-
Then, undeploy the operator using the `make undeploy` command or simply stop the process if you started it via `make install run`.
173+
or simply stop the process if you started it via `make install run`.
130174

0 commit comments

Comments
 (0)