[GitHub] [skywalking-docker] wu-sheng commented on a change in pull request #17: Add Java agent Dockerfile and build / push script

[GitBox <gi...@apache.org>]

wu-sheng commented on a change in pull request #17:
URL: https://github.com/apache/skywalking-docker/pull/17#discussion_r610644627



##########
File path: java-agent/README.md
##########
@@ -0,0 +1,69 @@
+# Apache SkyWalking Agent docker file
+
+**Docker images are not official ASF releases but provided for convenience. Recommended usage is always to build the
+source**
+
+<img src="http://skywalking.apache.org/assets/logo.svg" alt="Sky Walking logo" height="90px" align="right" />
+
+**SkyWalking**: an APM(application performance monitor) system, especially designed for microservices, cloud native and
+container-based (Docker, Kubernetes, Mesos) architectures.
+
+[![GitHub stars](https://img.shields.io/github/stars/apache/skywalking.svg?style=for-the-badge&label=Stars&logo=github)](https://github.com/apache/skywalking)
+[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
+
+You could find docker file at [here](https://github.com/apache/skywalking-docker)
+
+This image only hosts the pre-built SkyWalking Java agent jars, and provides some convenient configurations for
+containerization scenarios.
+
+# How to use this image
+
+## Build your Java application image on top of this image
+
+```dockerfile
+FROM apache/skywalking-java-agent:8.5.0-jdk8
+
+# ... build your java application
+```
+
+You can start your Java application with `CMD` or `ENTRYPOINT`, but you don't need to care about the Java options to
+enable SkyWalking agent, it should be adopted automatically.
+
+## Use this image as sidecar of Kubernetes service
+
+In Kubernetes scenarios, you can also use this agent image as a sidecar.

Review comment:
       When he does this, please document what user should do on his application. Such as how to write `-javaagent:xxx`




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org