1 Star 0 Fork 0

nmgliangwei/oracle-vagrant-box

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Debezium Vagrant Box for Oracle DB

This is a Vagrant configuration for setting up a virtual machine based on Fedora 30, containing an Oracle DB instance for testing. Note that you'll need to download the Oracle installation yourself in order for preparing the testing environment.

Ansible is used for provisioning the VM, see playbook.yml for the complete set-up.

Oracle Compatibility

  • Oracle 11 XE

    • Oracle XStream is not supported
    • Can only be used with Debezium Oracle connector using LogMiner adapter.
  • Oracle 18 XE

    • Debezium Oracle connector not compatible regardless of adapter.
      • Flashback queries not supported (required for snapshotting data)
      • Supplemental logging not supported (required for streaming changes)

Preparations

Make sure to have the following installed:

Installation

Clone this repository:

git clone https://github.com/debezium/oracle-vagrant-box.git
cd oracle-vagrant-box
mkdir -p data
cp setup-*.sh data/

Download the Oracle installation file and provide it within the previously created data directory.

Starting the VM

Change into the project directory, and bootstrap the VM:

vagrant up

If you get the error Vagrant was unable to mount VirtualBox shared folders. This is usually because the filesystem "vboxsf" is not available. then run :

vagrant plugin install vagrant-vbguest
vagrant reload
vagrant provision

Once the VM has completed the boot sequence and has been provisioned, SSH into the VM:

vagrant ssh

Setting up Oracle DB

Setup environment

Get the Oracle docker-images repository

The Oracle docker-images repository must be cloned from GitHub. While this repository contains various Docker configurations for many Oracle products, we're only interested in those for the OracleDatabase.

git clone https://github.com/oracle/docker-images.git

Navigate to the Oracle database single instance directory, shown below:

cd docker-images/OracleDatabase/SingleInstance/dockerfiles

Permissions

For all Oracle installations except Oracle 11, the image specifies a volume in which all Oracle database files are kept on the host machine. This location needs to be created if it doesn't exist and provided the necessary permissions:

sudo mkdir -p /home/vagrant/oradata/recovery_area
sudo chgrp 54321 /home/vagrant/oradata
sudo chown 54321 /home/vagrant/oradata
sudo chgrp 54321 /home/vagrant/oradata/recovery_area
sudo chown 54321 /home/vagrant/oradata/recovery_area

CDB or non-CDB

Beginning with Oracle 12, the database is installed using CDB-mode by default, enabling multi-tenancy support. If you wish to test using CDB mode, please skip this section. If you wish to test using non-CDB mode, only Oracle 12/19 (EE versions) provide a way to toggle non-CDB.

Open the Database Configuration Assistant (DBCA) configuration template file, as shown below. This file controls precisely how Oracle will be installed.

vi <oracle-version>/dbca.rsp.tmpl

Locate the following two configuration options in the file, change their values respectively and save:

createAsContainerDatabase=false
numberOfPDBs=0

Now when the database performs its installation procedures in the Running the Container section, the database will be installed using non-CDB mode without pluggable databases.

Build the image

Before the Oracle database image can be built, the installation files that were downloaded from Oracle OTN must be staged. The following shows how to stage Oracle 11, 12, 18, and 19 as well as how to initiate the image build. If the file downloaded from Oracle OTN is named differently than indicated here, the file must be renamed respectively; otherwise Docker will fail to locate the installation files.

Oracle 11 XE

cp /vagrant_data/oracle-xe-11.2.0-1.0.x86_64.rpm.zip 11.2.0.2
./buildContainerImage.sh -v 11.2.0.2 -i -x

Oracle 12 EE

cp /vagrant_data/linuxx64_12201_database.zip 12.2.0.1
./buildContainerImage.sh -v 12.2.0.1 -i -e

Oracle 19 EE

cp /vagrant_data/LINUX.X64_193000_db_home.zip 19.3.0
./buildContainerImage.sh -v 19.3.0 -i -e

Running the container

Depending on the Oracle version being used, certain docker switches may/may not be needed. The following shows how to start each of the Oracle database versions using docker run. Please wait until you see a message that the DATABASE IS READY in the logs.

