provisioning_template.yml

form:
  - field: g_aws_account_id
    label: Cloud account number, e.g. '1234567890'
    internal_comments: |
      Although this value looks like a number, it is a string.
      You *must* put it in quotes if it has a leading zero
      otherwise the YAML parser will interpret it as an octal (base 8)
      number.  For example, put "010" not 010, which would be interpreted
      as the number 8.

  - field: g_location
    label: Cloud provider, i.e.  'aws' or 'gce' or 'azure'
    is_public: True
    description: Please select which cloud provider you will deploying OpenShift Dedicated on
    default: aws
    values:
      - aws
      - gcp
      - azure

  - field: g_ec2_region
    label: AWS region (e.g. 'us-east-1'), not used for GCE or Azure
    is_public: True
    description: Please select the region to deploy to
    default:
      case:
        lookup: g_location
        aws: us-east-1
        gcp: something else
    values:
      case:
        lookup: g_location
        aws: function(get_aws_regions, format='dropdown', label='region_name', value='region')

  - field: g_aws_account
    label: Friendly account name assigned by ops for easy reference in ansible playbooks

  - field: g_environment
    label: Ops environment, i.e. 'prod', 'stg', 'int'
    default: int

  - field: g_clusterid
    label: Customer-assigned cluster name
    is_public: True
    description: Please provide your cluster-id

  - field: g_install_version
    label: OCP version
    default: 3.3

  - field: g_routers
    label: Primary router and additional router shards
    description: first router is the default router/elb/shard
    default: ???FIXME???
    has: (router)+

  - field: g_setup_vpc_cidr
    label: VPC CIDR configuration
    internal_comments: |
      Modify the following CIDR and subnets *if* the customer has specified
      that they should be changed, usually if they have a VPN connection
      and they want to ensure that the VPC networks don't overlap with the
      networks in their site/DC.

      For example if the customer specifies us-east-1 and a CIDR of
      192.168.5.0/22, change the following:

      g_setup_vpc_cidr: 192.168.5.0/22
      g_setup_vpc_subnets:
        us-east-1c:
        - cidr: 192.168.5.0/24
        us-east-1e:
        - cidr: 192.168.6.0/24
        us-east-1a:
        - cidr: 192.168.7.0/24
    default: 172.31.0.0/16
    format: cidr

  - field: g_setup_vpc_subnets
    default: ???FIXME???
    has: (vpc_subnet)+

  - field: g_instance_counts
    label: Cluster node counts
    default: ???FIXME???
    has: instance_count

  - field: g_pv_storage_size
    label: PV Space
    internal_comments: |
      By default, we Openshift Dedicated gives a user 100GB of PV Space
      A customer can pay more and have this upgraded.  By default 100GB is
      already alocated to each user.

      Only change this if the user has bought more than 100GB
      of space and is shown in the relase ticket
    default: 100G

  - field: g_deployment
    label: Deployment type
    internal_comments: |
      Only change this if deployment type is 'online'
      Note: This is not common
    default: None
    values:
      - None
      - online

  - field: g_authentication_identityproviders
    label:
    is_public: True
    default: ???FIXME???

  - field: g_cluster_sdn_plugin
    label: Specify the SDN type
    is_public: True
    internal_comments: |
      There are two options:
       - 'redhat/openshift-ovs-subnet'
       - 'redhat/openshift-ovs-multitenant'
       The default for dedicated is redhat/openshift-ovs-subnet
       The default for online is    redhat/openshift-ovs-multitenant
    default: redhat/openshift-ovs-subnet
    values:
      - redhat/openshift-ovs-subnet
      - redhat/openshift-ovs-multitenant

  - field: g_openshift_ded_admin_users
    label: Dedicated admin users
    is_public: True
    description: Please specify the users that will be granted dedicated admin rights on the cluster
    format: (list:email)+

  - field: g_enable_config_loop
    description: This will enable the config loop to run on the system schedule
    default: True

  - field: g_enable_monitoring
    description: If set to False, this will prevent the cluster from reporting to Zabbix
    default: True

  - field: g_run_config_loop
    description: This will run the config loop during the provision on the cluster
    default: True


components:
  router:
    - field: name
    - field: shard
    - field: dns_zone
    - field: type
      values:
        - default
        - secondary
    - field: scheme
      default: internal
      values:
        - internal
        - internet-facing
    - field: elb_timeout
    - field: elb_health_check_port
    - field: listeners
      has: (listener)+
    - field: elb_security_groups
      has: (elb_security_group)+
    - field: stats_port
    - field: router_edits
      has: (router_edit)+
  listener:
    - field: instance_port
    - field: instance_protocol
    - field: load_balancer_port
    - field: protocol
      default: tcp
      values:
        - tcp
        - udp
  elb_security_group:
    - field: name
    - field: rules
      has: (elb_security_rule)+
  elb_security_rule:
    - field: proto
      default: tcp
      values:
        - tcp
        - udp
    - field: from_port
      format: number
    - field: to_port
      format: number
    - field: cidr_ip
      format: cidr
  router_edit:
    - field: key
    - field: curr_value
      has: name_value_pair
    - field: value
      has: name_value_pair
    - field: action
      values:
        - update
        - append
  name_value_pair:
    - field: name
    - field: value
  vpc_subnet:
    - field: lookup(az_name)
      has: (cidr_az_pair){1,3}
  cidr_az_pair:
    - field: cidr
      format: cidr
    - field: az
  instance_count:
    - field: g_master_exact_count
      format: number
    - field: g_infra_node_exact_count
      format: number
    - field: g_compute_node_exact_count
      format: number