Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc/user-guide: Document operator-sdk up local #261

Merged
merged 1 commit into from
May 22, 2018
Merged

doc/user-guide: Document operator-sdk up local #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions doc/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,15 @@ Replace the default handler with the reference [memcached handler][memcached_han

### Build and run the operator

There is two ways to run the operator:

- As pod inside Kubernetes cluster
- As go program outside cluster

#### 1. Run as pod inside a Kubernetes cluster

Run as pod inside a Kubernetes cluster is prefered for production use.

Build the memcached-operator image and push it to a registry:
```
$ operator-sdk build quay.io/example/memcached-operator:v0.0.1
Expand All @@ -115,6 +124,30 @@ NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
memcached-operator 1 1 1 1 1m
```

#### 2. Run outside the cluster

This method is prefered during development cycle to deploy and test faster.

Set `WATCH_NAMESPACE` env var to specify which namespace will be watch by the operator.

Run the operator localy with the default kubernetes config file present at `$HOME/.kube/config`:

```sh
$ WATCH_NAMESPACE="default" operator-sdk up local
INFO[0000] Go Version: go1.10
INFO[0000] Go OS/Arch: darwin/amd64
INFO[0000] operator-sdk Version: 0.0.5+git
```

Run the operator localy with a provided kubernetes config file:

```sh
$ WATCH_NAMESPACE="default" operator-sdk up local --kubeconfig=config
INFO[0000] Go Version: go1.10
INFO[0000] Go OS/Arch: darwin/amd64
INFO[0000] operator-sdk Version: 0.0.5+git
```

### Create a Memcached CR

Modify `deploy/cr.yaml` as shown and create a `Memcached` custom resource:
Expand Down