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鈥檒l 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

merged 1 commit into from
May 22, 2018

Conversation

etiennecoutaud
Copy link
Contributor

@etiennecoutaud etiennecoutaud commented May 17, 2018 •
edited
Loading

Refers to #253

@fanminshi Should we document operator-sdk up local in README ?

Feedbacks are welcome for user-guide.md proposal 馃槃

@etiennecoutaud etiennecoutaud changed the title WIP: doc/user-guide: Document operator-sdk up local [WIP] doc/user-guide: Document operator-sdk up local May 17, 2018
@fanminshi
Copy link
Contributor

Thanks for taking on this issue. I'd suggest us to wait until this #255 is resolved before we update the doc for it.

xiang90
xiang90 reviewed May 18, 2018
View reviewed changes
doc/user-guide.md Outdated
- As go program outside cluster

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably mention that this is the suggested production setup, since we mention the out-cluster one is for dev and test.

Copy link
Contributor Author

@etiennecoutaud etiennecoutaud May 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea, done

xiang90
xiang90 reviewed May 18, 2018
View reviewed changes
doc/user-guide.md Outdated
This method is prefered during development cycle to deploy and test faster.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

empty line between code block and content.

xiang90
xiang90 reviewed May 18, 2018
View reviewed changes
doc/user-guide.md Outdated
```

Run the operator localy with a provided kubernetes config file
```sh
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

empty line between code block and content.

@etiennecoutaud etiennecoutaud force-pushed the uplocal-doc branch 2 times, most recently from def5398 to 7a61593 Compare May 18, 2018 09:04
fanminshi
fanminshi reviewed May 18, 2018
View reviewed changes
doc/user-guide.md Outdated
@@ -90,6 +90,15 @@ Replace the default handler with the reference [memcached handler][memcached_han

### Build and run the operator

There is 2 ways to run the operator:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

prefer to use two instead of 2.

doc/user-guide.md Outdated
- As pod inside Kubernetes cluster
- As go program outside cluster

#### 1. Run as pod inside Kubernetes cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run as pod inside Kubernetes cluster -> Run as pod inside a Kubernetes cluster

doc/user-guide.md Outdated

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

Run as pod inside Kubernetes cluster is prefered for production use.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inside Kubernetes cluster -> inside a Kubernetes cluster

doc/user-guide.md Outdated
INFO[0000] operator-sdk Version: 0.0.5+git
```

Run the operator localy with a provided kubernetes config file
Copy link
Contributor

@fanminshi fanminshi May 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add : as .. file: to be consistent with rest of the doc.

@fanminshi
Copy link
Contributor

Should we document operator-sdk up local in README

Probably not now. I need to re-think how the readme should be like.

@etiennecoutaud
Copy link
Contributor Author

@fanminshi No problem, If you need help to re-think the README do not hesitate to ask ;)

@fanminshi
Copy link
Contributor

@etiennecoutaud thanks. LGTM

@fanminshi
Copy link
Contributor

@etiennecoutaud you can remove WIP from commit message and merge this pr.

@fanminshi
Copy link
Contributor

Due to a recent issue arisen from #273, we need to indicate the watched namespaceWATCH_NAMESPACE="default" operator-sdk up local. Could you update the user_guilde accordingly?

@etiennecoutaud
Copy link
Contributor Author

Update done

@fanminshi
Copy link
Contributor

@etiennecoutaud also remove the WIP from commit msg? We can merge this pr as it it. Once #273 is fixed, we probably need to update the user_guide again. I think that's fine for now.

@etiennecoutaud etiennecoutaud changed the title [WIP] doc/user-guide: Document operator-sdk up local doc/user-guide: Document operator-sdk up local May 22, 2018
@etiennecoutaud
Copy link
Contributor Author

Yes we will update after #273 fixed

@fanminshi fanminshi merged commit 2fbaa01 into operator-framework:master May 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xiang90 xiang90 xiang90 left review comments

@fanminshi fanminshi fanminshi left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@etiennecoutaud @fanminshi @xiang90