Skip to content

Update readme and example file #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pythoninja merged 1 commit into from
Oct 14, 2023
Merged

Update readme and example file #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 25 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Current version: v0.2.0
1. Generates a `config` file to merge with your existing SSH configuration.
2. Custom configuration for ssh-agent.
3. Custom SSH aliases for quick connections.
4. Skip selected hosts from results file.

## Installation

Expand Down Expand Up @@ -68,18 +69,32 @@ group1: # host_group
_auth_type: IdentityAgent
_auth_path: ~/.1password/agent.sock
_aliases: [ "base", "another-alias" ]
_skip: false

host2:
ansible_host: 127.0.0.2
ansible_user: manager
ansible_password:
ansible_port: 19020
_meta:
_skip: true

group2:
hosts:
another_host1:
host3:
ansible_host: 172.19.0.1
ansible_user: postgres
ansible_password:
ansible_port: 19222

host4:
ansible_host: 172.99.99.99
ansible_user: postgres
_meta:
_auth_type: IdentityAgent
_auth_path: ~/.1password/agent.sock
_aliases: [ "base", "another-alias" ]
_skip: false
```

To use `sshgen`, you can either invoke it as a Python module using `python -m sshgen --help` or directly use the
Expand All @@ -104,19 +119,21 @@ Check the file contents `cat /my_dir/config`:
Host host1 base another-alias # group1
HostName 127.0.0.1
User root
Port 22
IdentityAgent ~/.1password/agent.sock

Host host2 # group1
HostName 127.0.0.2
User manager
IdentityFile ~/.ssh/ssh_key
IdentitiesOnly yes

Host another_host1 # group2
Host host3 # group2
HostName 172.19.0.1
User postgres
Port 19222
IdentityFile ~/.ssh/ssh_key
IdentitiesOnly yes

Host host4 postgres-server # group2
HostName 172.99.99.99
User postgres
Port 22
IdentityAgent ~/.1password/agent.sock
```

Copy and insert the output into your `~/.ssh/config` file. After that, you can use any of the defined aliases to SSH
Expand Down
4 changes: 2 additions & 2 deletions examples/hosts.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ group1: # host_group
_auth_type: IdentityAgent
_auth_path: ~/.1password/agent.sock
_aliases: [ "base", "another-alias" ]
_skip: true
_skip: false

host2:
ansible_host: 127.0.0.2
Expand All @@ -31,5 +31,5 @@ group2:
_meta:
_auth_type: IdentityAgent
_auth_path: ~/.1password/agent.sock
_aliases: [ "base", "another-alias" ]
_aliases: [ "postgres-server" ]
_skip: false