DOCS

Transcription

1 HOME DOWNLOAD COMMUNITY DEVELOP NEWS DOCS Docker Images Docker Images for Avatica Docker is a popular piece of software that enables other software to run anywhere. In the context of Avatica, we can use Docker to enable a run-anywhere Avatica server. These Docker containers can be used to easily create a server for the development of custom Avatica clients or encapsulating database access for testing software that uses Avatica. Base avatica-server Docker Image Starting with the Avatica release, Avatica is providing a number of Docker containers. Each of these images is based on a parent avaticaserver Docker image. OVERVIEW Background Roadmap REFERENCE Client Reference JSON Reference Protobuf Reference HOWTO Security Compatibility Custom Client Artifacts Docker Images META History API Test API This Docker image has no bindings to a specific database (it has not database-specific JDBC driver included). It only contains a Java runtime and the 1 of 6 4/5/17, 1:36 PM

2 Avatica Standalone Server jar (which contains all the necessary dependencies of the Avatica server). This docker image is not directly useful for end users; it is useful for those who want to use Avatica with a database of their choosing. This Docker image will be deployed to the Apache Dockerhub account after the release of and will be updated for future releases of Avatica. Database-specific Docker Images To make the lives of end-users who want to use a specific database easier, some Docker images are provided for some common databases. The current databases include: HyperSQL (2.3.1) MySQL (5.1.41) PostgreSQL (42.0) These images are not deployed as the licensing on each database driver is varied. Please understand and accept the license of each before using in any software project. Each of these images include a build.sh script which will build the docker image using the latest avatica-server Docker image. The resulting Docker image will be named according to the following format: avatica-<database>-server. For 2 of 6 4/5/17, 1:36 PM

3 example, avatica-hsqldb-server, avatica-mysql-server, and avatica-postgresql-server. Additionally, Docker Compose configuration files for the above databases (sans HyperSQL) are provided which configure the database s standard Docker image and then connect Avatica to that Docker container. For example, the PostgreSQL docker-compose configuration file will start an instance of PostgreSQL and an instance of the Avatica server, each in their own container, exposing an Avatica server configured against a real PostgreSQL database. All of the Dockerfile and docker-compose.yml files are conveniently provided in an archive for each release, starting with of 6 4/5/17, 1:36 PM

4 avatica-docker snapshot/ avatica-docker snapshot/hypersql/ avatica-docker snapshot/mysql/ avatica-docker snapshot/postgresql/ avatica-docker snapshot/dockerfile avatica-docker snapshot/hypersql/build.sh avatica-docker snapshot/hypersql/dockerfile avatica-docker snapshot/mysql/build.sh avatica-docker snapshot/mysql/docker-compose.yml avatica-docker snapshot/mysql/dockerfile avatica-docker snapshot/postgresql/build.sh avatica-docker snapshot/postgresql/docker-compose.yml avatica-docker snapshot/postgresql/dockerfile Running Each of the provided database-specific Docker images set an ENTRYPOINT which encapsulate most of the Java command. The following options are available to specify: 4 of 6 4/5/17, 1:36 PM

5 Usage: <main class> [options] Options: -h, -help, --help Print the help message Default: false -p, --port Port the server should bind Default: 0 -s, --serialization Serialization method to use Default: PROTOBUF Possible Values: [JSON, PROTOBUF] * -u, --url JDBC driver url for the server For example, to connect to a MySQL server, the following could be used: $./avatica-docker-*/mysql/build.sh $ docker run --rm -it avatica-mysql-server \ -u jdbc:mysql://<fqdn>:3306/my_database -p 8765 To debug these docker images, the ENTRYPOINT can be overriden to launch a shell $ docker run --rm --entrypoint='' -it avatica-mysql-server /bin/sh PREVIOUS NEXT 5 of 6 4/5/17, 1:36 PM

6 The contents of this website are 2017 Apache Software Foundation under the terms of the Apache License v2. Apache Calcite and its logo are trademarks of the Apache Software Foundation. 6 of 6 4/5/17, 1:36 PM