Skip to content

Commit 337bd1e

Browse files
committed
Update README
1 parent 2e77d04 commit 337bd1e

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# LocalStack Kubernetes Operator
22

3-
WIP
3+
## Requirements
4+
5+
The LocalStack operator requires a LocalStack [auth token](https://docs.localstack.cloud/aws/getting-started/auth-token/) to authorize the use of the operator.
6+
7+
## Installation
8+
9+
You can use `kubectl` to install the LocalStack Operator into your cluster:
10+
11+
```bash
12+
# latest version
13+
kubectl apply -f https://github.com/localstack/localstack-operator-public/releases/latest/download/controller.yaml
14+
15+
# or specific version, e.g. v0.3.3
16+
kubectl apply -f https://github.com/localstack/localstack-operator-public/releases/v0.3.3/download/controller.yaml
17+
```
18+
19+
## CRD definition
20+
21+
The operator includes a `LocalStack` CRD which defines your LocalStack instance.
22+
23+
Details TBD

0 commit comments

Comments
 (0)