Skip to content

Commit 0596473

Browse files
vatsrahulgvenzl
andauthored
Fixed broken link: Issue : 2537 (#2569)
* fixed broken link * fixing linting issues * fixing linting issues * fixing broken link and linting * corrected typo --------- Co-authored-by: Gerald Venzl <[email protected]>
1 parent f9dd56c commit 0596473

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

OracleRestDataServices/README.md

+28-10
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
11
# 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.
34
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).
45

56
## How to build and run
7+
68
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.
99

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.
1113

1214
### 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!
1418

1519
**If no binaries are provided, [the latest ords zip](https://download.oracle.com/otn_software/java/ords/ords-latest.zip) file is downloaded automatically.**
1620

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:
1823

19-
```
24+
```bash
2025
./buildContainerImage.sh -o '--build-arg BASE_IMAGE=<local-image>'
2126
```
2227

23-
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:
2429

30+
```bash
2531
[oracle@localhost dockerfiles]$ ./buildContainerImage.sh -h
2632

2733
Usage: buildContainerImage.sh [-i] [-o] [Docker build option]
@@ -34,32 +40,40 @@ Before you build the image make sure that you have provided the installation bin
3440
LICENSE UPL 1.0
3541

3642
Copyright (c) 2014-2017 Oracle and/or its affiliates. All rights reserved.
43+
```
3744

3845
**IMPORTANT:** The resulting images will be an image with the ORDS binaries installed. On first startup of the container ORDS will be setup.
3946

4047
### Running Oracle REST Data Services in a Docker container
4148

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.
4350
In order to do so you need to create a [user-defined network](https://docs.docker.com/engine/userguide/networking/#user-defined-networks) first.
4451
This can be done via following command:
4552

46-
docker network create <your network name>
53+
```bash
54+
docker network create <your network name>
55+
```
4756

4857
Once you have created the network you can double check by running:
4958

59+
```bash
5060
docker network ls
61+
```
5162

5263
You should see your network, amongst others, in the output.
5364

5465
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:
5566

67+
```bash
5668
docker run --name oracledb --network=<your network name> oracle/database:12.2.0.1-ee
69+
```
5770

5871
The database container will be visible within the network by its name passed on with the `--name` option, in the example above **oracledb**.
5972
Once your database container is up and running and the database available, you can run a new ORDS container.
6073

6174
To run your ORDS Docker image use the **docker run** command as follows:
6275

76+
```bash
6377
docker run --name <container name> \
6478
--network=<name of your created network> \
6579
-p <host port>:8888 \
@@ -88,18 +102,22 @@ To run your ORDS Docker image use the **docker run** command as follows:
88102
The data volume to use for the ORDS configuration files.
89103
Has to be writable by the Unix "oracle" (uid: 54321) user inside the container!
90104
If omitted the ORDS configuration files will not be persisted over container recreation.
105+
```
91106

92107
Once the container has been started and ORDS configured you can send REST calls to ORDS.
93108

94109
## Known issues
110+
95111
None
96112

97113
## Support
98114

99115
## License
116+
100117
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.
101118

102119
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.
103120

104121
## Copyright
122+
105123
Copyright (c) 2014-2017 Oracle and/or its affiliates. All rights reserved.

0 commit comments

Comments
 (0)