Skip to content

Commit 55ecd65

Browse files
committed
Add env variables to generic driver
Signed-off-by: David Gageot <david@gageot.net>
1 parent 7d6bfff commit 55ecd65

File tree

2 files changed

+25
-20
lines changed

2 files changed

+25
-20
lines changed

docs/drivers/generic.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ parent="smn_machine_drivers"
99
<![end-metadata]-->
1010

1111
# Generic
12+
1213
Create machines using an existing VM/Host with SSH.
1314

1415
This is useful if you are using a provider that Machine does not support
@@ -17,18 +18,18 @@ Machine to manage.
1718

1819
Options:
1920

20-
- `--generic-ip-address`: **required** IP Address of host.
21-
- `--generic-ssh-user`: SSH username used to connect.
22-
- `--generic-ssh-key`: Path to the SSH user private key.
23-
- `--generic-ssh-port`: Port to use for SSH.
21+
- `--generic-ip-address`: **required** IP Address of host.
22+
- `--generic-ssh-key`: **required** Path to the SSH user private key.
23+
- `--generic-ssh-user`: SSH username used to connect.
24+
- `--generic-ssh-port`: Port to use for SSH.
2425

2526
> **Note**: You must use a base operating system supported by Machine.
2627
2728
Environment variables and default values:
2829

2930
| CLI option | Environment variable | Default |
30-
|----------------------------|----------------------|---------------------|
31-
| **`--generic-ip-address`** | - | - |
32-
| `--generic-ssh-user` | - | `root` |
33-
| `--generic-ssh-key` | - | `$HOME/.ssh/id_rsa` |
34-
| `--generic-ssh-port` | - | `22` |
31+
| -------------------------- | -------------------- | ------------------- |
32+
| **`--generic-ip-address`** | `GENERIC_IP_ADDRESS` | - |
33+
| **`--generic-ssh-key`** | `GENERIC_SSH_KEY` | `$HOME/.ssh/id_rsa` |
34+
| `--generic-ssh-user` | `GENERIC_SSH_USER` | `root` |
35+
| `--generic-ssh-port` | `GENERIC_SSH_PORT` | `22` |

drivers/generic/generic.go

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,27 @@ var (
3434
func (d *Driver) GetCreateFlags() []mcnflag.Flag {
3535
return []mcnflag.Flag{
3636
mcnflag.StringFlag{
37-
Name: "generic-ip-address",
38-
Usage: "IP Address of machine",
37+
Name: "generic-ip-address",
38+
Usage: "IP Address of machine",
39+
EnvVar: "GENERIC_IP_ADDRESS",
3940
},
4041
mcnflag.StringFlag{
41-
Name: "generic-ssh-user",
42-
Usage: "SSH user",
43-
Value: drivers.DefaultSSHUser,
42+
Name: "generic-ssh-user",
43+
Usage: "SSH user",
44+
Value: drivers.DefaultSSHUser,
45+
EnvVar: "GENERIC_SSH_USER",
4446
},
4547
mcnflag.StringFlag{
46-
Name: "generic-ssh-key",
47-
Usage: "SSH private key path",
48-
Value: defaultSourceSSHKey,
48+
Name: "generic-ssh-key",
49+
Usage: "SSH private key path",
50+
Value: defaultSourceSSHKey,
51+
EnvVar: "GENERIC_SSH_KEY",
4952
},
5053
mcnflag.IntFlag{
51-
Name: "generic-ssh-port",
52-
Usage: "SSH port",
53-
Value: drivers.DefaultSSHPort,
54+
Name: "generic-ssh-port",
55+
Usage: "SSH port",
56+
Value: drivers.DefaultSSHPort,
57+
EnvVar: "GENERIC_SSH_PORT",
5458
},
5559
}
5660
}

0 commit comments

Comments
 (0)