cdillc.splunk.ksconf_app_manifest (0.26.1) — module

Install collection

Install with ansible-galaxy collection install cdillc.splunk:==0.26.1

Add to requirements.yml

  collections:
    - name: cdillc.splunk
      version: 0.26.1

Description

This is used internally by the M(cdillc.splunk.ksconf_app_sideload). This is not currently intended to be used directly by users.

Requirements

• ksconf>=0.11

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Don't do this.  This module is not public
  cdillc.splunk.ksconf_app_manifest:
    app_dir: /opt/splunk/etc/apps/myapp
    state_file: /opt/splunk/etc/apps/myapp/.ksconf_sideload.json

Inputs

    
app_dir:
    description: Path to Splunk application
    required: true
    type: path

state_file:
    description: Location of the state file
    required: false
    type: path

rebuild_manifest:
    default: false
    description: Rebuild the manifest information when missing from or corrupted with
      the state file.
    type: bool

discard_local_app_autogen:
    default: true
    description:
    - Discard the auto generated C(local/app.conf) file created by the deployment server.
    - This requires ksconf v0.13.5, or this feature will be ignored.
    type: bool

Outputs

app_dir:
  description: Expanded application directory
  returned: always
  sample: /opt/splunk/etc/app/fire_brigade
  type: str
manifest:
  description: 'Manifest objects. See L(AppManifest,https://ksconf.readthedocs.io/en/latest/api/ksconf.app.html#ksconf.app.manifest.AppManifest)

    '
  returned: when manifest is present or built
  type: dict
result:
  description:
  - 'Final status of the state file.  Values include:

    '
  - C(loaded) when state & manifest successfully loaded from I(state_file),
  - C(created) when state file was created from scratch,
  - C(rebuilt) when existing state file was updated with new manifest, or
  - C(no-manifest) when the manifest could not be loaded and I(rebuild_manifest) is
    false.
  - 'Any of the follows indicate a failure:

    '
  - C(no-app) when the I(app_dir) is missing,
  - C(error) when an unexpected error occurred.
  returned: always
  type: str
state:
  description: State of the state file / manifest
  returned: on success
  type: dict
state_file:
  description: Relative path to the json state tracking file where installation state,
    source hash, and application manifest is stored.
  returned: always
  sample: /opt/splunk/etc/app/fire_brigade/.ksconf_sideload.json
  type: str
state_init:
  description:
  - Health indicator of first attempt at reading from I(present).
  - 'Expect values such as:

    '
  - C(present) - state present and includes manifest,
  - C(old-version) - state present with no manifest,
  - C(corrupted) - unable to decode json,
  - C(missing) - no state file present, or
  - C(error) unexpected error attempting to load I(state_file).
  returned: always
  type: str