Feature Request: extending trellis check command

Open
#376 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
ansible, go
Domain
cli, devops

Research direction

Start at the trellis check command and its existing Python, Vagrant, and VirtualBox checks. Review how dependency checks are represented before scoping Ansible compatibility and SSH-agent and key checks, including the possible conflict with a virtual environment. Done means the command reports the required and optional checks in the proposed format.

Written by the indexing model from the issue text.

Description

enhancement
Terms
Summary

Extend the dependency checks the trellis check command carries out to include required provisioning/deployment checks like SSH agent, keys, Ansible.

Motivation
Why are we doing this?

Right now, trellis check looks for Python, Vagrant and Virtualbox compatibility related to local development, but some important checks would be:

  • system Ansible version and its compatibility
  • SSH agent being enabled
  • SSH agent keys being loaded
What use cases does it support?

Would be nice to support checks of any known dependencies of the deploy/provision processes.

What is the expected outcome?

An output like:

Checking Trellis requirements...

Required:
[✓] Ansible [>= 2.9.7]: 2.10.0
[✓] Python [>= 3.8.0]: 3.11.2
[✓] SSH Agent [On]: Yes
[✓] SSH Agent [Loaded]: Yes

Optional:

[✓] Vagrant [>= 2.1.0]: 2.3.4
[✓] VirtualBox [>= 4.3.10]: 6.1.36r152435
...
Potential conflicts / foreseeable issues

May conflict with Ansible version in virtual environment

Additional Context

No response

Dominant language
Go
Stars
169
Forks
31
Avg merge
1h 2m
Merged PRs (30d)
17

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from roots/trellis-cli

All issues in roots/trellis-cli

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.