osrelease

Documentation

Overview

Package osrelease provides an "os-release" distribution scanner.

Index

• Constants
• func Parse(ctx context.Context, r io.Reader) (map[string]string, error)
• type Scanner
  • func (*Scanner) Kind() string
  • func (*Scanner) Name() string
  • func (s *Scanner) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Distribution, error)
  • func (*Scanner) Version() string

Constants

const (
	Path         = `etc/os-release`
	FallbackPath = `usr/lib/os-release`
)

Path and FallbackPath are the two documented locations for the os-release file. The latter should be consulted only if the former does not exist.

Functions

func Parse

func Parse(ctx context.Context, r io.Reader) (map[string]string, error)

Parse splits the contents r into key-value pairs as described in os-release(5).

See comments in the source for edge cases.

Types

type Scanner

type Scanner struct{}

Scanner implements a scanner.DistributionScanner that examines os-release files, as documented at https://www.freedesktop.org/software/systemd/man/os-release.html

func (*Scanner) Kind

func (*Scanner) Kind() string

Kind implements scanner.VersionedScanner.

func (*Scanner) Name

func (*Scanner) Name() string

Name implements scanner.VersionedScanner.

func (*Scanner) Scan

func (s *Scanner) Scan(ctx context.Context, l *claircore.Layer) ([]*claircore.Distribution, error)

Scan reports any found os-release Distribution information in the provided layer.

It's an expected outcome to return (nil, nil) when the os-release file is not present in the layer.

func (*Scanner) Version

func (*Scanner) Version() string

Version implements scanner.VersionedScanner.