example_config.yaml

---
# General settings. They cover main infrastructure that camayoc interacts
# with and camayoc itself.

# Camayoc test framework settings
camayoc: {}

# Quipucords / Discovery server
# Settings below allow you to connect to quipucords development server
# running locally.
# If you run Discovery server locally in container, set the port to 443
# and https to true. Keep ssl-verify as false, unless you've set up the
# certificates.
quipucords_server:
    hostname: '127.0.0.1'
    https: false
    port: 8000
    ssl-verify: false
    # credentials for logging into the server
    username: 'admin'
    password: 'CHANGEME'
    ssh_keyfile_path: '/home/user/.local/share/quipucords/sshkeyfiles/'

# Quipucords / Discovery CLI
quipucords_cli:
    executable: qpc

# We host most of our test machines on a VCenter instance
# and this section contains its URL and the credentials
# needed to log in to it
vcenter:
    hostname: OURTEAMVCENTER.com
    password: "CHANGETHISPASSWORD"
    username: CHANGETHISUSERNAME


# Data-related settings. They cover various entities that camayoc might
# create in Quipucords during test execution. Storing them here allows
# us to simplify scan / report tests, or express requests like "give me
# random working network-type source".

credentials:
    - name: root
      type: 'network'
      # NOTE: When running quipucords in a container, this path
      # must be the path that exists in the container.
      sshkeyfile: ~/.ssh/id_rsa
      username: root
    - name: root2
      type: 'network'
      username: root
      password: "mysecretpassword"
    - name: 'vcenter'
      type: 'vcenter'
      password: 'example1'
      username: 'username1'
    - name: 'sat6'
      type: 'satellite'
      password: 'CHANGEME'
      username: 'CHANGEUSERNAME'
    - name: 'OpenShift'
      type: 'openshift'
      auth_token: 'sha256~XYZabc...'
    - name: 'rhacs'
      type: 'rhacs'
      auth_token: 'these_tend_to_be_very_long'

# Values in "credentials" field can use names present in "credentials" section
# above
sources:
    - hosts:
          - 'myfavnetwork.com'
      credentials:
          - root
      name: 'myfav'
      type: 'network'
    - hosts:
          - 'my_vcenter.com'
      credentials:
          - 'vcenter'
      name: 'vcenter'
      type: 'vcenter'
      options:
          ssl_cert_verify: false
    - hosts:
          - 'sat6.com'
      credentials:
          - 'sat6'
      name: 'sat6'
      type: 'satellite'
      options:
          ssl_cert_verify: false
    - hosts:
          - 'api.example.com'
      credentials:
          - 'OpenShift'
      name: 'OpenShift'
      type: 'openshift'
      options:
          ssl_cert_verify: false
    - hosts:
          - 'acs-endpoint.acs.mycluster.com'
      credentials:
          - 'rhacs'
      name: 'RHACS'
      type: 'rhacs'
      options:
          ssl_cert_verify: false

# Values in "sources" field can use names present in "sources" section above
scans:
    - name: ExampleSat6
      sources:
          # these refer to the hostnames in the inventory section
          - 'sat6'
    - name: ExampleWithProducts
      sources:
          - 'myfav'
          - 'vcenter'
      expected_data:
          jbossamq-rhel-5-vc:
              distribution:
                  # Name of OS should be substring of name found
                  # with quipucords
                  name: 'Red Hat Enterprise Linux'
                  # version should be substring of version found
                  # in /etc/redhat-release
                  version: '5.9'
                  release: ''
                  is_redhat: true
          jbossamq-rhel-6-vc:
              distribution:
                  name: 'Red Hat Enterprise Linux'
                  version: '6.9'
                  release: ''
                  is_redhat: true
    - name: OpenShift
      sources:
          - 'OpenShift'
      expected_data:
          OpenShift:
              cluster_id: '00000000-1111-2222-3333-123456789abc'
              version: '4.11.32'
              nodes:
                  - 'master-0.example.com'
                  - 'master-1.example.com'
                  - 'master-2.example.com'
                  - 'worker-0.example.com'
                  - 'worker-1.example.com'
                  - 'worker-2.example.com'
                  - 'worker-3.example.com'
              operators:
                  - 'abc-operator'
                  - 'xyz-operator'