|
| 1 | +# |
| 2 | +# Copyright (c) 2025 Oracle and/or its affiliates. |
| 3 | +# Licensed under the Universal Permissive License v 1.0 as shown at |
| 4 | +# https://oss.oracle.com/licenses/upl. |
| 5 | +# |
| 6 | +# Since: July, 2018 |
| 7 | + |
| 8 | +# Description: Creates an Oracle AI Database Vagrant virtual machine. |
| 9 | +# Optional plugin: |
| 10 | +# vagrant-proxyconf (if you don't have direct access to the Internet) |
| 11 | +# see https://github.com/tmatilai/vagrant-proxyconf for configuration |
| 12 | +# |
| 13 | +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
| 14 | +# |
| 15 | + |
| 16 | +# -*- mode: ruby -*- |
| 17 | +# vi: set ft=ruby : |
| 18 | +require 'yaml' |
| 19 | + |
| 20 | +# Vagrantfile API/syntax version. Don't touch unless you know what you're doing! |
| 21 | +VAGRANTFILE_API_VERSION = "2" |
| 22 | + |
| 23 | +# Box metadata location and box name |
| 24 | +BOX_URL = "https://oracle.github.io/vagrant-projects/boxes" |
| 25 | +BOX_NAME = "oraclelinux/9" |
| 26 | + |
| 27 | +# UI object for printing information |
| 28 | +ui = Vagrant::UI::Prefixed.new(Vagrant::UI::Colored.new, "vagrant") |
| 29 | + |
| 30 | +# Define constants |
| 31 | +Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| |
| 32 | + # Load configuration parameters into environment |
| 33 | + ['config.local.yaml', 'config.yaml'].each do |f| |
| 34 | + cfg = File.file?(f) ? YAML.safe_load_file(f, freeze: true) : {} |
| 35 | + cfg && cfg.each do |key, value| |
| 36 | + key = key.upcase |
| 37 | + (!ENV[key] || ENV[key].empty?) && ENV[key] = value.to_s |
| 38 | + end |
| 39 | + end |
| 40 | + |
| 41 | + # VM name |
| 42 | + VM_NAME = default_s('VM_NAME', 'oracle26ai-free-vagrant') |
| 43 | + |
| 44 | + # Memory for the VM (in MB, 2300 MB is ~2.25 GB) |
| 45 | + VM_MEMORY = default_i('VM_MEMORY', 2300) |
| 46 | + |
| 47 | + # VM time zone |
| 48 | + # If not specified, will be set to match host time zone (if possible) |
| 49 | + VM_SYSTEM_TIMEZONE = default_s('VM_SYSTEM_TIMEZONE', host_tz) |
| 50 | + |
| 51 | + # Database version to install; default is the latest available |
| 52 | + # Must be one of the versions listed in the db_versions.csv file |
| 53 | + VM_DB_VERSION = default_s('VM_DB_VERSION', 'latest') |
| 54 | + |
| 55 | + # Save database installer RPM file for reuse when VM is rebuilt |
| 56 | + VM_KEEP_DB_INSTALLER = default_b('VM_KEEP_DB_INSTALLER', false) |
| 57 | + |
| 58 | + # Database character set |
| 59 | + VM_ORACLE_CHARACTERSET = default_s('VM_ORACLE_CHARACTERSET', 'AL32UTF8') |
| 60 | + |
| 61 | + # Listener port |
| 62 | + VM_LISTENER_PORT = default_i('VM_LISTENER_PORT', 1521) |
| 63 | + |
| 64 | + # Oracle database password for the SYS, SYSTEM and PDBADMIN accounts |
| 65 | + # If left blank, the password will be generated automatically |
| 66 | + # Database creation will fail if the password contains spaces or special characters |
| 67 | + VM_ORACLE_PWD = default_s('VM_ORACLE_PWD', '') |
| 68 | +end |
| 69 | + |
| 70 | +# Convenience methods |
| 71 | +def default_s(key, default) |
| 72 | + ENV[key] && ! ENV[key].empty? ? ENV[key] : default |
| 73 | +end |
| 74 | + |
| 75 | +def default_i(key, default) |
| 76 | + default_s(key, default).to_i |
| 77 | +end |
| 78 | + |
| 79 | +def default_b(key, default) |
| 80 | + default_s(key, default).to_s.downcase == "true" |
| 81 | +end |
| 82 | + |
| 83 | +def host_tz |
| 84 | + # get host time zone for setting VM time zone |
| 85 | + # if host time zone isn't an integer hour offset from GMT, fall back to UTC |
| 86 | + offset_sec = Time.now.gmt_offset |
| 87 | + if (offset_sec % (60 * 60)) == 0 |
| 88 | + offset_hr = ((offset_sec / 60) / 60) |
| 89 | + timezone_suffix = offset_hr >= 0 ? "-#{offset_hr.to_s}" : "+#{(-offset_hr).to_s}" |
| 90 | + 'Etc/GMT' + timezone_suffix |
| 91 | + else |
| 92 | + 'UTC' |
| 93 | + end |
| 94 | +end |
| 95 | + |
| 96 | +Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| |
| 97 | + config.vm.box = BOX_NAME |
| 98 | + config.vm.box_url = "#{BOX_URL}/#{BOX_NAME}.json" |
| 99 | + config.vm.define VM_NAME |
| 100 | + |
| 101 | + # Provider-specific configuration |
| 102 | + config.vm.provider "virtualbox" do |v| |
| 103 | + v.memory = VM_MEMORY |
| 104 | + v.name = VM_NAME |
| 105 | + end |
| 106 | + config.vm.provider :libvirt do |v| |
| 107 | + v.memory = VM_MEMORY |
| 108 | + end |
| 109 | + |
| 110 | + # add proxy configuration from host env - optional |
| 111 | + if Vagrant.has_plugin?("vagrant-proxyconf") |
| 112 | + ui.info "Getting Proxy Configuration from Host..." |
| 113 | + has_proxy = false |
| 114 | + ["http_proxy", "HTTP_PROXY"].each do |proxy_var| |
| 115 | + if proxy = ENV[proxy_var] |
| 116 | + ui.info "HTTP proxy: " + proxy |
| 117 | + config.proxy.http = proxy |
| 118 | + has_proxy = true |
| 119 | + break |
| 120 | + end |
| 121 | + end |
| 122 | + |
| 123 | + ["https_proxy", "HTTPS_PROXY"].each do |proxy_var| |
| 124 | + if proxy = ENV[proxy_var] |
| 125 | + ui.info "HTTPS proxy: " + proxy |
| 126 | + config.proxy.https = proxy |
| 127 | + has_proxy = true |
| 128 | + break |
| 129 | + end |
| 130 | + end |
| 131 | + |
| 132 | + if has_proxy |
| 133 | + # Only consider no_proxy if we have proxies defined. |
| 134 | + no_proxy = "" |
| 135 | + ["no_proxy", "NO_PROXY"].each do |proxy_var| |
| 136 | + if ENV[proxy_var] |
| 137 | + no_proxy = ENV[proxy_var] |
| 138 | + ui.info "No proxy: " + no_proxy |
| 139 | + no_proxy += "," |
| 140 | + break |
| 141 | + end |
| 142 | + end |
| 143 | + config.proxy.no_proxy = no_proxy + "localhost,127.0.0.1" |
| 144 | + end |
| 145 | + else |
| 146 | + ["http_proxy", "HTTP_PROXY", "https_proxy", "HTTPS_PROXY"].each do |proxy_var| |
| 147 | + if ENV[proxy_var] |
| 148 | + ui.warn 'To enable proxies in your VM, install the vagrant-proxyconf plugin' |
| 149 | + break |
| 150 | + end |
| 151 | + end |
| 152 | + end |
| 153 | + |
| 154 | + # VM hostname |
| 155 | + # must be "localhost", or listener configuration will fail |
| 156 | + config.vm.hostname = "localhost" |
| 157 | + |
| 158 | + # Oracle port forwarding |
| 159 | + config.vm.network "forwarded_port", guest: VM_LISTENER_PORT, host: VM_LISTENER_PORT |
| 160 | + |
| 161 | + # Provision everything on the first run |
| 162 | + config.vm.provision "shell", path: "scripts/install.sh", env: |
| 163 | + { |
| 164 | + "SYSTEM_TIMEZONE" => VM_SYSTEM_TIMEZONE, |
| 165 | + "DB_VERSION" => VM_DB_VERSION, |
| 166 | + "KEEP_DB_INSTALLER" => VM_KEEP_DB_INSTALLER, |
| 167 | + "ORACLE_CHARACTERSET" => VM_ORACLE_CHARACTERSET, |
| 168 | + "LISTENER_PORT" => VM_LISTENER_PORT, |
| 169 | + "ORACLE_PWD" => VM_ORACLE_PWD |
| 170 | + } |
| 171 | + |
| 172 | +end |
0 commit comments