steampunk.unit.app_info (0.7.1) — module

Install collection

Install with ansible-galaxy collection install steampunk.unit:==0.7.1

Add to requirements.yml

  collections:
    - name: steampunk.unit
      version: 0.7.1

Description

Retrieve NGINX Unit application configuration.

Upstream docs are at U(https://unit.nginx.org/configuration/#python).

Usage examples

Scanned by Steampunk Spotter

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

- name: Retrieve information about all applications
  steampunk.unit.app_info:

Scanned by Steampunk Spotter

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

- name: Retrieve information about a specific application
  steampunk.unit.app_info:
    name: sample_app

Inputs

    
name:
    description:
    - Name of the application to retrieve. If parameter is not specified, retrieve information
      about all applications.
    type: str

provider:
    description:
    - Connection parameters.
    suboptions:
      ca_path:
        description:
        - Path to the CA bundle that should be used to validate the backend certificate.
        - If this parameter is not set, module will use the CA bundle that python is using.
        - Can also be set using the  I(UNIT_CA_PATH) environment variable.
        type: path
      endpoint:
        description:
        - HTTP or UNIX uri that should be used to communicate with the Unit.
        - The uri B(MUST) be prefixed by either C(http://), C(https://), or C(unix://).
        - By default, modules will try to connect to I(unix:///var/run/unit/control.sock),
          and if this socket does not exist, fallback to I(unix:///var/run/control.unit.sock).
        - Can also be set using the I(UNIT_ENDPOINT) environment variable.
        type: str
      password:
        description:
        - Password that is used when the I(endpoint) is protected using the basic authentication.
        - This parameter is ignored when the I(enpoint) parameter points to an unix socket.
        - Value is masked in the logs.
        - Can also be set using the I(UNIT_ENDPOINT) environment variable.
        type: str
      username:
        description:
        - Username that is used when the I(enpoint) is protected using the basic authentication.
        - This parameter is ignored when the I(enpoint) parameter points to an unix socket.
        - Can also be set using the I(UNIT_ENDPOINT) environment variable.
        type: str
      verify:
        default: true
        description:
        - Flag that controls the certificate validation.
        - If you are using self-signed certificates, you can set this parameter to C(false).
        - ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates
          in production, see the I(auth.ca_path) parameter.
        - Can also be set using the  I(UNIT_VERIFY) environment variable.
        type: bool
    type: dict

Outputs

object:
  contains:
    environment:
      description: Environment variables to be passed to the application.
      returned: if set
      type: dict
    group:
      description: Group name that runs the app process.
      returned: if set
      type: str
    home:
      description: Virtual environment in use.
      returned: if set and I(type) is C(python)
      type: str
    limits:
      contains:
        requests:
          description: Maximum number of requests Unit allows an app to serve.
          type: int
        timeout:
          description: Request timeout in seconds.
          type: int
      description: Set the application's lifecycle parameters.
      returned: if set
      type: dict
    module:
      description: WSGI module to run.
      returned: if I(type) is C(python)
      type: str
    name:
      description: Application name.
      returned: always
      type: str
    no_processes:
      description: Number of processes that should be running at one time.
      returned: if set
      type: int
    path:
      description: Additional lookup path for Python modules.
      returned: if set and I(type) is C(python)
      type: str
    processes:
      contains:
        idle_timeout:
          description: Time in seconds before terminating an idle process.
          type: int
        max:
          description: Maximum number of application processes.
          type: int
        spare:
          description: Minimum number of idle processes.
          type: int
      description: Dynamic process limits.
      returned: if set
      type: dict
    user:
      description: Username that runs the app process.
      returned: if set
      type: str
    working_directory:
      description: The app's working directory.
      returned: if set
      type: str
  description: Object representing NGINX Unit application.
  returned: On success and if I(state) == C(present)
  type: dict