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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix outdated contributing.md example #1511

Merged
merged 2 commits into from
Jul 19, 2021
Merged

Fix outdated contributing.md example #1511

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ed943c
Fix example cr manifest path
jan25 Jul 18, 2021
3eafa38
Merge branch 'master' into issue-1498
jpkrohling Jul 19, 2021
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
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ make run
At this point, a Jaeger instance can be installed:

```
kubectl apply -f deploy/examples/simplest.yaml
kubectl apply -f examples/simplest.yaml
kubectl get jaegers
kubectl get pods
```

To remove the instance:

```
kubectl delete -f deploy/examples/simplest.yaml
kubectl delete -f examples/simplest.yaml
```

Tests should be simple unit tests and/or end-to-end tests. For small changes, unit tests should be sufficient, but every new feature should be accompanied with end-to-end tests as well. Tests can be executed with:
Expand Down Expand Up @@ -77,7 +77,7 @@ kubectl get pods -n ingress-nginx
To verify that it's working, deploy the `simplest.yaml` and check the ingress routes:

```
$ kubectl apply -f deploy/examples/simplest.yaml
$ kubectl apply -f examples/simplest.yaml
jaeger.jaegertracing.io/simplest created
$ kubectl get ingress
NAME HOSTS ADDRESS PORTS AGE
Expand Down Expand Up @@ -124,7 +124,7 @@ The generated CSV yaml should then be compared and used to update the deploy/olm
The jaeger.clusterserviceversion.yaml file can then be tested with this command:

```
$ operator-sdk scorecard --cr-manifest deploy/examples/simplest.yaml --csv-path deploy/olm-catalog/jaeger.clusterserviceversion.yaml --init-timeout 30
$ operator-sdk scorecard --cr-manifest examples/simplest.yaml --csv-path deploy/olm-catalog/jaeger.clusterserviceversion.yaml --init-timeout 30
Checking for existence of spec and status blocks in CR
Checking that operator actions are reflected in status
Checking that writing into CRs has an effect
Expand Down