Oracle Cloud Infrastructure

Defines the settings for Oracle Cloud Infrastructure, including account, compartment, and networking configuration.

Type: oci-configuration

Properties

Name	Type	Description	Required
account	object	Core OCI account settings	yes
networking	object	Networking configuration for OCI	no
compartment	object	Default OCI compartment where resources will be created	yes

Additional Properties: not allowed
Example

{
    "account": {
        "id": "ocid1.tenancy.oc1..aaaaaaaadmo2tza5cky2z2hmvmevykt4t7cxewbtvfytbq3iwbq7obuora",
        "name": "production",
        "region": "us-phoenix-1"
    },
    "networking": {
        "domain_name": "example.com",
        "application_domain": false,
        "private_domain_name": "example.internal"
    },
    "compartment": {
        "id": "ocid1.compartment.oc1..aaaaaaaaxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "name": "shared-services"
    }
}

account: Account

Core OCI account settings

Properties

Name	Type	Description	Required
id (Tenancy OCID)	string	The OCID of your OCI tenancy Pattern: ^ocid1\.tenancy\.oc1\..+$	yes
name	string	A descriptive name for this OCI account configuration	yes
region	string	The primary Oracle Cloud region where your resources are deployed Enum: "us-phoenix-1", "us-ashburn-1", "eu-zurich-1", "eu-frankfurt-1", "ap-tokyo-1", "ap-singapore-1", "ap-sydney-1", "ca-toronto-1", "sa-saopaulo-1", "ap-mumbai-1", "ap-hyderabad-1", "ap-chuncheon-1"	yes

Additional Properties: not allowed
Example

{
    "id": "ocid1.tenancy.oc1..aaaaaaaadmo2tza5cky2z2hmvmevykt4t7cxewbtvfytbq3iwbq7obuora",
    "name": "production",
    "region": "us-phoenix-1"
}

networking: Networking

Networking configuration for OCI

Properties

Name	Type	Description	Required
domain_name (Public Zone)	string	The public domain name to be used when creating DNS resources
application_domain	boolean	Use account name as part of applications domains Default: false
private_domain_name (Private Zone)	string	The private domain name to be used when creating DNS resources

Additional Properties: not allowed
Example

{
    "domain_name": "example.com",
    "application_domain": false,
    "private_domain_name": "example.internal"
}

compartment: Compartment

Default OCI compartment where resources will be created

Properties

Name	Type	Description	Required
id (Compartment OCID)	string	The OCID of the OCI compartment Pattern: ^ocid1\.compartment\.oc1\..+$	yes
name (Compartment Name)	string	Human-readable name of the compartment	no

Additional Properties: not allowed
Example

{
    "id": "ocid1.compartment.oc1..aaaaaaaaxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "shared-services"
}