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

debugging: document kpm diagnostic in Docker #65

Merged
merged 2 commits into from May 6, 2019
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

@@ -31,18 +31,7 @@ Kill Bill is fundamentally a backend system, so the following considerations sho
* Verify the integration with your payment gateway(s): very few payment transactions (if any) should be in an `UNKNOWN` state. Make sure to fix these manually via the Payment Admin API, if the plugin is unable to do it automatically.
* Have a monitoring system in place (we recommend https://github.com/killbill/killbill-cloud/tree/master/docker/compose[Elasticseach, Logstash, Kibana, InfluxDB and Grafana], which can be easily setup for Kill Bill) and watch your logs constantly: any `WARN` or `ERROR` entry should be reviewed, as well as stacktraces.
* Monitor metrics at `/1.0/metrics` and integrate the healthcheck at `/1.0/healthcheck` with your load balancer.
* Join our https://groups.google.com/forum/#!forum/killbilling-users[mailing-list] to get notified of new releases or ask questions. For inquiries regarding your specific setup, always attach a https://github.com/killbill/killbill-cloud/tree/master/kpm[KPM] diagnostic output:

[source,bash]
----
kpm diagnostic --killbill-api-credentials=bob lazar \
--killbill-credentials=admin password \
--killbill-url=http://127.0.0.1:8080 \
--killbill-web-path=/var/lib/tomcat7/webapps/ROOT/ \
--kaui-web-path=/var/lib/tomcat7/webapps/ROOT/ \
--log-dir=/var/lib/tomcat7/logs \
--account_export=ACCOUNT_ID
----
* Join our https://groups.google.com/forum/#!forum/killbilling-users[mailing-list] to get notified of new releases or ask questions.

== Deployment options

@@ -532,8 +532,18 @@ In your message, specify:
kpm diagnostic --killbill-api-credentials=bob lazar \
--killbill-credentials=admin password \
--killbill-url=http://127.0.0.1:8080 \
--killbill-web-path=/var/lib/tomcat7/webapps/ROOT/ \
--kaui-web-path=/var/lib/tomcat7/webapps/ROOT/ \
--log-dir=/var/lib/tomcat7/logs \
--account_export=ACCOUNT_ID
--killbill-web-path=/var/lib/tomcat/webapps/ROOT.war \
--log-dir=/var/lib/tomcat/logs \
--account-export=ACCOUNT_ID
----

If you are using our standard Docker images, you can simply run:

[source,bash]
----
$KPM_DIAGNOSTIC_CMD -e killbill_user=admin \

This comment has been minimized.

Copy link
@sbrossie

sbrossie May 1, 2019

Member

Confused what is this env variable KPM_DIAGNOSTIC_CMD -- is it defined above in the doc ? Also is this supposed to be run from inside or outside the container ?

This comment has been minimized.

Copy link
@pierre

pierre May 3, 2019

Author Member

I've clarified it in 47dd274 - the variable is defined in our Dockerfile and abstracts the right default properties.

-e killbill_password=password \
-e killbill_api_key=bob \
-e killbill_api_secret=lazar \
-e killbill_account=ACCOUNT_ID
----
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.