Make prep-local explicit and update docs #587
Conversation
openshift-ci-robot
added
the
size/S
Makefile
Outdated
| # /var/run/secrets/kubernetes.io/serviceaccount | ||
| # Resetting a catasb cluster WILL generate new certs, so you will have to | ||
| # run prep-local again to export the new certs. | ||
| prep-local: |
There was a problem hiding this comment.
Does this need to be in .PHONY list?
There was a problem hiding this comment.
Add a comment after prep-local so that it shows up in the help.
prep-local: ## Prepares the local dev environment
Then test it with
$ make help
Usage: make <OPTIONS> ... <TARGETS>
Available targets are:
vendor Install or update project dependencies
broker Build the broker
build Build binary from source
lint Run golint
fmt Run go fmt
fmtcheck Check go formatting
test Run unit tests
...
There was a problem hiding this comment.
That's a nifty trick.
CONTRIBUTING.md
Outdated
| @@ -164,9 +161,13 @@ cp scripts/my_local_dev_vars.example scripts/my_local_dev_vars | |||
| Now you can modify `scripts/my_local_dev_vars` with things like your `DOCKERHUB_USERNAME` | |||
| or use an insecure broker with `BROKER_INSECURE="true"`. | |||
|
|
|||
| It is possible to use an etcd instance running locally on your host instead | |||
| of in-cluster. Simply set LOCAL_ETCD="true" in the my_local_dev_vars file, | |||
There was a problem hiding this comment.
change LOCAL_ETCD="true" to have the tick marks around it: LOCAL_ETCD="true"
CONTRIBUTING.md
Outdated
| @@ -207,6 +208,11 @@ registry: | |||
| org: example | |||
| ``` | |||
|
|
|||
| **NOTE**: It is important to explicitly run `make prep-local` every time a new | |||
| cluster has been setup, like reseting a catasb cluster, for example. The reason | |||
There was a problem hiding this comment.
TYPO: reseting -> resetting
CONTRIBUTING.md
Outdated
| @@ -207,6 +208,11 @@ registry: | |||
| org: example | |||
| ``` | |||
|
|
|||
| **NOTE**: It is important to explicitly run `make prep-local` every time a new | |||
| cluster has been setup, like reseting a catasb cluster, for example. The reason | |||
| is that the cluster's token/certs will have changed, so you will meed to `prep-local` | |||
There was a problem hiding this comment.
TYPO: meed to -> need to run
|
@jmrodri Updated. You're getting good at copy edit with all that blogging :P |
|
Changes Unknown when pulling dad2bdd on eriknelson:explicit-prep-local into ** on openshift:master**. |
|
Changes Unknown when pulling dad2bdd on eriknelson:explicit-prep-local into ** on openshift:master**. |
Describe what this PR does and why we need it:
I was continually running into unexpected behavior while resetting my catasb. Turns out the certs / tokens were getting regenerated in the cluster but were not being exported on my
make runs because the files already existed.I believe local developers should have an explicit "prep-local" target designed to setup a local environment with exported credentials, and a separate "make run" that is as thin as possible to facilitate rapid development iteration and testing.