Skip to content

Commit

Permalink
add pre-requisites and caution message
Browse files Browse the repository at this point in the history
  • Loading branch information
sircthulhu committed Mar 31, 2024
1 parent 1a83fa1 commit a9b78a8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
10 changes: 7 additions & 3 deletions site/content/en/docs/v0.1/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,25 @@ Follow these instructions to install, run, and test etcd with etcd-operator in a

Pre-requisites:
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [kustomize](https://github.com/kubernetes-sigs/kustomize)
- Kubernetes cluster and `kubectl` configured to use it
- If you don't have a Kubernetes cluster, you can use [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) to create a local one
- cert-manager installed in the cluster

1. Install etcd-operator:
```bash
kustomize build 'https://github.com/aenix-io/etcd-operator//config/default?ref=main' | kubectl apply -n etcd-operator -f -
kustomize build 'https://github.com/aenix-io/etcd-operator//config/default?ref=main' | kubectl apply -f -
```
2. Check the operator is running:
```bash
kubectl get pods -n etcd-operator -l control-plane=controller-manager
kubectl get pods -n etcd-operator-system -l control-plane=controller-manager
```
3. Create an etcd cluster:
```bash
kubectl apply -f https://raw.githubusercontent.com/aenix-io/etcd-operator/main/config/samples/etcd_v1alpha1_etcdcluster.yaml
kubectl apply -f https://raw.githubusercontent.com/aenix-io/etcd-operator/main/config/samples/etcd.aenix.io_v1alpha1_etcdcluster.yaml
```
**Caution**: by default emptyDir storage is used. It means such cluster configuration is not intended for long-term storage.

4. Check the etcd cluster is running:
```bash
kubectl get pods -l app.kubernetes.io/managed-by=etcd-operator
Expand Down
1 change: 1 addition & 0 deletions site/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ services:

site:
image: docsy/docsy-example
platform: linux/amd64
build:
context: .
command: server
Expand Down

0 comments on commit a9b78a8

Please sign in to comment.