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.

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

add ASB debugging guide #676

Merged
merged 4 commits into from Jan 23, 2018
Merged

Conversation

johnkim76
Copy link
Contributor

Add a debugging guide for the broker

@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 22, 2018

## Debugging APBs

Once the ASB is communication with the service catalog have been verified, you may view information about the APBs. For example, you may want to get a list of all of your APBs (services), along with all of their service plans.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Once the ASB is communication with the service catalog have been verified/Once the ASB's communication with the service catalog has been verified

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, will update

The ASB will first get a list of the APBs from the specified org upon bootstrap. For example, if the [`ansibleplaybookbundle`](https://hub.docker.com/u/ansibleplaybookbundle/dashboard/) org was used, the ASB pod logs will show some like this in the very beginning of the log

```bash
$ oc logs asb-1-wtd6f
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we change this command to show a subset of the information so that a user can compare their command result too?
oc logs asb-1-wtd6f | grep ansibleplaybookbundle

...
[2018-01-22T02:42:45.563Z] [DEBUG] - Loading image list for org: [ ansibleplaybookbundle ]
[2018-01-22T02:42:47.9Z] [DEBUG] - Trying to load ansibleplaybookbundle/s2i-apb
[2018-01-22T02:42:47.9Z] [DEBUG] - Trying to load ansibleplaybookbundle/hello-world-apb
[2018-01-22T02:42:47.9Z] [DEBUG] - Trying to load ansibleplaybookbundle/pyzip-demo-apb
[2018-01-22T02:42:47.9Z] [DEBUG] - Trying to load ansibleplaybookbundle/jenkins-apb
...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, I will update


Verify that ASB's service catalog connection was successful by making sure that no connection errors occurred (e.g. 'TLS handshake errors'). If the ASB's service catalog connection was successful, the logs may look something like this.

```bash
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also verify the connection with this command:
curl -H "authorization: bearer $(oc whoami -t)" https://asb-1338-ansible-service-broker.172.17.0.1.nip.io/ansible-service-broker/v2/catalog --insecure

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, I will add this

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of having the log and the curl command, you can replace reading the log with the curl command. Sorry I wasn't clear by what I meant by my comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.. I will update

@rthallisey rthallisey added the 3.9 | release-1.1 Kubernetes 1.9 | Openshift 3.9 | Broker release-1.1 label Jan 23, 2018
add another ASB -> Service Catalog connection test
Copy link
Contributor

@jmrodri jmrodri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK, nicely done. Super helpful.

@johnkim76
Copy link
Contributor Author

Copy link
Contributor

@rthallisey rthallisey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good @johnkim76

@rthallisey
Copy link
Contributor

No need to wait for CI, these are only doc changes

@rthallisey rthallisey merged commit 45dee47 into openshift:master Jan 23, 2018
@johnkim76 johnkim76 deleted the doc_update_debug_asb branch January 23, 2018 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.9 | release-1.1 Kubernetes 1.9 | Openshift 3.9 | Broker release-1.1 size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants