You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: OracleRestDataServices/README.md
+28-10
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,33 @@
1
1
# Oracle REST Data Services on Docker
2
-
Sample Docker build files to facilitate installation, configuration, and environment setup for DevOps users.
2
+
3
+
Sample Docker build files to facilitate installation, configuration, and environment setup for DevOps users.
3
4
For more information about Oracle REST Data Services (ORDS) please see the [ORDS Documentation](http://www.oracle.com/technetwork/developer-tools/rest-data-services/documentation/index.html).
4
5
5
6
## How to build and run
7
+
6
8
This project offers sample Dockerfiles for Oracle REST Data Services
7
-
8
-
To assist in building the images, you can use the [buildDockerImage.sh](dockerfiles/buildDockerImage.sh) script. See below for instructions and usage.
9
9
10
-
The `buildDockerImage.sh` script is just a utility shell script that performs MD5 checks and is an easy way for beginners to get started. Expert users are welcome to directly call `docker build` with their prefered set of parameters.
10
+
To assist in building the images, you can use the [buildContainerImage.sh](dockerfiles/buildContainerImage.sh) script. See below for instructions and usage.
11
+
12
+
The `buildContainerImage.sh` script is just a utility shell script that performs MD5 checks and is an easy way for beginners to get started. Expert users are welcome to directly call `docker build` with their preferred set of parameters.
11
13
12
14
### Building Oracle REST Data Services Install Images
13
-
**IMPORTANT:** You can provide the installation binaries of ORDS and put them into the `dockerfiles` folder. You only need to provide the binaries for the version you are going to install. The binaries can be downloaded from the [Oracle Technology Network](http://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html) and placed in `OracleRestDataServices/dockerfiles` directory. Note that you must not uncompress the binaries. The script will handle that for you and fail if you uncompress them manually!
15
+
16
+
**IMPORTANT:** You can provide the installation binaries of ORDS and put them into the `dockerfiles` folder. You only need to provide the binaries for the version you are going to install.\
17
+
The binaries can be downloaded from the [Oracle Technology Network](http://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html) and placed in `OracleRestDataServices/dockerfiles` directory. Note that you must not uncompress the binaries. The script will handle that for you and fail if you uncompress them manually!
14
18
15
19
**If no binaries are provided, [the latest ords zip](https://download.oracle.com/otn_software/java/ords/ords-latest.zip) file is downloaded automatically.**
16
20
17
-
The image builds on top of the `oracle/serverjre:8` image which is also provided in this repository, see [OracleJava](../OracleJava). This base image is fetched from the container registry. So for successful fetch the user needs to login to the [contaienr-registry](container-registry.oracle.com) and accept the license agreement. The user can also build the `oracle/serverjre:8` image locally before building this image using the [OracleJava](../OracleJava) repo. After building this image locally, the user can run the following command:
21
+
The image builds on top of the `oracle/serverjre:8` image which is also provided in this repository, see [OracleJava](../OracleJava). This base image is fetched from the container registry. So for successful fetch the user needs to login to the [container-registry](container-registry.oracle.com) and accept the license agreement.\
22
+
The user can also build the `oracle/serverjre:8` image locally before building this image using the [OracleJava](../OracleJava) repo. After building this image locally, the user can run the following command:
Before you build the image make sure that you have provided the installation binaries and put them into the right folder. Once you have done that go into the **dockerfiles** folder and run the **buildDockerImage.sh** script:
28
+
Before you build the image make sure that you have provided the installation binaries and put them into the right folder. Once you have done that go into the **dockerfiles** folder and run the **buildContainerImage.sh** script:
@@ -34,32 +40,40 @@ Before you build the image make sure that you have provided the installation bin
34
40
LICENSE UPL 1.0
35
41
36
42
Copyright (c) 2014-2017 Oracle and/or its affiliates. All rights reserved.
43
+
```
37
44
38
45
**IMPORTANT:** The resulting images will be an image with the ORDS binaries installed. On first startup of the container ORDS will be setup.
39
46
40
47
### Running Oracle REST Data Services in a Docker container
41
48
42
-
Before you run your ORDS Docker container you will have to specify a network in wich ORDS will communicate with the database you would like it to expose via REST.
49
+
Before you run your ORDS Docker container you will have to specify a network in which ORDS will communicate with the database you would like it to expose via REST.
43
50
In order to do so you need to create a [user-defined network](https://docs.docker.com/engine/userguide/networking/#user-defined-networks) first.
44
51
This can be done via following command:
45
52
46
-
docker network create <your network name>
53
+
```bash
54
+
docker network create <your network name>
55
+
```
47
56
48
57
Once you have created the network you can double check by running:
49
58
59
+
```bash
50
60
docker network ls
61
+
```
51
62
52
63
You should see your network, amongst others, in the output.
53
64
54
65
As a next step you will have to start your database container with the specified network. This can be done via the `docker run``--network` option, for example:
55
66
67
+
```bash
56
68
docker run --name oracledb --network=<your network name> oracle/database:12.2.0.1-ee
69
+
```
57
70
58
71
The database container will be visible within the network by its name passed on with the `--name` option, in the example above **oracledb**.
59
72
Once your database container is up and running and the database available, you can run a new ORDS container.
60
73
61
74
To run your ORDS Docker image use the **docker run** command as follows:
62
75
76
+
```bash
63
77
docker run --name <container name> \
64
78
--network=<name of your created network> \
65
79
-p <host port>:8888 \
@@ -88,18 +102,22 @@ To run your ORDS Docker image use the **docker run** command as follows:
88
102
The data volume to use for the ORDS configuration files.
89
103
Has to be writable by the Unix "oracle" (uid: 54321) user inside the container!
90
104
If omitted the ORDS configuration files will not be persisted over container recreation.
105
+
```
91
106
92
107
Once the container has been started and ORDS configured you can send REST calls to ORDS.
93
108
94
109
## Known issues
110
+
95
111
None
96
112
97
113
## Support
98
114
99
115
## License
116
+
100
117
To download and run ORDS, regardless whether inside or outside a Docker container, you must download the binaries from the Oracle website and accept the license indicated at that page.
101
118
102
119
All scripts and files hosted in this project and GitHub [docker-images/OracleRestDataServices](./) repository required to build the Docker images are, unless otherwise noted, released under the Universal Permissive License (UPL), Version 1.0.
103
120
104
121
## Copyright
122
+
105
123
Copyright (c) 2014-2017 Oracle and/or its affiliates. All rights reserved.
0 commit comments