v1.yaml

---
$id: system_profile.spec.yaml
$schema: http://json-schema.org/draft-07/schema#
$defs:
  NestedObject:
    type: object
    description: An arbitrary object that doesn’t allow empty string keys.
    # openapi spec does not support propertyNames, we will use a custom validator
    # to validate x-propertyNames as propertyNames
    x-propertyNames:
      minLength: 1
    additionalProperties:
      oneOf:
        - "$ref": "#/$defs/NestedObject"
        - not:
            type: object
  DiskDevice:
    description: Representation of one mounted device
    type: object
    properties:
      device:
        example: "/dev/fdd0"
        type: string
        maxLength: 2048
      label:
        description: User-defined mount label
        type: string
        maxLength: 1024
      options:
        description: Mount options for nested object
        example:
          uid: "0"
          ro: true
        "$ref": "#/$defs/NestedObject"
      mount_point:
        description: The mount point
        example: "/mnt/remote_nfs_shares"
        type: string
        maxLength: 2048
      type:
        description: The mount type
        example: "ext3"
        type: string
        maxLength: 256
  YumRepo:
    description: Representation of one yum repository
    type: object
    properties:
      id:
        type: string
        maxLength: 256
      name:
        type: string
        maxLength: 1024
      gpgcheck:
        type: boolean
      enabled:
        type: boolean
      base_url:
        type: string
        format: uri
        maxLength: 2048
  DnfModule:
    description: Representation of one DNF module
    type: object
    properties:
      name:
        type: string
        maxLength: 128
      stream:
        type: string
        maxLength: 2048
  InstalledProduct:
    description: Representation of one installed product
    type: object
    properties:
      name:
        type: string
        maxLength: 512
      id:
        description: The product ID
        example: "71"
        type: string
        maxLength: 64
      status:
        description: Subscription status for product
        example: "Subscribed"
        type: string
        maxLength: 256
  NetworkInterface:
    description: Representation of one network interface
    type: object
    properties:
      ipv4_addresses:
        type: array
        items:
          description: The ipv4 address of the system
          example: "123.456.789.012"
          type: string
          format: ipv4
      ipv6_addresses:
        type: array
        items:
          description: The ipv6 address of the system
          example: "0123:4567:89ab:cdef:0123:4567:89ab:cdef"
          type: string
          format: ipv6
      mtu:
        description: MTU (Maximum transmission unit)
        type: integer
      mac_address:
        description: MAC address (with or without colons)
        example: "00:00:00:00:00:00"
        type: string
        maxLength: 59
      name:
        description: Name of interface
        type: string
        example: eth0
        minLength: 1
        maxLength: 50
      state:
        description: Interface state (UP, DOWN, UNKNOWN)
        type: string
        example: "UP"
        maxLength: 25
      type:
        description: Interface type (ether, loopback)
        type: string
        example: "ether"
        maxLength: 18
  SystemProfile:
    description: Representation of the system profile fields
    type: object
    properties:
      owner_id:
        description: A UUID associated with the host's RHSM certificate
        type: string
        pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
        maxLength: 36
        example: 22cd8e39-13bb-4d02-8316-84b850dc5136
      number_of_cpus:
        type: integer
      number_of_sockets:
        type: integer
      cores_per_socket:
        type: integer
      system_memory_bytes:
        type: integer
        format: int64
      infrastructure_type:
        type: string
        maxLength: 100
      infrastructure_vendor:
        type: string
        maxLength: 100
      network_interfaces:
        type: array  # techincally a set, ordering is not important
        items:
          $ref: '#/$defs/NetworkInterface'
      disk_devices:
        type: array  # techincally a set, ordering is not important
        items:
          $ref: '#/$defs/DiskDevice'
      bios_vendor:
        type: string
        maxLength: 100
      bios_version:
        type: string
        maxLength: 100
      bios_release_date:
        type: string
        maxLength: 50
      cpu_flags:
        items:
          type: string
          maxLength: 30
        type: array
      operating_system:
        description: Object for OS details
        type: object
        properties:
          major:
            description: Major release of OS (aka the x version)
            example: 6
            type: integer
            minimum: 0
            maximum: 99
          minor:
            description: Minor release of OS (aka the y version)
            example: 8
            type: integer
            minimum: 0
            maximum: 99
          name:
            description: Name of the distro/os
            example: "RHEL"
            type: string
            maxLength: 4
            enum: [RHEL]
      os_release:
        type: string
        maxLength: 100
      os_kernel_version:
        type: string
        maxLength: 100
      arch:
        type: string
        maxLength: 50
      kernel_modules:
        type: array
        items:
          type: string
          maxLength: 255
      last_boot_time:
        type: string
        format: date-time
        maxLength: 50
      running_processes:
        type: array  # techincally a set, ordering is not important
        items:
          description: A single running process. This will be truncated to 1000 characters when saved.
          type: string
          maxLength: 1000
      subscription_status:
        type: string
        maxLength: 100
      subscription_auto_attach:
        type: string
        maxLength: 100
      katello_agent_running:
        type: boolean
      satellite_managed:
        type: boolean
      cloud_provider:
        type: string
        maxLength: 100
      yum_repos:
        type: array  # technically a set, ordering is not important
        items:
          $ref: '#/$defs/YumRepo'
      dnf_modules:
        type: array # technically a set, ordering is not important
        items:
          $ref: '#/$defs/DnfModule'
      installed_products:
        type: array  # technically a set, ordering is not important
        items:
          $ref: '#/$defs/InstalledProduct'
      insights_client_version:
        type: string
        maxLength: 50
      insights_egg_version:
        type: string
        maxLength: 50
      captured_date:
        type: string
        maxLength: 32
      installed_packages:
        type: array  # technically a set, ordering is not important
        items:
          description: A NEVRA string for a single installed package
          example: "krb5-libs-0:-1.16.1-23.fc29.i686"
          type: string
          maxLength: 512
      installed_services:
        type: array
        items:
          type: string
          maxLength: 512
      enabled_services:
        type: array
        items:
          type: string
          maxLength: 512
      sap_system:
        type: boolean
        description: Indicates if SAP is installed on the system
      sap_sids:
        type: array
        uniqueItems: true
        items:
          description: The SAP system ID (SID)
          type: string
          example: "H2O"
          maxLength: 3
          pattern: '^[A-Z][A-Z0-9]{2}$'
      sap_instance_number:
        type: string
        description: The instance number of the SAP HANA system (a two-digit number between 00 and 97)
        example: '03'
        maxLength: 2
        pattern: '(?!99)(?!98)^[0-9]{2}$'
      sap_version:
        type: string
        description: The version of the SAP HANA lifecycle management program
        example:  '1.00.122.04.1478575636'
        maxLength: 22
        pattern: '^[0-9].[0-9]{2}.[0-9]{3}.[0-9]{2}.[0-9]{10}$'
      tuned_profile:
        type: string
        maxLength: 256
        description: Current profile resulting from command tuned-adm active
        example: 'desktop'
      selinux_current_mode:
        type: string
        enum: [enforcing, permissive, disabled]
        maxLength: 10
        description: The current SELinux mode, either enforcing, permissive, or disabled
        example: 'enforcing'
      selinux_config_file:
        type: string
        enum: [enforcing, permissive, disabled]
        maxLength: 10
        description: The SELinux mode provided in the config file
        example: 'permissive'