orm.yaml

# Title shown in Application Information tab.
title: GitHub Actions Runner
# Sub Title shown in Application Information tab.
description: The runner is the application that runs a job from a GitHub Actions workflow. It is used by GitHub Actions in the hosted virtual environments, or you can self-host the runner in your own environment.
schemaVersion: 1.1.0
version: "20201028"

informationalText: The runner is the application that runs a job from a GitHub Actions workflow. It is used by GitHub Actions in the hosted virtual environments, or you can self-host the runner in your own environment. It is not recommend to use self-hosted Runners on public repos. More information on https://github.com/actions/runner

locale: "en"
variableGroups:
  - title: "Hidden Variable Group"    
    visible: false
    variables:
#"variables used internally - not exposed to end user"    
      - tenancy_ocid 
      - region 
      - ad_number          
      - compute_image_strategy_enum
      - network_strategy_enum
      - subnet_type_enum
      - nsg_config_enum

  - title: "GitHub Actions Runner Configuration"
    variables:      
      - github_url
      - github_runner_registration_token
      - number_of_runners
      - github_runner_label_list
      - github_runner_version

  - title: "Compute Configuration"
    variables:
      - compute_compartment_ocid
      - availability_domain_name
      - vm_display_name
      - hostname_label
      - compute_shape
      - flex_shape_memory
      - flex_shape_ocpus
      - compute_image_strategy
      - operating_system
      - platform_image_ocid
      - custom_image_ocid
      - ssh_public_key
      

  - title: "Virtual Cloud Network"
    variables:
      - network_compartment_ocid
      - network_strategy
      - network_configuration_strategy      
      - vcn_id 
      - vcn_display_name       
      - vcn_dns_label
      - vcn_cidr_block              

  - title: "Subnet"
    visible: #($network_strategy  == ""Use Existing VCN and Subnet"") OR (network_configuration_strategy ==  "Customize Network Configuration")
      or:
        - eq:         
          - network_strategy 
          - "Use Existing VCN and Subnet"    
        - eq:
          - network_configuration_strategy
          - "Customize Network Configuration"
    variables:
      - subnet_type
      - subnet_id 
      - subnet_display_name             
      - subnet_dns_label
      - subnet_cidr_block            
      - nsg_configuration_strategy

  - title: "Network Security Group"
    visible: #($nsg_configuration_strategy  ==  "Customize Network Security Group")
      eq:
        - nsg_configuration_strategy 
        - "Customize Network Security Group"
    variables:
      - nsg_display_name
      - nsg_source_cidr
      - nsg_ssh_port
      - nsg_http_port                              
      - nsg_https_port

  - title: "Additional Configuration Options"
    variables:
      - tag_key_name
      - tag_value


######################################################
##############          VARIABLES        #############
######################################################

variables:
  # Hidden variables

######################################################
##############    HIDDEN VARIABLES       #############
######################################################


  tenancy_ocid:
    type: string
    title: Tenancy ID
    description: The Oracle Cloud Identifier (OCID) for your tenancy
    required: true

  region:
    type: oci:identity:region:name
    title: Region
    description: The region in which to create all resources
    required: true

  ad_number:
    type: string    
    required: false    
    description: Availability Domain Number (Not used)


#########################################################
##############   GitHub Runner VARIABLES   #############
########################################################

  github_url:
    type: string
    required: true
    title: GitHub URL (Organization or Repository)

  github_runner_registration_token:
    type: string
    required: true
    title: GitHub Actions Runner Registration Token
  
  github_runner_label_list:
    type: string
    required: true
    title: Runner Tag List

  number_of_runners:
    type: number
    required: true
    title: Number of Runner Instances

  github_runner_version:
    type: string
    required: false
    title: GitHub Actions Runner Version

  tag_key_name:
    type: string
    required: true
    title: Tag key name

  tag_value:
    type: string
    required: true
    title: Tag value


