Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/darkwizard242/ansible-role-syft

Ansible role for 'syft'. Available on Ansible Galaxy.
https://github.com/darkwizard242/ansible-role-syft

ansible ansible-galaxy ansible-role linux sbom sbom-generator syft

Last synced: 3 months ago
JSON representation

Ansible role for 'syft'. Available on Ansible Galaxy.

Host: GitHub
URL: https://github.com/darkwizard242/ansible-role-syft
Owner: darkwizard242
License: mit
Created: 2021-12-25T18:05:05.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-10-21T21:59:29.000Z (4 months ago)
Last Synced: 2024-10-22T17:51:57.935Z (3 months ago)
Topics: ansible, ansible-galaxy, ansible-role, linux, sbom, sbom-generator, syft
Language: Python
Homepage: https://galaxy.ansible.com/darkwizard242/syft
Size: 115 KB
Stars: 5
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![build-test](https://github.com/darkwizard242/ansible-role-syft/workflows/build-and-test/badge.svg?branch=master)](https://github.com/darkwizard242/ansible-role-syft/actions?query=workflow%3Abuild-and-test) [![release](https://github.com/darkwizard242/ansible-role-syft/workflows/release/badge.svg)](https://github.com/darkwizard242/ansible-role-syft/actions?query=workflow%3Arelease) ![Ansible Role](https://img.shields.io/ansible/role/d/darkwizard242/syft) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ansible-role-syft&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=ansible-role-syft) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=ansible-role-syft&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=ansible-role-syft) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ansible-role-syft&metric=security_rating)](https://sonarcloud.io/dashboard?id=ansible-role-syft) ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/darkwizard242/ansible-role-syft?label=release) ![GitHub repo size](https://img.shields.io/github/repo-size/darkwizard242/ansible-role-syft?color=orange&style=flat-square)

# Ansible Role: syft

Role to install (_by default_) [syft](https://github.com/anchore/syft) on **Debian/Ubuntu** and **EL** systems. A CLI tool and Go library for generating a Software Bill of Materials (SBOM) from container images and filesystems.

## Requirements

None.

## Role Variables

Available variables are listed below (located in `defaults/main.yml`):

### Variables list:

```yaml

syft_app: syft

syft_desired_state: present

syft_version: 1.14.2

syft_os: "{{ ansible_system | lower }}"

syft_architecture_map:

  amd64: amd64

  arm: arm64

  x86_64: amd64

  armv6l: armv6

  armv7l: armv7

  aarch64: arm64

  32-bit: "386"

  64-bit: amd64

# For Debian/Ubuntu Family

syft_debian_url: "https://github.com/anchore/{{ syft_app }}/releases/download/v{{ syft_version }}/{{ syft_app }}_{{ syft_version }}_{{ syft_os }}_{{ syft_architecture_map[ansible_architecture] }}.deb"

# For EL Family

syft_el_url: "https://github.com/anchore/{{ syft_app }}/releases/download/v{{ syft_version }}/{{ syft_app }}_{{ syft_version }}_{{ syft_os }}_{{ syft_architecture_map[ansible_architecture] }}.rpm"

```

### Variables table:

Variable              | Description

--------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------

syft_app              | Defines the app to install i.e. **syft**

syft_desired_state    | Defined to dynamically chose whether to install (i.e. either `present` or `latest`) or uninstall (i.e. `absent`) the package. Defaults to `present`.

syft_version          | Defined to dynamically fetch the desired version to install. Defaults to: **1.14.2**

syft_os               | Defines os type. Used for obtaining the correct type of binaries based on OS type.

syft_architecture_map | Defines os architecture. Used for obtaining the correct type of binaries based on OS System Architecture.

syft_debian_url       | Defines URL to download the 'deb' package from for Debian/Ubuntu family systems.

syft_el_url           | Defines URL to download the 'rpm' package from for EL family systems.

## Dependencies

None

## Example Playbook

For default behaviour of role (i.e. installation of **syft**) in ansible playbooks.

```yaml

- hosts: servers

  roles:

    - darkwizard242.syft

```

For customizing behavior of role (i.e. specifying the desired **syft** version) in ansible playbooks.

```yaml

- hosts: servers

  roles:

    - darkwizard242.syft

  vars:

    syft_version: 0.32.2

```

For customizing behavior of role (i.e. different os architecture of **syft** package like arm64) in ansible playbooks.

```yaml

- hosts: servers

  roles:

    - darkwizard242.syft

  vars:

    syft_arch: "arm64"

```

## License

[MIT](https://github.com/darkwizard242/ansible-role-syft/blob/master/LICENSE)

## Author Information

This role was created by [Ali Muhammad](https://www.alimuhammad.dev)