NOTE: If you have changed the DBCA configuration script to install the database in non-CDB mode, you may see a message that the database failed to start. This is normal as the failure is due to a bug in the Oracle start-up scripts that perform a PDB operation in non-CDB mode.

Oracle 11

docker run --name dbz_oracle --shm-size=1g -p 1521:1521 -e ORACLE_PWD=top_secret oracle/database:11.2.0.2-xe

Oracle 12

docker run --name dbz_oracle -p 1521:1521 -e ORACLE_PWD=top_secret -v /home/vagrant/oradata/:/opt/oracle/oradata oracle/database:12.2.0.1-ee

Oracle 19

docker run --name dbz_oracle -p 1521:1521 -e ORACLE_PWD=top_secret -v /home/vagrant/oradata/:/opt/oracle/oradata oracle/database:19.3.0-ee

Database configuration

As mentioned in the Setup environment for image, Oracle defaults to multi-tenancy installations since Oracle 12. For Oracle EE installations, the container will be named ORCLCDB while the pluggable database is named ORCLPDB1. For Oracle 11, the database does not have multi-tenancy support, so the database is simply named XE.

At this point, the database has been installed but one additional step is required, and that is to configure the database with the necessary features, users and permissions, etc that enable Debezium to capture change events.

The database can be configured to use:

XStreams database configuration

An automated script has been provided in order to configure the database with XStreams support. If you started the Docker image without daemon mode, you may need to open a new vagrant ssh shell. In the vagrant box, run the following based on your Oracle version used:

Oracle 12 and 19 (CDB)
cat /vagrant_data/setup-xstream.sh | docker exec -i dbz_oracle bash
Oracle 12 and 19 (non-CDB)
cat /vagrant_data/setup-xstream-noncdb.sh | docker exec -i dbz_oracle bash

When the script execution has completed, the database is fully configured and ready to send change events to Debezium.

LogMiner database configuration

An automated script has been provided in order to configure the database with LogMiner support. If you started the Docker image without daemon mode, you may need to open a new vagrant ssh shell. In the vagrant box, run the following based on your Oracle version used:

Oracle 11 XE
cat /vagrant_data/setup-logminer-11.sh | docker exec -i --user=oracle dbz_oracle bash
Oracle 12 and 19 (CDB)
cat /vagrant_data/setup-logminer.sh | docker exec -i dbz_oracle bash
Oracle 12 and 19 (non-CDB)
cat /vagrant_data/setup-logminer-noncdb.sh | docker exec -i dbz_oracle bash

When the script execution has completed, the database is fully configured and ready to send change events to Debezium.

FAQ

Why is there no Oracle 11 XE for XStreams or no reference to Oracle 18 XE?

See the Compatibility section for details.

Why is Oracle performing log switches too frequently?

This is often due to the fact that the redo logs are configured with sizes too small, or the number of groups is too few. In Oracle XE installations, this will happen because the default configuration uses redo logs with a size of 50MB. Please see REDOLOG_SETUP.md for instructions on how to adjust the redo log setup.

After restarting dbz_oracle with XStreams, container reports insufficient privileges.

This happens because the Oracle Copy Process (CP) for XStreams fails to start when the container has been restarted.
The easiest solution to resolve this problem is to remove the Outbound Server and recreate it.

The following assumes an Oracle database named ORCLCDB. Please adjust the ORACLE_SID value based on your environment's setup and configuration.

To drop the outbound server:

vagrant ssh
docker exec -it -e ORACLE_SID=ORCLCDB dbz_oracle bash
sqlplus /nolog <<- EOF
connect sys/top_secret;
exec dbms_xstream_adm.drop_outbound('dbzxout');

To re-create the outbound server, open the setup script for your Oracle environment and scroll to the bottom. There are 2 sqlplus commands listed where the first creates the outbound while the second alters it. Simply cut-n-paste those two commands into the terminal of dbz_oracle to execute them.

Now XStreams should work as it did previously prior to the container shutdown.

License

This project is licensed under the Apache License version 2.0.

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
README
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

语言

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/iliangwei/oracle-vagrant-box.git
git@gitee.com:iliangwei/oracle-vagrant-box.git
iliangwei
oracle-vagrant-box
oracle-vagrant-box
master

搜索帮助