######################################################
##############    COMPUTE VARIABLES      #############
######################################################
  operating_system:
    type: enum
    title: Operating System
    description: Select the Operating System
    enum:
      # - "CentOS 6"
      # - "CentOS 7"
      # - "Oracle Autonomous Linux 7"
      # - "Oracle Linux 6"
      # - "Oracle Linux 7"
      # - "Oracle Linux 8"
      # - "Ubuntu 16.04"
      # - "Ubuntu 18.04"
       - "Ubuntu 20.04"
    required: true
    default: "Ubuntu 20.04"

  compute_image_strategy:
    type: enum
    title: Compute Image Strategy
    description: Use either a Platform or Custom Image
    enum:
      - "Platform Image"
      - "Custom Image"
    required: true
    default: "Platform Image"


  platform_image_ocid:
    visible: #($compute_image_strategy  == """Platform Image""")
      eq:
        - compute_image_strategy 
        - "Platform Image"
    type: oci:core:image:id
    required: true
    title: Platform Image
    dependsOn:
      compartmentId: compute_compartment_ocid
      operatingSystem: "Canonical Ubuntu"
      operatingSystemVersion: "20.04"
      shape: compute_shape

  custom_image_ocid:
    visible: #($compute_image_strategy  == """Custom Image""")
      eq:
        - compute_image_strategy 
        - "Custom Image"
    type: string
    required: true
    title: Custom Image
    dependsOn:
      compartmentId: compute_compartment_ocid

  compute_compartment_ocid:
    type: oci:identity:compartment:id
    required: true
    title: Compute Compartment
    description: The compartment in which to create all Compute resources
    default: compartment_ocid

  availability_domain_name:
    type: oci:identity:availabilitydomain:name
    dependsOn:
      regionName: region
      compartmentId: compute_compartment_ocid
    required: true
    title: Availability Domain
    description: Availability Domain

  ssh_public_key:
    type: oci:core:ssh:publickey
    required: true
    title: Public SSH Key
    description: Public SSH Key to access GitHub Actions Runner instance via SSH

  vm_display_name:
    type: string
    required: true
    title: Instance Name
    description: The name of the Instance

  compute_shape:    
    type: oci:core:instanceshape:name
    default: VM.Standard.A1.Flex
    title: Compute Shape
    required: true
    dependsOn:
      compartmentId: compute_compartment_ocid
  
  flex_shape_ocpus:
    visible:
      or:
        - eq:
          - compute_shape
          - "VM.Standard.E3.Flex"
        - eq:
          - compute_shape
          - "VM.Standard.E4.Flex"
        - eq:
          - compute_shape
          - "VM.Standard.A1.Flex"
    type: integer
    default: 1
    title: Flex Shape OCPUs
    minimum: 1
    maximum: 64
    required: false
    description: Maximum of 64 OCPUs

    
  flex_shape_memory:
    visible:
      or:
        - eq:
          - compute_shape
          - "VM.Standard.E3.Flex"
        - eq:
          - compute_shape
          - "VM.Standard.E4.Flex"
        - eq:
          - compute_shape
          - "VM.Standard.A1.Flex"
    type: integer
    default: 6
    title: Flex Shape Memory 
    minimum: 1
    maximum: 1024
    required: false
    description: Minimum 1GB or 6GB. Maximum of 64GB per OCPU up to 1024GB

  hostname_label:
    type: string
    required: false
    title: DNS Hostname Label
      

######################################################
##############     NETWORK VARIABLES     #############
######################################################

  network_compartment_ocid:
    type: oci:identity:compartment:id
    required: true
    title: Network Compartment
    description: The compartment in which to create all Network resources
    default: compartment_ocid    


  # Network Type Options
  network_strategy:
    type: enum
    title: Network Strategy
    description: Create or use existing Network Stack (VCN and Subnet)
    enum:
      - "Create New VCN and Subnet"
      - "Use Existing VCN and Subnet"
    required: true
    default: "Create New VCN and Subnet"


  # Network Configuration
  network_configuration_strategy:
    visible: #($network_strategy  == ""Create New VCN and Subnet"")
      eq:
        - network_strategy 
        - "Create New VCN and Subnet"
    type: enum
    title: Configuration Strategy
    description: Use recommended configuration or customize it
    enum:
      - "Use Recommended Configuration"
      - "Customize Network Configuration"
    required: true
    default: "Use Recommended Configuration"



