Skip to content

Commit

Permalink
Update Tests and Troubleshooting in readme
Browse files Browse the repository at this point in the history
Incldue troubleshooting steps and usage of FAR E2E on AWS
  • Loading branch information
razo7 committed Sep 19, 2023
1 parent 8eb537f commit 6d5e407
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,20 @@ spec:

### Run code checks and unit tests

`make test`
Run `make test`

### Run e2e tests

1. Deploy the operator as explained above
2. Run `make test-e2e`
2. (Only for AWS platforms) Run `make ocp-aws-credentials` to add sufficient [CredentialsRequest](https://github.com/medik8s/fence-agents-remediation/blob/main/config/ocp_aws/fence_aws_credentials_request.yaml).
3. Export the operator installed namespace (e.g., *openshift-operators*) and run `export OPERATOR_NS=INSTALLED_NAMESPACE && make test-e2e`

## Troubleshooting

1. Watch FenceAgentsRemediation CR status conditions value, message and reason which are human-readable.
2. Invesitage FAR’s pod logs in container manager (`kubectl logs -n INSTALLED_NAMESPACE --selector='app.kubernetes.io/name=fence-agents-remediation-operator' -c manager`).
3. Use [Medik8s's team must-gather](https://github.com/medik8s/must-gather) by running `oc adm must-gather --image=quay.io/medik8s/must-gather`.
It collects some related debug information for FAR and the rest of Medik8s team operators.

## Help

Expand Down

0 comments on commit 6d5e407

Please sign in to comment.