YaK User Documentation
YaK Landing PageVisit dbi-services.comContact us
YaK Release 2.1
YaK Release 2.1
  • Welcome
  • Introduction
    • YaK Core
    • YaK Components
    • Terms and definitions
  • User interface
    • Dashboard
    • Infrastructures
    • Servers
    • Components
    • Jobs
    • Configuration
    • Administration
  • YaK Demo
  • Versioning & Compatibility matrix
  • Release Notes
    • YaK components types
      • PostgreSQL
      • Oracle
  • Installation
    • System requirements
    • Install YaK Core
      • Install YaK on your own K8S cluster
      • Install YaK on Rancher Desktop
      • Uninstall Yak
  • YaK step-by-step usage
  • Configuration
    • Secrets
    • Templates
    • Provider shapes
    • Provider images
    • Artifact providers
  • Manage infrastructures
    • Declare infrastructures
    • Attach Secrets
    • Detach Secrets
  • Manage Servers
    • Declare servers
      • Basics
      • Storage
      • Attach secrets
    • Edit server configuration
    • Deploy servers
    • Destroy servers
    • Delete servers
    • Start / Stop servers
  • Manage Components
    • Artifacts requirements
    • Component types
      • PostgreSQL
        • Description
        • Pre-requisites
        • Component references
          • PostgreSQL 2.0.0
            • Standalone deployment variables
            • HA deployment variables
      • Oracle
        • Description
        • Pre-requisites
        • Component references
          • Oracle 2.0.0
            • Standalone variables
  • Use cases
    • On-Premises
    • AWS
    • Azure
    • OCI
  • Appendix
    • Create SSH Keys with PuTTYgen
    • Roles
Powered by GitBook
On this page
  1. Manage Components
  2. Component types
  3. Oracle
  4. Component references
  5. Oracle 2.0.0

Standalone variables

This table describes all the fields available in the YaK and their purpose when declaring your Oracle 2.0.0 standalone component.

Name
Mandatory
Purpose
Example

Version of the Oracle instance

Version of the release update to install. Default value: 19_26_250121_JVM_v0

19_26_250121_JVM_v0

Oracle Software Edition

Oracle Software Edition to install (Standard Edition or Enterprise Edition).

SE2

Instance name (oracle_sid)

This is the Oracle SID.

CDB1

Instance unique name

Unique name of the database.

CDB1_SITE1

Domain name

Fully qualified name of the domain (db_domain).

example.com

Character Set

Character Set of the database. Default value: AL32UTF8

AL32UTF8

National Character Set

National Character Set of the database. Default value: AL16UTF16

AL16UTF16

RMAN connect string

Connect string to use for RMAN backups. Default value: /

/

TNS configuration

Name
Mandatory
Purpose
Example

Default domain for TNS alias

Domain name to use in TNS alias. By default, db_domain will be used.

example.com

Hostname for TNS alias

Hostname to use in TNS alias. Default value: localhost

localhost

Protocol for TNS alias

Protocol to use in TNS alias. Default value: TCP

TCP

Port for TNS alias

Port to use in TNS alias. Default value: 1521

1521

SQL*NET configuration

Name
Mandatory
Purpose
Example

SQL*Net default domain

Domain name to append to any unqualified service name (usually same as db_domain). By default, db_domain will be used.

example.com

SQL*Net server side encryption (SQLNET.ENCRYPTION_SERVER)

Enable server side encryption. Default value: TRUE

N/A

SQL*Net client side encryption (SQLNET.ENCRYPTION_CLIENT)

Enable client side encryption. Default value: TRUE

N/A

SQL*Net server side crypto checksum (SQLNET.CRYPTO_CHECKSUM_SERVER)

Enable server side crypto checksum. Default value: TRUE

N/A

SQL*Net client side crypto checksum (SQLNET.CRYPTO_CHECKSUM_CLIENT)

Enable client side crypto checksum. Default value: TRUE

N/A

Listener configuration

Name
Mandatory
Purpose
Example

Listener name

Name of the Oracle Listener (usually 'LISTENER' for the first Listener). Default value: LISTENER

LISTENER

Listener hostname FQDN

Hostname to set in the Oracle Listener. By default, the hostname of the server will be used.

linux_srv.example.com

Listener protocol

Listener port protocol to use. Default value: TCP

TCP

Listener port

Listener port to use. Default value: 1521

1521

RMAN backups notifications

Name
Mandatory
Purpose
Example

SMTP Server

IP or Hostname of the SMTP server or relay host dmk_dbbackup notifications.

smtp_server.example.com

Mail from

Email address from which the notifications are send.

oracle_server@example.com

Mail to

Comma separated list of email addresses to which the notifications are send.

dba@example.com, infra@example.com, admin@example.com

Mail subject prefix

Prefix to use for the mail subject.

dbi

Send notification on failure only

0 : always send notifications 1 : send notifications on failure only

1

Deploy A New Oracle Single Instance

Name
Mandatory
Purpose
Example

Golden Image (optional)

This is the golden image that will be used to install the Oracle binaries. It must be same version as the version of Oracle defined in the component.

The golden image must be located in the artifact repository and the full path must be specified. If not specified, the base release 19.3 will be used.

rdbms/oracle/gold_images/19c/LINUX.X64_19_21_231017_JVM_v0_db_home.zip

Patch An Existing Oracle Single Instance

Name
Mandatory
Purpose
Example

Oracle version

Target version to upgrade the Oracle database to. Default value: 19_26_250121_JVM_v0

19_26_250121_JVM_v0

Golden Image (optional)

This is the golden image that will be used to install the Oracle binaries. It must be same version as the version of Oracle selected above.

The golden image must be located in the artifact repository and the full path must be specified. If not specified, the base release 19.3 will be used.

rdbms/oracle/gold_images/19c/LINUX.X64_19_21_231017_JVM_v0_db_home.zip

Version to remove

Version of the Oracle home to remove after the patching is done. The home should not be removed if there are still databases assigned to it.

19_25_241015_JVM_v0

Force patching (AT YOUR OWN RISKS)

By default the patching will fail if there are invalid SYS or SYSTEM objects. Checking this checkbox will allow the patching even if there are invalid SYS/SYSTEM objects. Default value: FALSE

N/A

PreviousOracle 2.0.0NextUse cases

Last updated 21 days ago