######## VCN ########    

  vcn_display_name:
    visible: #($network_strategy  == ""Create New VCN and Subnet"") AND (network_configuration_strategy ==  "Customize Network Configuration")
      and:
        - eq: 
          - network_strategy 
          - "Create New VCN and Subnet"
        - eq:
          - network_configuration_strategy
          - "Customize Network Configuration"
    type: string
    required: true
    title: Name
    description: The name of the new Virtual Cloud Network (VCN)

  vcn_id:
    visible: #($network_strategy  == "Use Existing VCN and Subnet")
      eq:
        - network_strategy 
        - "Use Existing VCN and Subnet"
    type: oci:core:vcn:id
    dependsOn:
      compartmentId: network_compartment_ocid 
    required: true
    title: Existing VCN
    description: An existing Virtual Cloud Network (VCN) in which to create the compute instances, network resources, and load balancers. If not specified, a new VCN is created.

  vcn_cidr_block:
    visible: #($network_strategy  == ""Create New VCN and Subnet"") AND (network_configuration_strategy ==  "Customize Network Configuration")
      and:
        - eq: 
          - network_strategy 
          - "Create New VCN and Subnet"
        - eq:
          - network_configuration_strategy
          - "Customize Network Configuration"
    type: string
    required: true
    pattern: "^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\/(3[0-2]|[1-2]?[0-9])$"
    title: CIDR Block
    description: The CIDR of the new Virtual Cloud Network (VCN). If you plan to peer this VCN with another VCN, the VCNs must not have overlapping CIDRs.

  vcn_dns_label:
    visible: #($network_strategy  == ""Create New VCN and Subnet"") AND (network_configuration_strategy ==  "Customize Network Configuration")
      and:
        - eq: 
          - network_strategy 
          - "Create New VCN and Subnet"
        - eq:
          - network_configuration_strategy
          - "Customize Network Configuration"
    type: string
    required: true
    title: DNS Label
    maxLenght: 15
    description: VCN DNS Label. Only letters and numbers, starting with a letter. 15 characters max.    

######## MANAGEMENT SUBNET ########
  subnet_type:
    # visible: #($network_strategy  == ""Create New VCN and Subnet"")
    #   eq:
    #     - network_strategy 
    #     - "Create New VCN and Subnet"
    type: enum
    title: Subnet Type
    description: Choose between private and public subnets
    enum:
      - "Private Subnet"
      - "Public Subnet"
    required: true
    default: "Public Subnet"
    
  subnet_display_name:
    visible: #($network_strategy  == ""Create New VCN and Subnet"")
      eq:
        - network_strategy 
        - "Create New VCN and Subnet"
    type: string
    required: true
    title: Name
    description: The name of the new Subnet

  subnet_cidr_block:
    visible: #($network_strategy  == ""Create New VCN and Subnet"")
      eq:
        - network_strategy 
        - "Create New VCN and Subnet"
    type: string
    pattern: "^(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9]).(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\/(3[0-2]|[1-2]?[0-9])$"
    required: true
    title: CIDR Block
    description: The CIDR of the new Subnet. The new subnet's CIDR should not overlap with any other subnet CIDRs.

  subnet_id:
    visible: #($network_strategy  == "Use Existing VCN and Subnet")
      eq:
        - network_strategy 
        - "Use Existing VCN and Subnet"    
    type: oci:core:subnet:id
    dependsOn:
      vcnId: vcn_id 
      compartmentId: network_compartment_ocid
      hidePublicSubnet:
        eq:
          - subnet_type
          - "Private Subnet"
      hidePrivateSubnet:
        eq:
          - subnet_type
          - "Public Subnet"
    default: ''
    required: true
    title: Existing Subnet
    description: An existing Management subnet. This subnet must already be present in the chosen VCN.

  subnet_dns_label:
    visible: #($network_strategy  == ""Create New VCN and Subnet"")
      eq:
        - network_strategy 
        - "Create New VCN and Subnet"
    type: string
    required: true
    title: DNS Label
    maxLenght: 15
    description: Subnet DNS Label. Only letters and numbers, starting with a letter. 15 characters max.    

######################################################
##############    SECURITY VARIABLES     #############
######################################################


  nsg_configuration_strategy:
    visible: true
    type: enum
    title: Network Security Group Configuration
    description: Choose Network Security Rules Strategy
    enum:
      - "Use Recommended Configuration"
      - "Customize Network Security Group"
    required: true
    default: "Use Recommended Configuration"


  nsg_display_name:
    type: string
    required: false
    title: Name
    
  nsg_ssh_port:
    type: number
    required: false
    default: 22
    title: SSH Port Number

  nsg_http_port:
    type: number
    required: false
    default: 80
    title: HTTP Port Number

  nsg_https_port:
    type: number
    required: false
    default: 443
    title: HTTPS Port Number

  nsg_source_cidr:
    type: string
    required: false
    default: "0.0.0.0/0"
    title: Allowed Ingress Traffic (CIDR Block)



#############################################
###########    OUTPUT GROUPS     ############
#############################################

outputGroups:
  - title: "Connection Details"
    outputs:
      - instance_public_ip
      - instance_private_ip
      - server_url

#############################################
##############     OUTPUTS     ##############
#############################################

outputs:
  vcn_cidr_block:
    type: string
    title: VCN CIDR
    visible: false    

  instance_id:
    type: ocid    
    visible: false

  instance_public_ip:
    type: link
    title: Public IP
    visible: #($subnet_type == "Public Subnet")
      eq:
        - subnet_type
        - "Public Subnet"
  
  instance_private_ip:
    type: link
    title: Private IP
    visible: true