Checks#
The following is a listing of available checks in geomancy.
Core#
Core checks are always available and do not have additional requirements.
- Checks and Groups
Check base class and check groups that contain one or more child checks.
- checkEnv
Check the existence and, optionally, the value of an environment variable.
- checkExec
Check the existence and, optionally, the version of available executables or commands.
- checkPath
Check the existence and, optionally, the type of path.
- checkPlatform
Check the current platform (operating system) and, optionally, its minimum version.
- checkPythonPkg
Checks whether the python package is installed and, optionally, check its version.
Changed in version 0.9.3: Environment variables are now referenced by the name preceded by a $ and
optional braces. e.g. $USER or ${USER}
AWS#
Checks for Amazon Web Service (AWS) resources:
- checkIam
Check AWS credentials, Identity and Access Management (IAM) and security best practices.
Checks include:
Authentication with the default profile or a specified profile
Access keys need to be rotated (age >90 days)
Root keys and signing certificates have not been created.
- checkS3
Check AWS S3 buckets and security settings.
Existence and accessibility
Public access is disabled
- checkSsmParameter
Check AWS Systems Manager (SSM) and related SSM security settings.
Parameter existence and type
Warning
Amazon Web Service (AWS) checks require the installation of aws dependencies.
# Install the 'aws' dependency
$ python -m pip install geomancy[aws]
# Install 'all' dependencies
$ python -m pip install geomancy[all]