.. Document meta

:orphan:

.. |antsibull-internal-nbsp| unicode:: 0xA0
    :trim:

.. meta::
  :antsibull-docs: 2.26.0

.. Anchors

.. _ansible_collections.stephrobert.scaleway.fleet_audit_role:

.. Title

stephrobert.scaleway.fleet_audit role -- Judge a Scaleway fleet against a policy
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This role is part of the `stephrobert.scaleway collection <https://galaxy.ansible.com/ui/repo/published/stephrobert/scaleway/>`_ (version 0.7.0).

    It is not included in ``ansible-core``.
    To check whether it is installed, run :code:`ansible-galaxy collection list`.

    To install it use: :code:`ansible\-galaxy collection install stephrobert.scaleway`.

    To use it in a playbook, specify: :code:`stephrobert.scaleway.fleet_audit`.

.. contents::
   :local:
   :depth: 2

.. _ansible_collections.stephrobert.scaleway.fleet_audit_role__entrypoint-main:

.. Entry point title

Entry point ``main`` -- Judge a Scaleway fleet against a policy
---------------------------------------------------------------

.. version_added


.. Deprecated


Synopsis
^^^^^^^^

.. Description

- Read\-only. It creates nothing, changes nothing and reboots nothing: an audit that corrected things would cross the boundary this collection exists to hold, where Terraform provisions and Ansible operates.
- Every rule names the field it reads, and a rule the evaluation cannot settle is refused rather than reported as compliant. A zone that did not answer is named as unmeasured, never counted as conforming.
- The run fails when a rule of severity :literal:`fail` is broken, so a schedule that never fails visibly is not what you end up with.

.. Requirements


.. Options

Parameters
^^^^^^^^^^

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Parameter
    - Comments

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-main--scaleway_fleet_audit_output"></div>

      .. _ansible_collections.stephrobert.scaleway.fleet_audit_role__parameter-main__scaleway_fleet_audit_output:

      .. rst-class:: ansible-option-title

      **scaleway_fleet_audit_output**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-main--scaleway_fleet_audit_output" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`




      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Which rendering to print. The findings are returned whatever this says.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"text"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"json"`
      - :ansible-option-choices-entry:`"markdown"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-main--scaleway_fleet_audit_policy"></div>

      .. _ansible_collections.stephrobert.scaleway.fleet_audit_role__parameter-main__scaleway_fleet_audit_policy:

      .. rst-class:: ansible-option-title

      **scaleway_fleet_audit_policy**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-main--scaleway_fleet_audit_policy" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`




      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The rules and their severities. The shipped default is a starting point made only of warnings, so a first run never fails; replacing it is the point.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-main--scaleway_fleet_audit_zones"></div>

      .. _ansible_collections.stephrobert.scaleway.fleet_audit_role__parameter-main__scaleway_fleet_audit_zones:

      .. rst-class:: ansible-option-title

      **scaleway_fleet_audit_zones**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-main--scaleway_fleet_audit_zones" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`




      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The zones to read. Defaults to what the contract declares.


      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso





.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/stephrobert/collection-scaleway/issues"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/stephrobert/collection-scaleway"
    external: true


.. Parsing errors