Skip to content
This repository was archived by the owner on Nov 18, 2020. It is now read-only.

cleanup the e2e help text and help target #75

Merged
merged 1 commit into from
Oct 15, 2019
Merged

cleanup the e2e help text and help target #75

Show file tree
Hide file tree
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions memcached-operator/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ code-gen: ## Run the operator-sdk commands to generated code (k8s and openapi)

##@ Tests

test-e2e: ## Run integration tests. This command will execute many times the same e2e tests. Its purposes is just to illustrate few options. For further info see: https://github.com/operator-framework/operator-sdk/blob/master/doc/test-framework/writing-e2e-tests.md
@echo ... Running the same e2e tests with some few options of args ...
test-e2e: ## Run integration e2e tests with different options.
@echo ... Running the same e2e tests with different args ...
@echo ... Running locally ...
- operator-sdk test local ./test/e2e --up-local --namespace=${NAMESPACE}
@echo ... Running NOT in parallel ...
Expand All @@ -71,5 +71,8 @@ test-e2e: ## Run integration tests. This command will execute many times the sam
- operator-sdk test local ./test/e2e --verbose

.PHONY: help
help: ## Display this help
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
help: ## Display this help
@echo -e "Usage:\n make \033[36m<target>\033[0m"
@awk 'BEGIN {FS = ":.*##"}; \
/^[a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } \
/^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
20 changes: 11 additions & 9 deletions memcached-operator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,23 +52,25 @@ $ sed -i 's|REPLACE_IMAGE|quay.io/example-inc/memcached-operator|g' deploy/opera
$ sed -i "" 's|REPLACE_IMAGE|quay.io/example-inc/memcached-operator|g' deploy/operator.yaml
```

**NOTE** The `quay.io/example-inc/memcached-operator` is an example. You should build and push the image for your repository.
**NOTE** The `quay.io/example-inc/memcached-operator` is an example. You should build and push the image for your repository.

### Installing

Run `make install` to install the operator. Check that the operator is running in the cluster, also check that the example Memcached service was deployed.

### Uninstalling
### Uninstalling

To uninstall all that was performed in the above step run `make uninstall`.

[dep_tool]:https://golang.github.io/dep/docs/installation.html
[go_tool]:https://golang.org/dl/
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
[docker_tool]:https://docs.docker.com/install/
[operator_sdk]:https://github.com/operator-framework/operator-sdk
[operator_install]:https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md
[dep_tool](https://golang.github.io/dep/docs/installation.html)
[go_tool](https://golang.org/dl/)
[kubectl_tool](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
[docker_tool](https://docs.docker.com/install/)
[operator_sdk](https://github.com/operator-framework/operator-sdk)
[operator_install](https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md)

### Run Tests

Run `make test-e2e` to run integration tests. This command will execute many times the same e2e tests. Its purposes is just to illustrate few options.
Run `make test-e2e` to run the integration e2e tests with different options. For
more information see the [writing e2e tests](https://github.com/operator-framework/operator-sdk/blob/master/doc/test-framework/writing-e2e-tests.md) guide.