summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f12c70
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# onap-python
+
+This Dockerfile aims to generate a baseline image for ONAP [1] projects
+based on SECCOM recommendations [2].
+
+It includes:
+
+- python 3.8.2
+- pip3
+
+Due to the ONBUILD directive, each project must provide a requirements.txt file
+before building an image derived from this baseline image.
+Without this requirements.txt file, the docker built will fail.
+The pip install -r requirements.txt will be executed on the build of your image.
+
+An example of Dockerfile consuming this base line image could be:
+
+```
+FROM nexus3.onap.org:10001/onap/integration-python
+RUN echo "Add your specifc docker needs here."
+```
+
+[1]: http://wiki.onap.org
+
+[2]: https://wiki.onap.org/display/DW/Database%2C+Java%2C+Python%2C+Docker%2C+Kubernetes%2C+and+Image+Versions