doc/sdk-cli-reference: Adding details for up/local command. #290
Conversation
doc/sdk-cli-reference.md
Outdated
| ``` | ||
|
|
||
| If you are planning on using a different namespace than the default, then you should use the namespace flag to change where the operator is watching for custom resources to be created. | ||
| For this to work your operator must handle the `WATCH_NAMESPACE` environment variable. To do that you can use the [utility function](https://github.com/operator-framework/operator-sdk/blob/89bf021063d18b6769bdc551ed08fc37027939d5/pkg/util/k8sutil/k8sutil.go#L140) `k8sutil.GetWatchNamespace` in your operator. |
There was a problem hiding this comment.
Prefer to use [utility function][utility_link] and provide
[utility_link]: https://github.com/operator-framework/operator-sdk/blob/89bf021063d18b6769bdc551ed08fc37027939d5/pkg/util/k8sutil/k8sutil.go#L140
at end of the file.
doc/sdk-cli-reference.md
Outdated
| operator-sdk up local --operator-flags "--resync-interval 10" | ||
| ``` | ||
|
|
||
| If you are planning on using a different namespace than the default, then you should use the namespace flag to change where the operator is watching for custom resources to be created. |
There was a problem hiding this comment.
should use the namespace flag than the default to
should use the --namespace flag than the default namespace?
There was a problem hiding this comment.
@fanminshi I'm sorry, but I am not following.
should use the namespace flag to change where the operator is watching for custom resources to be created.
Is this the part that you would like changed?
If it is I am not following this wording
If you are planning on using a different namespace than the default, then you should use the namespace flag than the default
There was a problem hiding this comment.
sorry for the confustion, I meant
If you are planning on using a different namespace than the default, then you should use the namespace flag ->
If you are planning on using a different namespace than the default, then you should use the --namespace flag
|
lgtm after nits. |
shawn-hurley
force-pushed
the
add-docs-266
branch
from
fb7db7f
to
f236cbe
Compare
adds details and more examples for `operator-sdk up local` flags Fixes operator-framework#266
shawn-hurley
force-pushed
the
add-docs-266
branch
from
f236cbe
to
b11c0a5
Compare
adds details and more examples for
operator-sdk up localflagsFixes #266