📖adding a note in deploy-image plugin doc #2854
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
cncf-cla: yes
NikhilSharmaWe
force-pushed
the
docFix
branch
3 times, most recently
from
a8046e7 to
a96e58c
Compare
k8s-ci-robot
added
size/S
| ``` | ||
|
|
||
| <aside class="note"> | ||
| <h1> Running operator locally </h1> |
There was a problem hiding this comment.
Suggested change
| <h1> Running operator locally </h1> | |
| <h1>Using make run</h1> | |
| kubebuilder create api --group example.com --version v1alpha1 --kind Memcached --image=memcached:1.6.15-alpine --image-container-command="memcached,-m=64,modern,-v" --image-container-port="11211" --run-as-user="1001" --plugins="deploy-image/v1-alpha" | ||
| ``` | ||
|
|
||
| <aside class="note"> |
There was a problem hiding this comment.
Suggested change
| <aside class="note"> | |
| <aside class="warning"> | |
| <aside class="note"> | ||
| <h1> Running operator locally </h1> | ||
|
|
||
| For running an operator made with deploy-image plugin locally, the envvar added in `config/manager/manager.yaml` which stores the value of the image needs to be exported before running the operator locally or out of the cluster. |
There was a problem hiding this comment.
Suggested change
| For running an operator made with deploy-image plugin locally, the envvar added in `config/manager/manager.yaml` which stores the value of the image needs to be exported before running the operator locally or out of the cluster. | |
| The `make run` will execute the `main.go` outside of the cluster to let you test the project running it locally. Note that by using this plugin the Operand image informed will be stored via an environment variable in the `config/manager/manager.yaml` manifest. | |
| Therefore, before run `make run` you need to export any environment variable that you might have. Example: | |
| ```sh | |
| export MEMCACHED_IMAGE="memcached:1.4.36-alpine" |
6f89248 to
59fc153
Compare
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, NikhilSharmaWe The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added a note in deploy-image plugin documentation that users should keep in mind while running the operator locally.