Skip to content
This repository has been archived by the owner on Sep 18, 2021. It is now read-only.

Provisioning Output

Jeremy Poulin edited this page Dec 10, 2018 · 7 revisions

A call into the multiarch-ci-libraries exposes a ProvisionedHost object to the test that calls it. This is the primary mechanism for providing information about the library call back to the caller.

ProvisionedHost

id

  • Available Since: v1.2.0
  • Default Value: UUID.randomUUID()
  • Description: ID for the host, so that it can be tracked in a DB.
  • Required: true
  • Type: String
  • Valid Values: Any valid ID.

arch

  • Available Since: v0.2
  • Default Value: null
  • Description: Architecture of the host
  • Required: true
  • Type: String
  • Valid Values: x86_64,ppc64le,aarch64,s390x

distro

  • Available Since: v1.2.1
  • Default Value: null
  • Description: OS distro type
  • Required: false
  • Type: String
  • Valid Values: RHEL-7.6, RHEL-ALT-7.4, etc

variant

  • Available Since: v1.2.1
  • Default Value: null
  • Description: OS variant type
  • Required: false
  • Type: String
  • Valid Values: Server, Workstation, Client, ComputeNode

hostname

  • Available Since: v1.2.0
  • Default Value: null
  • Description: Name of the host
  • Required: true
  • Type: String
  • Valid Values: Domain Name / IP

type

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Host type specification
  • Required: true
  • Type: String
  • Valid Values: BAREMETAL,VM,CONTAINER, UNKNOWN

typePriority

  • Available Since: v1.2.0
  • Default Value: null
  • Description: Host type priority list
  • Required: true
  • Type: List<String>
  • Valid Values: List of the following strings: BAREMETAL,VM,CONTAINER

provider

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Selected provider type
  • Required: true
  • Type: String
  • Valid Values: OPENSHIFT,OPENSTACK,DUFFY, BEAKER, AWS, KUBEVIRT, UNKNOWN

providerPriority

  • Available Since: v1.2.0
  • Default Value: null
  • Description: Provider type priority list
  • Required: true
  • Type: List<String>
  • Valid Values: List of the following strings: OPENSHIFT,OPENSTACK,DUFFY, BEAKER, AWS, KUBEVIRT

provisioner

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Selected provisioner type
  • Required: true
  • Type: String
  • Valid Values: LINCHPIN,OPENSHIFT,KUBEVIRT, NOOP

provisionerPriority

  • Available Since: v1.2.0
  • Default Value: null
  • Description: Provisioner type priority list
  • Required: true
  • Type: List<String>
  • Valid Values: List of the following strings: LINCHPIN,OPENSHIFT,KUBEVIRT

bkrHostRequires

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Beaker hostrequires specification. Overrides (config.hostrequires)[https://github.com/RedHat-MultiArch-QE/multiarch-ci-libraries/wiki/Provisioning-Configuration#hostrequires]
  • Required: false
  • Type: List<Map>
  • Valid Values: See Test Template docs for examples.

bkrJobGroup

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Beaker job group. Overrides (config.jobgroup)[https://github.com/RedHat-MultiArch-QE/multiarch-ci-libraries/wiki/Provisioning-Configuration#jobgroup]
  • Required: false
  • Type: String
  • Valid Values: A String matching a beaker group.

bkrKsMeta

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Beaker kickstart file metadata.
  • Required: false
  • Type: String
  • Valid Values: Valid kickstart metadata

bkrMethod

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Beaker installation method.
  • Required: false
  • Type: String
  • Valid Values: nfs, ftp

reserveDuration

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Reservation duration in seconds. Zero implies infinite reservation.
  • Required: false
  • Type: Integer
  • Valid Values: Integer >= 0

scriptParams

  • Available Since: v1.2.1
  • Default Value: null
  • Description: Parameters to pass to the script tests.
  • Required: false
  • Type: String
  • Valid Values: String parameters for a shell script

error

  • Available Since: v0.2
  • Default Value: null
  • Description: Any error that occurred during provisioning
  • Required: false
  • Type: String

displayName

  • Available Since: v1.2.0
  • Default Value: null
  • Description: Name of the host as it will appear in Jenkins
  • Required: Only when runOnSlave is true
  • Type: String

inventoryPath

  • Available Since: v1.2.0
  • Default Value: null
  • Description: Full path to the inventory file
  • Required: true
  • Type: String

initialized

  • Available Since: v0.2
  • Default Value: false
  • Description: Whether provisioning initialization was successful
  • Required: true
  • Type: Boolean

provisioned

  • Available Since: v0.2
  • Default Value: false
  • Description: Whether provisioning was successful
  • Required: true
  • Type: Boolean

connectedToMaster

  • Available Since: v0.2
  • Default Value: false
  • Description: Whether connecting the host to Jenkins via cinch was successful
  • Required: true
  • Type: Boolean

ansibleInstalled

  • Available Since: v0.2
  • Default Value: false
  • Description: Whether installing Ansible on the host was successful
  • Required: true
  • Type: Boolean

credentialsInstalled

  • Available Since: v1.0
  • Default Value: false
  • Description: Whether installing credentials on the host was successful
  • Required: true
  • Type: Boolean

rhpkgInstalled

  • Available Since: v1.0
  • Default Value: false
  • Description: Whether installing rhpkg on the host was successful
  • Required: true
  • Type: Boolean

linchpinTxId

  • Available Since: v1.2.0
  • Default Value: null
  • Description: LinchPin transaction ID
  • Required: Only when provisioning with LinchPin
  • Type: Integer

Deprecated

hostName

  • Deprecated In: v1.2.0
  • Available Since: v1.0
  • Default Value: null
  • Description: Name of the host
  • Required: true
  • Type: String
  • Valid Values: Domain Name / IP

name

  • Deprecated In: v1.2.0
  • Available Since: v0.2
  • Default Value: null
  • Description: Name of the host as it will appear in Jenkins
  • Required: Only when runOnSlave is true
  • Type: String

target

  • Deprecated In: v1.2.0
  • Available Since: v0.2
  • Default Value: null
  • Description: Target of the linchpin PinFile
  • Required: true
  • Type: String

inventory

  • Deprecated In: v1.2.0
  • Available Since: v0.2
  • Default Value: null
  • Description: Full path to the inventory file
  • Required: true
  • Type: String

type

  • Deprecated In: v1.2.1
  • Available Since: v1.2.0
  • Default Value: null
  • Description: Host type specification
  • Required: true
  • Type: String
  • Valid Values: BAREMETAL,VM,CONTAINER

provider

  • Deprecated In: v1.2.1
  • Available Since: v1.2.0
  • Default Value: null
  • Description: Selected provider type
  • Required: true
  • Type: String
  • Valid Values: OPENSHIFT,OPENSTACK,DUFFY, BEAKER, AWS, KUBEVIRT

provisioner

  • Deprecated In: v1.2.1
  • Available Since: v1.2.0
  • Default Value: null
  • Description: Selected provisioner type
  • Required: true
  • Type: String
  • Valid Values: LINCHPIN,OPENSHIFT,KUBEVIRT