Skip to content

Commit 5ddaf17

Browse files
Update installation.md (#15)
- remove duplicated words - add words for clarity - use VS code auto-formatter to clean up lines - expand words for clarity
1 parent d4a26ab commit 5ddaf17

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

docs/installation.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,23 @@
22

33
All described installation options will run the Operator inside the cluster.
44

5-
65
Make sure to clone this repository with its submodule (helm-charts).
76

87
```bash
98
git clone --recurse-submodules [email protected]:memgraph/kubernetes-operator.git
109
```
1110

12-
## Install K8 resources
11+
## Install K8 Resources
1312

1413
```bash
1514
make deploy
1615
```
1716

1817
This command will use operator's image from Memgraph's DockerHub and create all necessary Kubernetes resources for running an operator.
1918

20-
## Verify installation
19+
## Verify Installation
2120

22-
Installation using any of options described above will cause creating Kubernetes ServiceAccount, RoleBinding, Role, Deployment and Pods all in newly created all in newly created all in newly created
23-
namespace `memgraph-operator-system`. You can check your resources with:
21+
Installation using any of the options described above will create a Kubernetes ServiceAccount, RoleBinding, Role, Deployment, and Pods all in the newly created namespace `memgraph-operator-system`. You can check your resources with:
2422

2523
```bash
2624
kubectl get serviceaccounts -n memgraph-operator-system
@@ -40,7 +38,7 @@ kubectl get crds -A
4038

4139
## Start Memgraph High Availability Cluster
4240

43-
We already provide sample cluster in `config/samples/memgraph_v1_ha.yaml`. You only need to set your license information by
41+
We already provide a sample cluster in `config/samples/memgraph_v1_ha.yaml`. You only need to set your license information by
4442
creating a Kubernetes Secret containing licensing info. You can do this in a following way:
4543

4644
```bash
@@ -51,15 +49,13 @@ creating a Kubernetes Secret containing licensing info. You can do this in a fol
5149

5250
Start Memgraph HA cluster with `kubectl apply -f config/samples/memgraph_v1_ha.yaml`.
5351

54-
After approx. 60s, you should be able to see instances in the output of `kubectl get pods -A`.
55-
52+
After approximately 60 seconds, you should be able to see instances in the output of `kubectl get pods -A`.
5653

57-
You can now find URL of any coordinator instances by running e.g `minikube service list` and connect to see the state of the cluster by running
54+
You can now find the URL of any coordinator instances by running e.g `minikube service list` and connect to see the state of the cluster by running
5855
`show instances;`:
5956
![image](https://github.com/memgraph/kubernetes-operator/assets/53269502/c68d52e2-19f7-4e45-8ff0-fc2ee662c64b)
6057

61-
62-
## Clear resources
58+
## Clear Resources
6359

6460
```bash
6561
kubectl delete -f config/samples/memgraph_v1_ha.yaml # For deleting cluster

0 commit comments

Comments
 (0)